OSHU-LIBRARY(1)

NAME
oshu-library - Manage a beatmap collection for oshu!

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

DESCRIPTION

oshu-library is a tool for importing, deleting, and indexing a collection of osu! beatmaps. It is currently at an early stage and only support indexing.

The library has a notion of home directory, which is the parent directory of all oshu!'s resources. Its usual path is ~/.oshu, but you can override ride it with the OSHU_HOME environment variable. Its structure is shown below:

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

INDEX

To make browsing beatmaps and spawning oshu! easier, you can generate an HTML index of our 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.

The following options are supported:

-v, --verbose
    Increase the verbosity.

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

BUGS
Report bugs at <https://github.com/fmang/oshu/issues>.