Skip to content

Commit

Permalink
Updated README.md and .gitignore.
Browse files Browse the repository at this point in the history
  • Loading branch information
Das15 committed Mar 13, 2023
1 parent 40a717c commit c25c7b1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@
/temp/
/cache/
/build/
/.idea/
/.idea/
/avatars/
/config.cfg
/logs.log
/usernames.csv
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# osuAvatarImport
Very simple tool to import avatars for use in tournaments.

## How does it work?
The script gets user list from usernames.csv file, then if usernames are provided it requests user ids from bancho (for which you **NEED** api key, which you can get [here](https://osu.ppy.sh/p/api/)), you will get asked for one on first run. After this it will download avatars to /avatars folder.
### Avatar file naming scheme.
Every character is lowercase with special ones changed to underscore (_).
## Help. The program doesn't work!
Well, make sure you have correct api key added in config.cfg. Afterwards you can check if the user even has avatar (default one isn't downloaded for now, I'm fairly certain restricted users' aren't available too). If this doesn't work, create issue on github explaining the issue **WITH** *logs.log* file included.
## How to run it from source code
- Get python (preferably version 3.10).
- Copy the repository.
- (Optional) Create virtual environment (venv).
- Get all dependencies using `pip install -r requirements.txt`
- Run the main.py with python.

0 comments on commit c25c7b1

Please sign in to comment.