Unbewohnte
/
OBM
1
1
Fork 0
Code Issues Pull Requests Projects Releases 14 Wiki Activity
⬗ (Osu! Background Manager) A little utility to replace, retrieve or remove backgrounds for every beatmap in your osu! folder ⬖
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
47 Commits
1 Branch
16 Tags
276 KiB
 
 
Tree: f9eca425b6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f9eca425b6'
${ noResults }
Unbewohnte f9eca425b6
Typo 		4 years ago
logger Added custom logger and made code a bit less messy 4 years ago
manager Removement, flags, settings etc... 4 years ago
settings Added forgotten default field 4 years ago
util Removement, flags, settings etc... 4 years ago
LICENSE Update LICENSE 4 years ago
OBM.go Removement, flags, settings etc... 4 years ago
README.md Typo 4 years ago
flags.go Removement, flags, settings etc... 4 years ago
go.mod Added custom logger and made code a bit less messy 4 years ago
worker.go Removement, flags, settings etc... 4 years ago

README.md

OBM (Osu!-Background-Manager)

This utility will help you with replacement, retrievement and removement of Osu!`s beatmaps` backgrounds

Use at your own risk ! There is no way to return removed original backgrounds unless you delete all beatmaps and reimport newly downloaded versions of them again.

Installation

From source (You`ll need Go installed)

  1. git clone https://github.com/Unbewohnte/OBM.git or download and unzip the archive
  2. cd into the directory
  3. go build

From release

  1. go to the releases page
  2. choose your OS and download the archive
  3. cd to the location of the downloaded version
  4. unzip (7z x **archive_name**) - for 7z archives

Usage

To run - ./OBM in terminal (on Unix) || OBM in command line (on Windows) (a simple double-click on exe will certainly work as well)

First run

  1. The program will generate a settings.json file if it is not already in the directory when you run it
  2. Paste your Osu! filepath in the "pathToOsu" field
  3. Enable/Disable needed features, providing valid filepaths to them
  4. Additionally you can disable the "createBlackBackgoundImage" by replacing true with false or change the number of workers

After

  1. Start the utility again. If it has found the settings file - it will perform the magic according to provided rules

Flags (starting from version 1.3.4)

Right now there are 2 arguments that you can specify before running the program - "beatmap" and "showOrder". "-beatmap" flag takes a string; it will tell the program to do its work ONLY on beatmaps with specified name; others will be ignored. The names of beatmaps in Osu! consist an id, artist and the name of the soundtrack, so you can specify any name in the flag that will contain one of those parts.

"-showOrder" flag takes a boolean; if set to true - it will print an order in which the workers perform operations over each beatmap. Right now it`s just a helper flag.

Examples

  1. ./OBM -beatmap="" - the same as just ./OBM. It will affect all of your beatmaps
  2. ./OBM -beatmap="Demetori" - this will search for beatmaps with names that contain "Demetori" and will work only with them
  3. ./OBM -beatmap=Demetori - the same as before, but without "" (look at 4 - 5 for nuances)
  4. ./OBM -beatmap=raise my sword - NOTE that this will make the program look only for word "raise", but not for the whole sequence
  5. ./OBM -beatmap="raise my sword" - this is the valid option for 4 (You need to use "" in case of a multi-word name)

The search is case-insensitive, so for example ./OBM -beatmap="Road of Resistance" and ./OBM -beatmap="ROAD of rEsIsTaNcE" will get you the same results

  1. ./OBM -showOrder=true - will print the order and exit
  2. ./OBM -showOrder=true -beatmap="something here" - will print the order and exit, just like in the previous one

License

MIT License

If you have found this program useful, then consider to give this repository a ☆. It is not difficult for you, but means a lot for me