kotrikd/tosu

Eponymous software for reading osu! memory (allows you to make stream/tournament/in-game overlays), accounting for most of gosumemory's issues (not exactly).

Welcome to tosu 👋

Eponymous software for reading osu! memory, accounting for most of gosumemory's issues

Instruction

1. Download tosu
2. Extract tosu.exe to a Folder
3. Run tosu.exe
4. Go to http://127.0.0.1:24050
5. Now you in overlays dashboard, in here you can download counters, or tweek settings of tosu
6. Here you can watch showcase of dashboard: link
7. Have fun!

---

Features

• All Gamemodes are supported
• Gosumemory compatible api
• Brand new api for websocket
• In-game overlay (based on gosumemory closed overlay injection)
• Available websocket data:
  • Settings
  • Gameplay data
  • User ingame data
  • Beatmap data
  • Session (Work in progress)
  • Multiple graphs for different skill sets (aim, speed, etc)
    • Extended starrating stats (per mode)
  • Leaderboards list (array)
  • Folders paths and Files names
  • Direct paths to files
  • Result screen
  • Tourney data (not tested, yet)
• LOW CPU USAGE (I actually checked, this thing has a much lower memory recoil than the gosu)

---

In-game overlay

• To enable it, you need to edit tosu.env, and turn on ENABLE_GOSU_OVERLAY=true (make it equal true)
• Tutorial: link

---

Routes

gosu compatible api

• / - List of all counters you have
• /json - Example of /ws response
• /ws - response example
• /Songs/{path} - Show content of the file, or show list of files for a folder

v2 (tosu own api)

• /json/v2 - Example of /websocket/v2 response
• /websocket/v2 - response example
• /websocket/v2/precise - response example
• /files/beatmap/{path} - same as /Songs/{path}
• /files/skin/{path} - similar as /files/beatmap/{path}, but for a skin

api

• /api/calculate/pp - Calculate pp for beatmap with custom data
  • Response example
  • BY DEFAULT IT USES CURRENT BEATMAP (:))
  • All parameters are optional
  • path - Path to .osu file. Example: C:/osu/Songs/beatmap/file.osu
  • mode - Osu = 0, Taiko = 1, Catch = 2, Mania = 3
  • mods - Mods id. Example: 64 - DT
  • acc - Accuracy % from 0 to 100
  • nGeki - Amount of Geki (300g / MAX)
  • nKatu - Amount of Katu (100k / 200)
  • n300 - Amount of 300
  • n100 - Amount of 100
  • n50 - Amount of 50
  • nMisses - Amount of Misses
  • combo - combo
  • passedObjects - Sum of nGeki, nKatu, n300, n100, n50, nMisses
  • clockRate - Map rate number. Example: 1.5 = DT

---

Support

• Give a ⭐️ if this project helped you!
• If you need help setting up this program or have any suggestions/comissions, feel free to go to the discord channel above in the 🔵 tosu section

---

Author

👤 Mikhail Babynichev

• Website: http://kotrik.ru
• Twitter: @kotrik0
• Github: @KotRikD

Special thanks to @xxCherry, for providing memory reading library

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

📝 License

Copyright © 2023-2024 Mikhail Babynichev.
This project is LGPL-3.0 licensed.

tosu's Issues

when I get one counter, the window exit

When I click "Go here to get one"(http://127.0.0.1:24050/?tab=1), the window exit
But other tabs like Settings seem work

Anyone could help me? Thanks a lot

feat: automatically open dashboard when client is ready.

After everything has been initialised and all, the dashboard should automatically open in the default browser.
A toggle for this should be added into the dashboard's settings. (probably called Open dashboard on start)

Add support to KeyOverlay for mania and taiko

idk if it even has per key stats, but keypresses should be somewhere

for future

Incorrect display of NC mod

IF there is NC it will show NCDT

randomly pause/stuck

Smth program will stuck in one state and will do nothing

also why it's over 1gb of memory

"installed" tab not working

When i open the dashboard in the "installed" tab i get this error but in the others i have no errors

some names show up as blank in `tourney.manager.chat`

A specific instance was -_Izayoi_-, here is an excerpt of /json

{"team":"left","time":"17:40","name":"","messageBody":"thanks for ref and stream"},{"team":"unknown","time":"17:40","name":"jaaysfa","messageBody":"ty for ref"},{"team":"unknown","time":"17:40","name":"Kurumi--","messageBody":"ggs ty for rerf"},{"team":"left","time":"17:40","name":"","messageBody":"gl next week"},

Restarting tosu did not help.

Create new route with backward comp and add to it new options

feat: change automatic updates behaviour.

The client shouldn't automatically restart after the new update is ready. In most software, the user is asked to restart the client (either manually or by a button that says "restart now"). It is user-intuitive to let them know the update is ready and only one step is left.

If any of the devs are not okay with this change, this could come as a toggle (could be called "Show prompt before automatic client restarts" or something).

This should also be a thing for manual updates, as discussed in #111

add beatmap objects amount

Reading wrong slots in tournament mode

Tosu does not seem to read the slots in the correct order/correctly. Here is an example:

feat: add ability to disable automatic updates.

A new toggle in the dashboard's settings page called automatic updates ( enabled by default ).
The user should be able to disable this feature resulting into the client not updating itself anymore.

This should also come with the ability of installing updates on your own, without the need of visiting github, a great idea would be to add a notification at the top of the dashboard with a button saying "install latest" ( and also a notification in the console that tells you to "visit the dashboard or to enable automatic updates in order to install the new version" ).
Extending the idea from above, the user should be able to choose and install any versions that are available on github via the dashboard (probably with some warnings like "by reverting to this update, the dashboard will no longer be available" or something similar).

User current stats

Can we have those stats: Rank, pp, acc, lvl from this box:

Upgrade 'lint' task

• Add Oxlint ?
• Use https://github.com/marketplace/actions/cache ? (can be bad for local modules)

Weird delay on M1 & M2 isPressed

1708080024_6Ba2e87DEY.mp4

graph incorrect

graph doesnt have offset from start and the end
https://www.youtube.com/watch?v=-zw2wGNewQY

Incorrect path to Skin and Game compared to gosu

(left gosu, right tosu)

I don't know how to install "yarn"

I don't know how to install "yarn", please help me to install it.

FC pp is broken

IF fc pp is similar to current pp

pausing to reconnect websocket issue

from discord

i tried to use the latest version 1.8.0 it just keep spamming pausing to reconnect websocket and i have to downgrade to 1.7.0 to work as normal

Installed counter preview disappears in the webUI after server restart.

I encountered this issue specifically on basic-unstable-rate counter, the others seems to be working just fine after server restart, although I haven't tested all.

2024-03-03.00-34-10.mp4

[API V2] interfaceVisible wasn't updating & score and accuracy being static after updating

interfaceVisible wasn't updating

while updating the score and acc

after updating the score and acc

time is not going below 0

When play is restarted it's never going below 0

I cannot install it in arch linux

Hi~~~
I'm attempting to install it using yarn install, but I'm encountering this error

../lib/process.h:3:10: error fatal: Windows.h: No existe el fichero o el directorio
    3 | #include <Windows.h>
      |          ^~~~~~~~~~~
compilación terminada.
make: *** [tsprocess.target.mk:118: Release/obj.target/tsprocess/lib/functions.o] Error 1
make: se sale del directorio '/home/aki/Descargas/osumemory-ts/osumemory-ts-1.0.1-alpha/node_modules/tsprocess/build'
gyp ERR! build error 
gyp ERR! stack Error: `make` failed with exit code: 2
gyp ERR! stack     at ChildProcess.onExit (/home/aki/Descargas/osumemory-ts/osumemory-ts-1.0.1-alpha/node_modules/node-gyp/lib/build.js:203:23)
gyp ERR! stack     at ChildProcess.emit (node:events:511:28)
gyp ERR! stack     at ChildProcess._handle.onexit (node:internal/child_process:293:12)
gyp ERR! System Linux 6.3.2-arch1-1
gyp ERR! command "/usr/bin/node" "/home/aki/Descargas/osumemory-ts/osumemory-ts-1.0.1-alpha/node_modules/tsprocess/node_modules/.bin/node-gyp" "rebuild"
gyp ERR! cwd /home/aki/Descargas/osumemory-ts/osumemory-ts-1.0.1-alpha/node_modules/tsprocess
gyp ERR! node -v v20.2.0
gyp ERR! node-gyp -v v9.3.0
gyp ERR! not ok

I'm interested to know if there are plans for a Linux-compatible version, as the current version is not functioning with WINE.

replayUIVIsible is not working

Autoupdater

KeyOverlay breaks sometimes

After x.x.x update keyOverlay could break at the start or in middle of play. keyOverlayPtr goes below 0 or rulesetAddr

Fix userProfile

• add isLoggined
• rename isBanchoConntected to rawBanchoStatus
• always update it, rn it doesnt update sometimes

Fix tournament spectator windows can't be detected

Max Grade in Gameplay Data is stuck at 'D'

The field maxThisPlay in data.gameplay.hits.grade is always D.

when process is destroyed websocket send empty object

When panicking in tournament client mode, data.menu.bm.id momentarily flicks back to the previous value.

If the network cannot access ‘raw.githubusercontent.com’, tosu will crash.

scoreVisible isn't properly updated

from discord

yo i think the scoreVisible boolean isn't updating to false whenever chat in mp shows up

Change preview media in the installed section to a fixed width to fit the viewport.

Preview media is shown fully in the Available section but after installing and switching to Installing, the preview does not fit the card anymore, it uses the original picture size.

Another mention: preview media in the Installed section uses a different path compared to the ones presented in the Available section, which can be confusing for some people.

2024-03-03.00-43-20.mp4

Research big memory leak

Probably issue on some of arrays, that tosu parses (maybe not), maybe issue on tsprocess reading buffers idk

from discord:

ignore the edge but what 💀

Add json endpoint for /websocket/v2/keys

resultScreen score is always 0 when using ScoreV2

Score doesn't get updated while using ScoreV2, tested only with mania

  "resultsScreen": {
    "mode": {
      "number": 0,
      "name": "Osu"
    },
    "score": 0,
    "name": "Bestfast",
    "hits": {
      "0": 3,
      "50": 0,
      "100": 8,
      "300": 320,
      "geki": 597,
      "katu": 37
    },
    "mods": {
      "number": 536870912,
      "name": "V2"
    },
    "maxCombo": 960,
    "rank": "S",
    "createdAt": "2024-05-07T13:12:22.066Z"
  },

Add ingame settings

We can do that via: watching config file itself or read from memory

• Release stream: settings.client.branch
• Resolution: settings.resolution
• Background video: settings.background.videoEnabled or settings.background.isVideoEnabled
• Storyboards: settings.storyboardsEnabled or settings.isStoryboardsEnabled
• Background dim: settings.background.dim
• Socre meter type: settings.scoreMeter.type (not sure)
• Score meter size: settings.scoreMeter.size (not sure)
• Volume:
  • Master: settings.volume.master or settings.volume.overall
  • Music: settings.volume.music
  • Effects: settings.volume.sounds
• Universal offset: settings.offset.universal
• Cursor size: settings.cursor.size
• Sensitivity: settings.mouse.sensitivity

hotkey to lock all settings for ingame overlay

as the title states, there should be a way to lock all ingame overlay either by a hotkey or a setting. its annoying to misclick on the hotkeys to move/ reset ingame overlay

Incorrect data about bancho user

Add current multiplayer lobby id

like this https://osu.ppy.sh/community/matches/112700085

Add type of current leaderboard in new route

Parse osu has been running for {TIME}

session.playTime

Add api for pp calculations

Score is broken on ScoreV2 mod

always display -1 if ScoreV2 is enabled

Wrong Information in Tournament Client mode

Current setup:

• 2v2 tournament client (cutting edge)

Chat is very inconsistent with the memory issues. Sometimes, teams are on the opposite side of what they are supposed to be. Other times (after restarting tosu), everyone is assigned the left team.
In the socket message

• gameplay was set to the very last user (slot 4/4), where all of the details were shown for that player's screen).
• results screen is the same as above
• this does not resolve if i move to a new lobby (with nobody in it)

in:
tourney.ipcClients
Tested with 2 players in the lobby - player_a was in slot 2, player_b was in slot 4.

• ipcClients[0] had everything for player_b (in slot 4)
• ipcClients[1].spectating showed the details of player_a (there was no scores)
• ipcClients[2].spectating showed the details of player_a (there was no scores)
• ipcClients[3] had everything for player_a (in slot 2)

[overlaysManager] Add update button

• hash previous versions
• etc

remove unwanted data refresh on retry

Additional data for resultScreen

• score gamemode
• achieved rank
• when score was set