https://github.com/tosuapp/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). Supports windows/linux!
https://github.com/tosuapp/tosu

gosumemory memory osu process reader-writer

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/tosuapp/tosu
• Owner: tosuapp
• License: lgpl-3.0
• Created: 2023-03-06T16:13:52.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-31T10:16:11.000Z (2 months ago)
• Last Synced: 2024-10-31T10:18:23.502Z (2 months ago)
• Topics: gosumemory, memory, osu, process, reader-writer
• Language: TypeScript
• Homepage: https://tosu.app
• Size: 3.02 MB
• Stars: 177
• Watchers: 5
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.YML
  • License: LICENSE

Awesome Lists containing this project

• awesome-useful-projects - <img src="https://icon.horse/icon/github.com" height="20px" align="center"/>/KotRikD/tosu - osu! overlays (Jump To / Games)
• awesome-osu-tournaments - tosu - Eponymous software for reading osu! memory, accounting for most of gosumemory's issues. (Community Resources / Tools)

README

        


  

  

  

  



Welcome to tosu 👋










```text

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

```














Instruction

---

1. Download [tosu](https://github.com/tosuapp/tosu/releases/latest)

2. Extract tosu.exe to a `Folder`

3. Run `tosu.exe`

4. Go to [http://127.0.0.1:24050](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](https://youtu.be/3eW4TD_zwhM)

8. Have fun!

---




Features

---

- [x] All _**Gamemodes**_ are supported

- [x] Gosumemory _**compatible**_ api

- [X] Brand _**new api**_ for websocket

- [x] _**In-game**_ overlay (based on gosumemory closed overlay injection)

- [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)

---




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](https://github.com/tosuapp/tosu/wiki/How-to-enable-ingame-overlay)

---




Routes

---

gosu compatible api

- `/` - List of all counters you have

- `/json` - Example of `/ws` response

- `/ws` - [response example](https://github.com/tosuapp/tosu/wiki/v1-websocket-api-response)

- `/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](https://github.com/tosuapp/tosu/wiki/v2-websocket-api-response)

- `/websocket/v2/precise` - [response example](https://github.com/tosuapp/tosu/wiki/v2-precise-websocket-api-response)

- `/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](https://github.com/tosuapp/tosu/wiki/api-calculate-pp-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](https://discord.gg/WX7BTs8kwh) channel above in the `🔵 tosu` section

---




## Author

👤 **Mikhail Babynichev**

* Website: http://kotrik.ru

* Twitter: [@kotrik0](https://twitter.com/kotrik0)

* Github: [@KotRikD](https://github.com/KotRikD)

Special thanks to [@xxCherry](https://github.com/xxCherry), for providing memory reading library




## 🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/tosuapp/tosu/issues). You can also take a look at the [contributing guide](https://github.com/tosuapp/tosu/blob/master/CONTRIBUTING.md).




## 📝 License

Copyright © 2023-2024 [Mikhail Babynichev](https://github.com/KotRikD).


This project is [LGPL-3.0](https://github.com/tosuapp/tosu/blob/master/LICENSE) licensed.