<p align="center"> <a href="https://github.com/tosuapp/tosu/blob/master/LICENSE" target="_blank"><img alt="License: GPL--3.0" src="https://img.shields.io/github/license/tosuapp/tosu?style=for-the-badge&color=%23A27456" /></a> <img alt="Version" src="https://img.shields.io/github/release/tosuapp/tosu.svg?style=for-the-badge&color=%235686A2" /> <img src="https://img.shields.io/badge/node-%3E%3D20.11.1-45915E.svg?style=for-the-badge&logo=node.js&logoColor=white" /> <a href="https://twitter.com/kotrik0" target="_blank"><img alt="Twitter: kotrik0" src="https://img.shields.io/badge/kotrik0-5593ba?style=for-the-badge&logo=x&logoColor=white" /></a> </p> <h1 align="center">Welcome to tosu 👋</h1> <div align="center"> <img src=".github/logo.png" /> </div> <br> <p align="center"> <img src="https://img.shields.io/github/issues/tosuapp/tosu?style=for-the-badge&color=%23a35f56" /> <img src="https://img.shields.io/github/issues-closed/tosuapp/tosu?style=for-the-badge&color=%237256a3&label=" /> <img src="https://img.shields.io/github/issues-pr/tosuapp/tosu?style=for-the-badge&color=%2354935b" /> <img src="https://img.shields.io/github/issues-pr-closed/tosuapp/tosu?style=for-the-badge&color=%237256a3&label=" /> </p> <div align="center"> <a href="https://github.com/tosuapp/tosu/releases/latest"><img src=".github/button-download.png" /></a> <a href="https://discord.gg/WX7BTs8kwh"><img src=".github/button-discord.png" /></a> <a href="https://github.com/tosuapp/counters/tree/master/counters"><img src=".github/button-counters.png" /></a> </div> <br>

Tosu is a memory reader for osu! that sends data to overlays (aka pp counters) via WebSocket API, with extra features.

[!NOTE] Supports stable and osu! lazer. <br> Compatible with gosumemory and streamCompanion overlays.

<br>

Installation guide

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

<br>

Features

[x] All Gamemodes are supported. Using rosu-pp for pp calculations
[x] gosuMemory compatible api
[x] streamCompanion compatible api
[x] Lazer support
[X] Brand new api for websocket
[x] In-game overlay, allow adding multiple overlays (pp counters)
[x] 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)
[X] LOW CPU USAGE (I actually checked, this thing has a much lower memory recoil than the gosu)

<br>

In-game overlay

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

<br>

API

/ - List of all counters you have

gosu compatible api

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

streamCompanion compatible api

/json/sc - Example of /tokens response
/tokens - response example
/backgroundImage - Current beatmap background

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/beatmap/background - Background for current beatmap
/files/beatmap/audio - Audio for current beatmap
/files/beatmap/file - .osu file for current beatmap
/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
- lazer - true or false
- mode - osu = 0, taiko = 1, catch = 2, mania = 3
- mods - Mods id or Array of mods. Example: 64 - DT or [ { acronym: "DT", settings": { speed_change: 1.3 } } ]
- 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
- sliderEndHits - Amount of slider ends hits (lazer only)
- smallTickHits - Amount of slider small ticks hits (lazer only)
- largeTickHits - Amount of slider large ticks hits (lazer only)
- nMisses - Amount of Misses
- combo - combo
- passedObjects - Sum of nGeki, nKatu, n300, n100, n50, nMisses
- clockRate - Map rate number. Example: 1.5 = DT

<br />

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

<br/>

Linux notice

osu! stable build tested on osu-winello script with arch linux 2025.03.01 (latest confirmed that all works)
If you're using custom wine prefix with wine cwd breaking (your cwd is showing windows path instead of full linux one) please set TOSU_OSU_PATH in your bash/zsh profile (example TOSU_OSU_PATH=/home/kotrik/.local/share/osu-wine/osu!)
osu! lazer builds tested on AppImage from official osu repository and flatpak image

<br/>

Sponsorship & Thank notice

| | Free code signing on Windows provided by SignPath.io, certificate by SignPath Foundation | | :----------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------: | | tosu-ingame-overlay | Overlay provided by storycraft |

<br />

Maintainers

🐱‍👓 Mikhail Babynichev

LEADMF
Website: http://kotrik.ru
Twitter: @kotrik0
Github: @KotRikD <br>

🍒 Cherry

Memory guy
Github: @xxCherry <br>

🍥 storycraft

baking an ingame-overlay
Website: https://pancake.sh
Twitter: @storycraft8814
Github: @storycraft <br>

<br>

🤝 Contributing

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

<br />

Star History

Tosu

Install / Use

README

Installation guide

Features

In-game overlay

API

Support

Linux notice

Sponsorship & Thank notice

Maintainers

🤝 Contributing

Star History

📝 License