Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roogue/osu-collector-dl

Automatic Downloader for Osu!Collector
https://github.com/roogue/osu-collector-dl

osu osu-api osugame

Last synced: about 2 months ago
JSON representation

Automatic Downloader for Osu!Collector

Awesome Lists containing this project

README 

        
# osu-collector-dl



A program that automates the scraping, download, and beatmap collection generation for Osu!Collector.



## Installation



1. Download the latest release from the [releases](https://github.com/roogue/osu-collector-dl/releases) page.

2. Extract the compressed file



## Usage



1. Run the `osu-collector-dl.exe` file from the downloaded folder.

2. Enter the ID of the collection you want to download. To find the ID, look at the end of the Osu!Collector collection URL. For example, if the URL is https://osucollector.com/collections/44/speed-practice, you would enter 44 as the ID.

3. Select a working mode.

4. Wait until the program finishes its task.



## Configuration



You can customize various settings for the program by editing the `config.json` file. To do this, follow the instructions below:



1. Right-click on the `config.json` file 

2. Select "Open with" from the context menu. 

3. Choose a text editor (such as Notepad) to open the file and make desired changes.



Below is the data stored in the config.json.



```json

{

  "parallel": true,

  "concurrency": 5,

  "intervalCap": 50,

  "interval": 60,

  "logSize": 15,

  "directory": "",

  "mode": 1

}

```

### Explaination

> **parallel**

> - `true` Download multiple beatmap sets at the same time.

> - `false` Download only one beatmap set at a time.



> **concurrency** (DO NOT CHANGE IF YOU ARE NOT SURE OF WHAT YOU ARE DOING)

> - The number of downloads to request at a time.

> - It is recommended to set this to a low number (such  as 5) to prevent abuse of the osu!mirror API and getting potential IP bans or rate limits.



> **intervalCap** (DO NOT CHANGE IF YOU ARE NOT SURE OF WHAT YOU ARE DOING)

> - The maximum number of downloads to request in an interval.

> - It is recommended to set this to a low number (such  as 50) to prevent abuse of the osu!mirror API and getting potential IP bans or rate limits.



> **interval** (DO NOT CHANGE IF YOU ARE NOT SURE OF WHAT YOU ARE DOING)

> - The countdown in seconds before the number of download requests reset.

> - It is recommended to set this to a high number (such  as 60) to prevent abuse of the osu!mirror API and getting potential IP bans or rate limits.



> **logSize**

> - The maximum number of log messages during the download process.



> **directory**

> - The path to the folder where you want to save the downloaded beatmaps. 

> - If no value is provided, the current working directory will be used. 

> - The double quotes around the path is necessary.



> **mode**

> - `1`: Download Beatmap Set only.

> - `2`: Download Beatmap Set + Generate .osdb

> - `3`: Generate .osdb only.



## FAQ



### It says "Retrying" during the download process, am I doing anything wrong?



> It is normal for API requests to sometimes fail due to factors such as rate limiting and internet connection issues. The script has a built-in retrying process that will handle these issues automatically. It is expected to see the "Retrying" message during the download process.



### I want the beatmaps to be automatically added to my collections. Is that possible?



> Unfortunately, this feature will not be implemented as directly modifying your personal osu! folder is risky and could potentially result in corrupted files. It is recommended to use [Collection Manager](https://github.com/Piotrekol/CollectionManager) (CM) by Piotrekol to modify your collection for more stable functionality.



### Why won't my program even start? The program shuts off right after I opened it.



> There could be several reasons why your program is not starting. One potential cause is that you have incorrectly edited the config file, such as forgetting to include double quotes around the directory path. If you are not sure what the problem is, try reinstalling the program.



### The program freezes in the middle of the process without displaying any error messages. What can I do?



> It can be due to the program is waiting for the next burst of download requests to prevent unwanted rate limits or IP bans. You can also try pressing Enter on your keyboard to see if that prompts the program to continue. This can sometimes happen if you accidentally clicked on the terminal window, which can cause the program to pause.



### I accidentally downloaded the wrong collection. How can I stop the downloads?



> To stop the downloads, you can simply close the terminal window. This will terminate the program. Alternatively, you can try pressing CTRL+C on your keyboard, which will send a signal to the program to stop running.



### I have tried following the FAQ above, but it didn't solve my problem. The problem I am experiencing is not listed in the FAQ.



> If you are experiencing a problem that is not covered in the FAQ and you need assistance, it is welcome to open an issue on the [Issue Page](https://github.com/roogue/osu-collector-dl/issues) or [Bug Report Form](https://forms.gle/KoHtcmsj94ahKFJy6). After navigating to the issue page, click the green "New issue" button on the page and follow the instructions to describe your problem in as much detail as possible. This will allow the maintainers of the project to better understand and help troubleshoot the issue you are experiencing.



## Feedback

It would be nice to hear feedback from you! [Feedback Form](https://forms.gle/bCZ25JVdQSKvgbWD9)



## License



This project is licensed under the MIT License. See the [LICENSE](https://choosealicense.com/licenses/mit/) file for details.