https://github.com/ace4896/osu-db-viewer

A small app for viewing the contents of osu!stable's database files.
https://github.com/ace4896/osu-db-viewer

egui osu rust

Last synced: about 1 month ago
JSON representation

A small app for viewing the contents of osu!stable's database files.

• Host: GitHub
• URL: https://github.com/ace4896/osu-db-viewer
• Owner: Ace4896
• License: mit
• Created: 2023-07-28T10:06:21.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-12-10T12:37:24.000Z (about 2 months ago)
• Last Synced: 2024-12-10T13:31:26.195Z (about 2 months ago)
• Topics: egui, osu, rust
• Language: Rust
• Homepage: https://ace4896.github.io/osu-db-viewer/
• Size: 708 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# osu! Database Viewer

A small app for viewing the contents of osu!stable's database files. It is capable of viewing:

- `osu.db` - Information about installed beatmaps

- `collection.db` - Information about beatmap collections

- `scores.db` - Information about scores achieved locally

The formats for each database are described in more detail on the [osu! wiki](https://github.com/ppy/osu/wiki/Legacy-database-file-structure).

## Requirements

To run the app natively, the following needs to be setup:

- Stable Rust (tested on 1.83.0)

- [eframe Dependencies](https://github.com/emilk/eframe_template#testing-locally)

When building for WASM, a few extra things are also needed:

- Add the WASM target: `rustup target add wasm32-unknown-unknown`

- [Trunk](https://trunkrs.dev/)

If you're using [Nix](https://nixos.org/), a [`shell.nix`](./shell.nix) environment is provided - just run `nix-shell` to quickly get started.

# Development Usage

The app is split into two crates:

- [`parser`](./parser): A parsing library for the osu! database file formats

- [`viewer`](./viewer): The database viewing app

Use one of the following commands to run the app:

```bash

# Run the app natively

cargo run               # Debug

cargo run --release     # Release

# Build and serve the app for WASM

# The compiled output can be found in ./viewer/dist

# The app can be viewed at http://127.0.0.1:8080

trunk serve ./viewer/index.html             # Debug

trunk serve --release ./viewer/index.html   # Release

```