-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
11 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,8 @@ | |
/temp/ | ||
/cache/ | ||
/build/ | ||
/.idea/ | ||
/.idea/ | ||
/avatars/ | ||
/config.cfg | ||
/logs.log | ||
/usernames.csv |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |