Skip to content

bitknox/OsuNP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OsuNowPlaying

A program to display what you are currently playing on your osu! profile or elsewhere.

Installation

  • Head to osu.bitknox.me and sign in
  • Click the download button to download all the required programs/config files
  • Extract the zip file and run the program

Usage

When the program is running the link to your image will be located at: https://osu.bitknox.me/playing?uId=${YOUR_ID} You can add multiple parameters to the URL.

Argument Value Description
uId id Your profile ID (required)
width number Set the width of the image in pixels
type svg/png Set the image file type

Example: https://osu.bitknox.me/playing?uId=6971313&width=500&type=png

The ID can be found by heading to your osu! profile and copying from the URL.

A redirect URL to the current map is also available https://osu.bitknox.me/redirect?uId=${YOUR_ID}

Example(updates live)

This is an image

Building from source

Prerequisites

  • Working installation of rust/cargo

Building

git clone https://github.com/bitknox/OsuNP.git
cd OsuNP
cargo build --realease 

To build it yourself, you will need to download gosumemory and edit the code to point to the desired exe location.

Further, you need to create a token.txt and place it beside the executable or edit the source. (token can be found by heading to osu.bitknox.me)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Acknowledgements

gosumemory for making this project possible

TeQnix for helping with design changes

Matte for ideas and motivating me to work on the project

License

GPL-3.0

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages