Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/l3lackShark/gosumemory
Cross-Platform memory reader for osu!
https://github.com/l3lackShark/gosumemory
counter linux memory osu pp reader websocket windows
Last synced: 4 days ago
JSON representation
Cross-Platform memory reader for osu!
- Host: GitHub
- URL: https://github.com/l3lackShark/gosumemory
- Owner: l3lackShark
- License: gpl-3.0
- Created: 2020-02-17T07:22:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T13:05:36.000Z (11 months ago)
- Last Synced: 2024-08-01T19:45:43.560Z (3 months ago)
- Topics: counter, linux, memory, osu, pp, reader, websocket, windows
- Language: Go
- Homepage:
- Size: 68.5 MB
- Stars: 672
- Watchers: 7
- Forks: 61
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-osu-tournaments - gosumemory! - Cross-Platform memory reader. (Community Resources / Tools)
README
Yet another memory reader for osu! Supports both Linux and Windows. (**requires sudo on Linux** though since only root can read /proc)
Build custom pp counters with ease!\
You can contact us here: https://discord.gg/8enr4qD
# Real-World examples:
[](https://youtu.be/neHcOLycieE)
[](https://www.twitch.tv/flyingtuna/clip/TransparentObliviousHawkAMPEnergyCherry)
[](https://mega.nz/file/QV1gTKoI#j1QRjDkrjnFvIhyb9JuGi3g_0XZCFzXEXz9PKWcxgmI)
[](https://mega.nz/file/oAlmlQoY#8ABeJPGboMLgCiaY5vR21HX2Km--_jiwqRHOmUJvVmg)
[](https://mega.nz/file/UZsEUKDK#Ji3JAUr8_04Q7u0RG1BAJFGzZ2-CRhRZkEQqdXVrv60)
[](https://mega.nz/file/5dsk1QJD#noUKykU5qJYv53I2DPZ7PY2CIQOftS1ufqzOh4rqOb8)
[](https://mega.nz/file/dY8k1YyZ#1Phdta1CzxXDotjtllUKsZunnCdliYlQ1VrZ_BNaNIs)
# Usage
1. [Download the latest Release](https://github.com/l3lackShark/gosumemory/releases/latest)
* Unzip files anywhere
> In the root folder of the program, you can find the **static** directory. It contains all of the available counters. Those are getting streamed via HTTP-File server
2. Run gosumemory & osu!
* Visit this link in your browser: http://localhost:24050 and choose the counter that you like.
* Add a browser source in OBS (Width and Height could be found in the **Included counters** spoiler)
4. If using built-in counters covers all of your needs, then you are done here.
> **Please note that auto-updates only cover the executable itself, however, if a new counter gets released, we will mention it in the Release Notes.**\
> If you want to make your own, just create a new directory in the *static* folder.
# Does this work in-game?
Yes! see [this](https://github.com/l3lackShark/gosumemory/wiki/GameOverlay)
# Included counters:
Click ME
### InGame1
> Size: 240x133\
\
By: [Dartandr][1]
### InGame2
> Size: 370x120\
\
By: [Dartandr][1]
### InGame3
> Size: 150x70\
\
By: [Dartandr][1]
### reComfortaa
> Size: 1152x245\
> *Song Selection*\
\
>*Gameplay*\
\
By: [Xynogen][6]
### MonokaiPane
> Size: 512x150\
> *Song Selection*\
\
>*Gameplay 1*\
\
>*Gameplay 2*\
\
By: Xynogen
### WaveTournament
> Size: 1920x1080\
> *Chat + Warmup (Team score disabled) view*\
\
> *Chat + Warmup (Team score disabled) view*\
\
> *Gameplay*\
\
By: [VictimCrasher][4]
### Classic
> Size: 550x300\
\
By: [Dartandr][1]
### OldClassic
> Size: 550x300\
\
By: [Dartandr][1]
### Simplistic
> Size: 750x150\
> *Song Selection*\
\
>*Gameplay 1*\
\
By: [jassper0][5]
### DarkAndWhite
> Size: 840x140\
\
By: [cyperdark][2]
### Kerli1 & Kerli2
> Size (1)(2): 794x124 | 353x190\
\
By: [Dartandr][1]
### Luscent
> Size: 1920x1080\
Open-Source Implementation of [Siae's Luscent][3] overlay. No elements were stolen. This is a remake. Please [consider buying](https://gumroad.com/l/Luscent) her version!\
\
Remake by: [Dartandr][1]
### VictimCrasherCompact
> Size: 560x150\
> *Song Selection*\
\
>
> *Gameplay*\
\
By: [VictimCrasher][4]
### VictimCrasherOverlay
> Size: 1920x1080\
\
By: [VictimCrasher][4]
### UnstableRate
> Size: 300x100\
Just a plain number that shows current UnstableRate, could be useful if you want to put it above your UR Bar.\
By: [Dartandr][1]
### MaximalLime
> Size: 800x306\
\
By: [cyperdark][2]
### MinimalLime
> Size: 640x130\
\
By: [cyperdark][2]
### TrafficLight
> Size: 458x380\
\
By: [cyperdark][2]
[1]: https://github.com/Dartandr
[2]: https://github.com/cyperdark
[3]: https://twitter.com/mk_cou/status/1464208290158501894
[4]: https://github.com/VictimCrasher
[5]: https://github.com/jassper0
[6]: https://github.com/Xyn0gen
# How does it work?
gosumemory streams WebSocket data to **ws://localhost:24050/ws** that you can use in any programming language to develop a frontend. We recommend JavaScript though, as it's much easier to make something pretty with the Web framework. All of the included counters are good starting points. There is also http://localhost:24050/json that you can open in a web browser to see the available data. We strongly recommend against sending GET requests to that address in production, please **use WebSocket instead**.
**[Example JSON and a little wiki of it's values](https://github.com/l3lackShark/gosumemory/wiki/JSON-values)**
# What if I don't know any programming languages but still want to output data to OBS?
https://www.youtube.com/watch?v=8ApXBEO5bes
# How do I submit a pp counter?
Head over to [static](https://github.com/l3lackShark/static) and create a pull request there. If it's good quality, then it will get approved and included in the next release.
# Tournament Client
When operating in tourney mode, real-time pp counters for each client, leaderboard and grades don't work. Each gameplay object is sorted by tournament client "id", "menu" object is a tournament manager (state 22).
**Tournament mode works only with Cutting Edge tourney client and is not supported on Linux.**
# Linux
You have two options. Either run native, but with sudo privileges, or through WINE.
Please note that Linux builds are not well tested and could contain crashes. Report them if you encounter any.
# Consider supporting
# This project depends on:
* [cast](https://github.com/spf13/cast)
* [gorilla-websocket](https://github.com/gorilla/websocket)
* [open](https://github.com/skratchdot/open-golang)
* [semver](https://github.com/blang/semver)
* [selfupdate](https://github.com/rhysd/go-github-selfupdate)
* [pretty-print](https://github.com/k0kubun/pp)
* [mp3](https://github.com/tcolgate/mp3)
* [go-windows](https://github.com/elastic/go-windows)
# Special Thanks to:
* [Piotrekol](https://github.com/Piotrekol/) and his [ProcessMemoryDataFinder](https://github.com/Piotrekol/ProcessMemoryDataFinder) for most of the memory signatures
* [Francesco149](https://github.com/Francesco149) and his [oppai-ng](https://github.com/Francesco149/oppai-ng) for the pp calculator that we use
* [tdeo](https://github.com/tadeokondrak) for the [Memory Signature Scanner](https://github.com/l3lackShark/gosumemory/tree/master/mem) package
* [omkelderman](https://github.com/omkelderman) for helping out with the [db](https://github.com/l3lackShark/gosumemory/tree/master/db) package
* [jamuwu](https://github.com/jamuwu/osu-strain) and his [osu-strain](https://github.com/jamuwu/osu-strain) for difficulty strain logic
* [cyperdark](https://github.com/cyperdark) and [Dartandr](https://github.com/Dartandr) for frontend designs
* [KotRik](https://github.com/KotRikD) for making an [OBS Script](https://github.com/l3lackShark/gosumemory-helpers/blob/master/gosumemory-reader.py) and porting legacy counters