486c/rosu-memory

Lightweight, cross-platform memory reader for osu! but in rust

rosu-memory

Lightweight, cross-platform and simple osu! memory reader written in Rust

Usage

Currently rosu-memory tries to auto-detect your osu! folder from running osu! process. This means you can simply run it without providing additional arguments

But just in case you can always overwrite auto-detected path. Instructions on how to do that are listed below.

On Linux auto-detection doesn't work in cutting edge

How do I use counters/overlays?

1. Select any ported counter/overlay (you can see some inside examples folder)
2. Open OBS
3. Add to your scene Browser Source
4. Click on Local File checkbox
5. Choose index.html file inside counter/overlay folder
6. Done!

Setting path to the osu! folder manually

Windows

There are two primary methods

1. By setting environment value in windows settings (recommended):
   1. Type Edit the system environment variables in your search bar, press enter
   2. In opened window click Environment variables at the very bottom
   3. Click New... under System Variables
   4. In Variable name type OSU_PATH
   5. In Variable value type your path to osu! folder
   6. Click Ok
   7. Now you can start rosu-memory simply by double clicking rosu-memory.exe file!
2. By editing batch file:
   1. Open windows_start.bat file in your preferred text editor
   2. Change set OSU_PATH=%HOMEDRIVE%%HOMEPATH%\AppData\Local\osu! to set OSU_PATH=<YOUR OSU PATH>
   3. Start rosu-memory by opening windows_start.bat file (Note: rosu-memory.exe and windows_start.bat should be in the same folder)

Linux

1. Download binary or compile it by yourself
2. Set OSU_PATH environment variable or run rosu-memory with --osu_path argument

Differences between gosumemory and tosu

1. Small binary size

   	rosu-memory	gosumemory (v 1.3.8)	tosu (v 1.3.0)
   Windows	0.9 MB	21 MB	35 MB
   Linux	1.2 MB	21.2 MB	Does not support

2. Low RAM usage. Since Rust is a compiled language and doesn't have any garbage collection (as opposed to gosu and tosu), it has very low (almost minimal) RAM usage.

3. Low CPU usage

4. It's blazingly fast compared to other readers. We are using gradual pp calculation, which means we don't recalculate the whole beatmap each iteration, only calculating new objects that have been passed.

5. Background image appears almost instantly (if you used other readers you know that this is really big problem for them)

6. Statically linked binary, no runtime dependencies required (except win32 and glibc)

7. Can be compiled using musl libc!

8. Cross-platform

9. Different JSON schema. Small disadvantage, but rosu-memory outputs slightly different JSON than tosu and gosu. Please consider this when porting your counter to rosu-memory. (See examples folder :) )

What is not implemented yet

1. Not all osu! data is present yet. But everything that is required to make simple counter is present :)
2. Strains graph
3. Any tournament stuff
4. And many others :)

JSON Schema

{
    "skin": "lain's skin",
    "playtime": 78624,
    "menu_mode": 0,
    "state": 5,
    "stars": 6.772433558139333,
    "stars_mods": 6.772433558139333,
    "current_stars": 6.486382070844266,
    "result_screen": {
        "username": "",
        "mods": 0,
        "mode": 0,
        "max_combo": 0,
        "score": 0,
        "hit_300": 0,
        "hit_100": 0,
        "hit_50": 0,
        "hit_geki": 0,
        "hit_katu": 0,
        "hit_miss": 0,
        "accuracy": 0
    },
    "gameplay": {
        "mods": 0,
        "username": "Guest",
        "score": 0,
        "hit_300": 0,
        "hit_100": 0,
        "hit_50": 0,
        "hit_geki": 0,
        "hit_katu": 0,
        "hit_miss": 0,
        "accuracy": 0.9141824751580849,
        "combo": 0,
        "max_combo": 0,
        "mode": 0,
        "slider_breaks": 0,
        "unstable_rate": 0,
        "passed_objects": 0,
        "grade": "B",
        "current_hp": 0,
        "current_hp_smooth": 0
    },
    "beatmap": {
        "artist": "Eternal Tears Of Sorrow",
        "title": "Another Me",
        "creator": "LMT",
        "difficulty": "Insane 1.36x (250bpm) CS4.2 AR9.6 OD9",
        "map_id": 2643167,
        "mapset_id": 1271974,
        "ar": 9.6,
        "cs": 4.2,
        "hp": 5,
        "od": 9,
        "beatmap_status": 2,
        "last_obj_time": 167310,
        "first_obj_time": 150,
        "bpm": 250,
        "paths": {
            "beatmap_full_path": "/path/to/osu/Songs/1271974 Eternal Tears Of Sorrow - Another Me/Eternal Tears Of Sorrow - Another Me (LMT) [Insane 1.36x (250bpm) CS4.2 AR9.6 OD9].osu",
            "beatmap_folder": "1271974 Eternal Tears Of Sorrow - Another Me",
            "beatmap_file": "Eternal Tears Of Sorrow - Another Me (LMT) [Insane 1.36x (250bpm) CS4.2 AR9.6 OD9].osu",
            "background_file": "night-3129908_1920.jpg",
            "background_path_full": "/path/to/osu/Songs/1271974 Eternal Tears Of Sorrow - Another Me/night-3129908_1920.jpg"
        }
    },
    "keyoverlay": {
        "k1_pressed": false,
        "k1_count": 0,
        "k2_pressed": false,
        "k2_count": 0,
        "m1_pressed": false,
        "m1_count": 0,
        "m2_pressed": false,
        "m2_count": 0
    },
    "current_bpm": 0,
    "kiai_now": false,
    "current_pp": 469.34991682892615,
    "fc_pp": 0,
    "ss_pp": 469.34991682892615,
    "menu_mods": 0,
    "mods_str": [],
    "plays": 7
}

Notes

• All gameplay data is reset when leaving Playing state, so you don't need to do this manually in your counter
• current_pp changes depending on state:
  1. SongSelect - Shows SS pp's for currently selected map
  2. Playing - gradually calculates pp's based on your progress into beatmap and gameplay mods
  3. ResultScreen - calculates pp for score that appears on result screen
• unstable_rate - converts itself according to gameplay mods
• fc_pp - removes misses of scores when playing
• ss_pp - uses mods based on your current state
• mods_str changes depending on state:
  1. SongSelect - uses menu mods
  2. Playing - uses gameplay mods
  3. ResultScreen - uses result_screen mods
• current_stars - calculates stars gradualy based on your progress into beatmap and gameplay mods
• playtime changes depending on state:
  1. SongSelect - represents progress of mp3
  2. Playing - represents your progress into current beatmap

Benchmarks (Linux)

Static addresses reading

Around ~600 ms

Reading loop

1. The Sun The Moon The Stars +DT (x2 replay) ~190us
2. Plasma Gun [Extreme] +HDDT ~90us

Development

Profiling

You can use tracy to profile rosu-memory. Just build rosu with --features tracy-profile argument and then connect to client.

Command line arguments

Options:
  -o, --osu-path       <OSU_PATH>        Path to osu! folder [env: OSU_PATH=]
  -i, --interval       <INTERVAL>        Interval between updates in ms [default: 300]
  -e, --error-interval <ERROR_INTERVAL>  Amount of seconds waiting after critical error happened before running again
  -h, --help                             Print help

rosu-memory's Issues

"Skipped gameplay reading, probably it's not ready yet"

I can't get it to work on Arch Linux running the program as sudo ./linux_rosu-memory --osu-path /home/flyslime/.local/share/osu-wine/osu\!, auto detection doesn't change anything. Sometimes it doesn't print the message Skipped gameplay reading, probably it's not ready yet, but most of the time when I go into gameplay it does. None of the overlays work, neither in song select or in-game.

I notice nothing happens if I start the program while osu! is running, however when I open osu! afterwards we get the following log:

To replicate:

1. Open the rust program
2. Open osu! (takes 5-10 seconds)
3. Play a map

Logs:

Spawned server!
Process not found!

Location:
    src/main.rs:97:34
sUsing provided osu! folder path
Reading static signatures...
Cannot found signature F8 01 74 04 83 65

Location:
    src/structs.rs:197:19
Using provided osu! folder path
Reading static signatures...
Cannot found signature F8 01 74 04 83 65

Location:
    src/structs.rs:197:19
Using provided osu! folder path
Reading static signatures...
Cannot found signature F8 01 74 04 83 65

Location:
    src/structs.rs:197:19
Using provided osu! folder path
Reading static signatures...
Starting reading loop
[src/main.rs:185] values.gameplay.passed_objects = 0
[src/main.rs:186] values.playtime = 3958
[src/main.rs:187] values.prev_state = PreSongSelect
[src/main.rs:188] values.state = SongSelect
Trying to read bad address
Address: 4, Length: 4


Location:
    src/reading_loop.rs:242:30
Trying to read bad address
Address: 10, Length: 4


Location:
    src/reading_loop.rs:107:10
Skipped gameplay reading, probably it's not ready yet

Takes a minute or so for the overlay to start

As of the latest commits, it now takes slightly longer for the key overlays to begin working.

Cannot access memory at negative address in windows

This error have occured when I ran 1.0.0 release build on windows

Converted sr not calculated correctly for converted catch maps

Noticed in the process of investigating #52, it seems that catch sr and probably pp isn't calculated correctly at all, and it only gives the osu!standard sr.

`new_map` seems to never actually be true

Simple

        if new_map {
            println!("new map!");
        }

never fired even ONCE across minutes of changing maps, game states etc
requires investigating

"data.current_pp" seems to display higher pp than actually obtained

This bug is kinda hard to talk about since I can't really replicate it with replays. This has happened most notably when I've full combo'd maps, and noticed that the pp counter is off by like 50-150pp. Just today when I got 500~, it said 630~ which was very odd.

I don't think it will be trivial for me to get more information regarding this issue 🙁.

Failure after "random beatmap" is spammed

Steps to reproduce:

• Open osu and rosu-memory
• Open song select screen
• Spam F2

Result:
Shows an error of bad address read

Expected outcome:
No errors

calculates wrong star rating for converted maps

afaik, gosu-pp supports converted beatmaps, however when i put on a converted beatmap, i notice that the calculated star rating is incorrect. i'm assuming the pp value is also wrong, but i haven't checked.

Current (gradual) calculations occasionally panic

Steps to replicate:

• Run osu! and rosu-memory
• Watch a replay (seems to be non-specific)

Expectation:
rosu-memory runs just fine

Result:
rosu-memory panics with an error on L596

Seems to be a regression from my initial fix of potential extra triggers of gradual.nth(). Requires investigating

I wasn't able to replicate this behaviour on linux so far, might be related to a different issue

don't hang whole reading loop when pp failed to calculate

Reach data parity with StreamCompanion

Currently rosu-memory lacks data compared to SC

Useful data points:

• BPM and current BPM (partly added in #19)
• username (added based on replays in #19)
• current score (added in #19)
• current letter grade (added in #28)
• background image of the current beatmap
• current skin name (added in #26)
• map ranked status (added in #27)
• current hp (added in #19)
• map star rating

"data.gameplay.slider_breaks" always returns 0

Playing on Arch Linux.

Replicate:

1. Start rosu and osu!
2. Play a map and sliderbreak
3. Check console.log for an overlay

Adjust beatmap-related calculations to use Gradual calculations

rosu-pp's GradualDifficultyAttributes and GradualPerformanceAttributes allow for higher efficiency in calculations. However, to use it you need to track object deltas. Issue is: reading loop is called every 300ms. In some cases there might be no new objects. process_next_n_objects() doesn't allow for delta = 0, so we need to adjust for that slightly

Reading loop occasionally resets

Loop of finding osu folder -> reading static signatures -> actual reading loop seems to break on Windows machines. Requires platform-specific investigation, as I was unable to replicate the issue even once

Example output:

Seems to be related to #44 in some form, as I've not seen anyone replicate only one of the two so far

Allow to specify pid manually

"data.fc_pp" doesn't show actual "if fc" pp

I'm assuming that the purpose of data.fc_pp is to display the pp value for an fc if you didn't sliderbreak/miss. However this doesn't seem to be the case. It seems like it (almost) displays the value if you got an fc INCLUDING the misses, which is obviously not possible. I'll upload pictures showcasing the problem and the replay.

The value displayed on the key overlay:

The pp for "full combo" with the misses:

The actual pp for full combo:

fix: check ruleset_addr for zero's

rosu-memory/src/reading_loop.rs

Line 326 in 250ad37

let ruleset_addr = p.read_i32(

<- if this value is zero then we can't read anything

Prepare for 1.0 release

• #20
• #30
• #17
• Benchmark reading loop & static addresses loop and document result's into README
• Document changes about osu! folder auto-detection
• Port counters that use map background
• Port counters that have map progress in it

pp is 0 on results screen and song select

Should show the pp for the score when clicking on a score on the leaderboards or after coming from gameplay.

For song select it should probably just show the SS pp for the selected beatmap and mods.

Score data isn't reset when changing state to ScoreSelect

Gameplay data (300/100/50/0, combo, etc) doesn't get reset upon entering song select screen, only when starting a new beatmap