From 56d43635d0104eed3cce82f2129f1fad594e6ae2 Mon Sep 17 00:00:00 2001 From: Nikos Date: Thu, 7 Dec 2023 22:58:20 +0200 Subject: [PATCH] update --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 44329e9..107e509 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,39 @@ # OsuCollectionDownloader -OsuCollectionDownloader is a simple command-line application for downloading collections from [osu!collector](https://osucollector.com/) and optionally, using those collections to generate .osdb files which can be used by [Piotrekol's Collection Manager](https://github.com/Piotrekol/CollectionManager) for collection importing and sharing. +A command-line application for downloading collections from [osu!collector](https://osucollector.com/) and optionally, using those collections to generate .osdb files which can be used by [Piotrekol's Collection Manager](https://github.com/Piotrekol/CollectionManager) for importing collections in osu! or just sharing them. I strongly advise not use this application irresponsibly and instead support [osu!collector](https://osucollector.com/client). ## Usage -Get the builds from [here](https://github.com/waylaa/OsuCollectionDownloader/actions) and click on the latest workflow run. +Get the latest build from the [Releases](https://github.com/waylaa/OsuCollectionDownloader/releases) page. -### Windows 10/11 +### Windows #### Download a Collection ``` -.\OsuCollectionDownloader.exe --id= --osu-songs-directory= +.\OsuCollectionDownloader.exe --id= --extraction-directory= ``` #### Download a Collection and Generate .osdb File ``` -.\OsuCollectionDownloader.exe --id= --osu-songs-directory= --osdb-file-directory= +.\OsuCollectionDownloader.exe --id= --extraction-directory= --osdb-generation-directory= ``` ### MacOS/Linux #### Download a Collection ``` -.\OsuCollectionDownloader --id= --osu-songs-directory= +.\OsuCollectionDownloader --id= --extraction-directory= ``` #### Download a Collection and Generate .osdb File ``` -.\OsuCollectionDownloader --id= --osu-songs-directory= --osdb-file-directory= +.\OsuCollectionDownloader --id= --extraction-directory= --osdb-generation-directory= ``` +An additional option for downloading sequentially exists and can be enabled by writing ```--download-sequentially``` alongside the other said options. Only enable this option if you're getting rate-limited by the beatmap mirrors, having a really slow internet connection speed to the point of causing timeouts or experiencing issues with the concurrent downloader. + ## Building/Contributing -### 1. Prerequisites +### 1. Prerequisites (Visual Studio Installer) - .NET desktop development - Desktop development with C++ (Used for AOT publishing)