Giter Club home page Giter Club logo

rosu-memory's Introduction

rosu-memory

Lightweight, cross-platform and simple osu! memory reader written in Rust

Usage

Windows

There two primary methods

  1. By setting environment value in windows settings (recommended):
    1. Type Edit the system environment variables in your search bar, press enter
    2. In opened window click Environment variables at the very bottom
    3. Click New... under System Variables
    4. In Variable name type OSU_PATH
    5. In Variable value type your path to osu! folder
    6. Click Ok
    7. Now you can start rosu-memory simply by double clicking rosu-memory.exe file!
  2. By editing batch file:
    1. Open windows_start.bat file in your preferred text editor
    2. Change set OSU_PATH=%HOMEDRIVE%%HOMEPATH%\AppData\Local\osu! to set OSU_PATH=<YOUR OSU PATH>
    3. Start rosu-memory by opening windows_start.bat file (Note: rosu-memory.exe and windows_start.bat should be in the same folder)

Linux

1. Download binary or compile it by yourself
2. Set OSU_PATH environment variable or use `--osu_path` argument

Command line arguments

Options:
  -o, --osu-path <OSU_PATH>  Path to osu! folder [env: OSU_PATH=]
  -i, --interval <INTERVAL>  Interval between updates in ms [default: 300]
  -h, --help                 Print help

Differences between gosumemory and tosu

  1. Small binary size

    rosu-memory gosumemory (v 1.3.8) tosu (v 1.3.0)
    Windows 1.2 MB 21 MB 35 MB
    Linux 1.9 MB 21.2 MB Does not support
  2. Low RAM usage. Since Rust is compiled language and doesn't have any garbage collection (opposed to gosu and tosu) it has very low (almost minimal) ram usage.

  3. Low CPU usage

  4. Statically linked binary, no runtime dependencies required (except win32 and glibc)

  5. Can be compiled using musl libc!

  6. Cross-platform

  7. Different JSON schema. Small disadvantage, but rosu-memory outputs slightly different JSON than tosu and gosu. Please consider this when porting your counter to rosu-memory. (See examples folder :) )

What is not implemented yet

  1. Not all osu! data is present yet. But everything that is required to make simple counter is present :)
  2. Strains graph
  3. Any tournament stuff
  4. Unstable rate
  5. And many others :)

JSON Schema

{
  "artist": "",
  "folder": "",
  "beatmap_file": "",
  "playtime": 0,
  "status": 0,
  "ar": 0,
  "cs": 0,
  "hp": 0,
  "od": 0,
  "hit_300": 0,
  "hit_100": 0,
  "hit_50": 0,
  "hit_geki": 0,
  "hit_katu": 0,
  "hit_miss": 0,
  "combo": 0,
  "max_combo": 0,
  "mode": 0,
  "slider_breaks": 0,
  "current_pp": 0,
  "fc_pp": 0,
  "passed_objects": 0,
  "menu_mods": 0,
  "mods": 0,
  "plays": 0
}

rosu-memory's People

Contributors

486c avatar uzervlad avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.