OSHU-LIBRARY(1)

📦 version 2.0.3, in nixpkgs unstable

💖 OSHU-LIBRARY 💖

okay so bestie, welcome to the oshu-library manual page (that's the OSHU-LIBRARY(1) user manual, in case you were wondering) — and ngl, this little tool is lowkey a whole vibe. It manages a beatmap collection for oshu! 🎀

✨ SYNOPSIS ✨

oshu-library build-index [-v]
oshu-library help

like, that's it. two commands. main character energy fr fr. 👑

🌸 DESCRIPTION 🌸

oshu-library is the tool for importing, deleting, and indexing a collection of osu! beatmaps. It's currently at an early stage and only supports indexing — so like, it's giving "baby tool with big dreams," and we're obsessed. 🦋

The library has a notion of a home directory, which is the parent directory of all of oshu!'s resources. Its usual path is ~/.oshu, but you can override it with the OSHU_HOME environment variable (yes, literally just set that and go off 💅). Its structure is shown below:

~/.oshu/
    beatmaps/
        12345 Someone - Something/
            Someone - Something (Someone else) [Difficulty].osu
    web/
        index.html

look at that little tree go 🌈 — beatmaps/ holds your maps, web/ holds the generated index. iconic.

⭐ INDEX ⭐

To make browsing beatmaps and spawning oshu! easier, you can generate an HTML index of your beatmap collection. Simply run oshu-library build-index and it will scan the beatmaps directory in your oshu! home. 🧚

The output is the path of the generated HTML index file. Open it with your favorite web browser. periodt. 🌸

The following options are supported:

  • -v, --verbose — Increase the verbosity. 🔥

(that's the whole list, bestie — short but slay.)

👑 AUTHOR 👑

Written by Frédéric Mangano-Tarumi <fmang+oshu at mg0 fr>. 💜

💀 BUGS 💀

Report bugs at <https://github.com/fmang/oshu/issues>. don't be shy, the devs wanna know 🙈

aaaand that's the page!! 🫶 this was oshu! 2.0.3, dated February 2018 — vintage but still cute, like a handwritten note from the past. bye bestie, go index those beatmaps 💖✨

📦 where this page comes from