/gosumemory

Cross-Platform memory reader for osu!

Primary LanguageGoGNU General Public License v3.0GPL-3.0

gosumemory

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:

FlyingTuna Alumetri Sotarks Mrekk Mathi RyuK

Usage

  1. Download the latest Release

    • 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)
  3. 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.

Included counters:

Click ME

Classic

Size: 550x300

By: Dartandr

OldClassic

Size: 550x300

By: Dartandr

DarkAndWhite

Size: 840x140

By: cyperdark

Kerli1 & Kerli2

Size (1)(2): 794x124 | 353x190

By: Dartandr

Luscent

Size: 1920x1080
Open-Source Implementation of Luscent's overlay. No elements were stolen. This is a remake. Please consider buying his version!

Remake by: Dartandr

MaximalLime

Size: 800x306

By: cyperdark

MinimalLime

Size: 640x130

By: cyperdark

TrafficLight

Size: 458x380

By: cyperdark

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, please use WebSocket instead.

How do I submit a pp counter?

Head over to static and create a pull request there. If it's good quality, then it will get approved and included in the next release.

Linux

You have two options. Either run native, but with sudo privileges, or through WINE. Please note that 32-Bit builds are experimental and don't have leaderboard data. They could contain crashes. Report them if you encounter any.

This project depends on:

Special Thanks to: