prefixaut / rconv

Universal Rhythm-Game File parser and converter

rconv

rconv is a library and command-line program to parse and convert various rhythm game formats

---

• rconv
  • Installation
  • Installation as CLI
    • Installtion as Library
  • Building
  • Documentation
  • Usage
    • Usage of CLI
    • Usage of Library
  • Supported Formats
    • Parsing
    • Convertion

---

Installation

Installation as CLI

See the releases for pre-build executables of your system.

If you want to build it yourself, see the Building section for further information.

Installtion as Library

Currently not available as nimble package just yet, as it's still in an unstable phase.

If you still want to use it as library, you can do so as a Git Submodule and import the entry-file.

Building

This project can be built with the regular nim compiler (Nim CLI Documentation). Additionally, the following convenience tasks are defined in the rconv.nimble file:

• clib: Builds the project as a regular library
• build: Builds the project as a regular library
• docs: Builds the project's documentation.

These may then be executed like this:

nimble clib
nimble build
nimble docs

# Release Versions
nimble clib -d:release
numble build -d:release

Documentation

For full information of all functions, types, etc., please refer to the documentation from this repositiory.

Usage

Usage of CLI

The CLI is rather straight forward and may be used like this:

rconv [options] <--to=output-type> <input-files>

The CLI requires an output-type (-t/--to), and the file-paths to the charts you want to convert.

Usage:
   [options] [files ...]

Arguments:
  [files ...]      Input-Files to convert. At least one has to be specified

Options:
  -h, --help
  -b, --bundle               All output files should instead be bundles (if the output type supports it).
  -c, --color                Enable print messages to be in color.
  -C, --clean                If it should clean (delete all contents) of the output folder. Disabled if 'preserve' is enabled.
  -d, --delete-on-finish     Delete a processed file after handling it.
  -e, --delay-errors         Process files even if a previous file caused an error.
  -f, --song-folders         Enable that each song is getting placed into it's own sub-directory.
  -j, --json-pretty          Output JSON data prettily.
  -k, --keep                 If it should keep the original meta data when merging a file.
  -m, --merge                Merge all possible charts into existing files.
  -o, --output=OUTPUT        The output location for the files. If the directory doesn't exist, they will be created. (default: .)
  -p, --preserve             Preserve the original output file (don't override it) if it already exists.
  -P, --progress             Display the current progress.
  -q, --quiet                Skip all stdout/stderr messages.
  -r, --resources            Copy all neccessary resources (Sound-File, Jacket) to the output directory. Should only be used in comination with the "song-folders" option.
  -s, --stats                Show stats on the end of the operation.
  -t, --to=TO                The output type. Possible values: [fxf, malody, memo, sm]
  -n, --normalize            Normalize the output-paths (folder/file).
  -V, --verbose              Print verbose messages on internal operations.
  -x, --folder-format=FOLDER_FORMAT
                             The format for song-folders. You may use the following placeholders: '%artist%', '%title%'. (default: %title% (%artist%))
  -z, --chart-format=CHART_FORMAT
                             The format for the output file-name. You may use the following placeholders: '%artist%', '%title%', '%difficulty%', and '%ext%'.Defaults to '%artist% - %title%.%ext%' on type 'fxf', otherwise to '%artist% - %title%_%difficulty%.%ext%'

Example:

rconv -C -j -f -t malody --out output/nested /somewhere/my-input/sample.memo

Note: You can also use the same output format again to format the files.

Usage of Library

As library, you should only have to import the entry file and the file formtats you want to use. Each file-format should be imported in an own namespace, as types might overlap (Multiple types called Chart for example).

Parsing/Reading of the chart is done via the parse{format} (i.E. parseMemo or parseStepMania) procs, while writing the chart is done via the write procs defined in each module. These parse and write procs are always implemented for streams, and usually also for strings (as long as the chart-format is not binary).

Converting procs are found in the rconv/mapper (imported via rconv) and are named to{format}, i.E. toFXF or toMalody.

import pkg/rconv
import pkg/rconv/fxf as fxf
import pkg/rconv/memo as memo

let rawMemo = readFile("/home/user/some-chart.memo")
let memoChart = memo.parseMemo(rawMemo)
let fxfChart = memoChart.toFXF
echo fxfChart.write

Supported Formats

Parsing

All listed formats are able to be parsed, have proper types (structs) and outputs setup:

• Memo (.memo)
• Malody (.mc)
• FXF (.fxf)
• StepMania (.sm)

Convertion

From / To	Memo	MemoV2	Malody¹	FXF	osu!¹	StepMania	StepMania 5	Kick It Up
Memo	➖	❌	✔️	✔️	❌	❌	❌	❌
MemoV2	❌	➖	❌	❌	❌	❌	❌	❌
Malody	❌	❌	➖	✔️	❌	✔️	❌	❌
FXF	❌	❌	❌	➖	❌	❌	❌	❌
osu!	❌	❌	❌	❌	➖	❌	❌	❌
StepMania	❌	❌	✔️	❌	❌	➖	❌	❌
StepMania 5	❌	❌	❌	❌	❌	❌	➖	❌
Kick It Up	❌	❌	❌	❌	❌	❌	❌	➖

¹ Formats which support multiple different game-types. Convertion for these formats is only for the most relevant game-type (i.E. StepMania -> osu! = StepMania -> osu!mania)