From 012165cdfc5197c252072870cb3abb722b058ff7 Mon Sep 17 00:00:00 2001 From: Thayol Date: Sat, 26 Dec 2020 13:04:05 +0100 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 32f7289..ce7b5c2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ -# OsuOptimizerPHP -Swiss Army Knife style osu! library manager \ No newline at end of file +# osu! optimizer (PHP) + +Samsz has seen most of my work and it was his idea to combine them together before I start writing another one from scratch. + +> "Swiss Army Knife style osu! library manager" -- Samsz + +## What's this? + +This is my attempt at making a somewhat functional multitool for your library. I've had many separate smaller projects in various languages, but I decided to stick with PHP. + +There is no real programming style or pattern set for this project, so it's kind of undocumented and hard to read. + +Pull requests are welcome! I doubt this project would get any traffic, so feel free to message me directly about basically anything. + +## Features + + - [x] Replace all backgrounds with 1x1 black images + - [x] Remove storyboard specific files + - [x] Remove background videos + - [x] Remove junk files (skins, hitsounds, leftovers from mapping etc.) + - [ ] Export maps to .osz + - [ ] Delete maps based on star difficulty + - [ ] Blacklist: the maps that should not be touched by this program + +## Warning! + +You should always back up your osu! folder before using programs of these kinds. I will include a somewhat legal disclaimer just in case. + +**Disclaimer**: This code is provided "**AS IS**," I and the other contributors take no responsibility for any harm you may cause to yourself or your computer and its data. + +*You have been warned!* + + +## Usage + +To be written.