Skip to main content

A python library that emulates the osu! stable client

Project description

osu.py

Python 3.9+ License

osu.py is a python library that emulates part of the online functionality of the osu! stable client. This is still a work in progress, but I decided to release it anyways.

IMPORTANT: Use this library at your own risk! I am not responsible for anything that can happen to your account. If you want to test it out on a private server, you can set the server attribute when initializing the client.

You can install this package with pip:

pip install osu

Or build it manually:

git clone https://github.com/Lekuruu/osu.py.git
cd osu.py
python setup.py install

Features

  • Receiving player stats
  • Sending/Receiving chat messages
  • Up to 12 clients (Tournament Client)
  • Spectating other players
  • Documentation
  • Multiplayer

Example

Here is a small example of how to use this package:

from osu.constants import ServerPackets
from osu import Game

# Initialize the game class
game = Game(
  USERNAME,
  PASSWORD
)

# Simple message handler
@game.events.register(ServerPackets.SEND_MESSAGE)
def on_message(sender, message, target):
  if message.startswith('!ping'):
    sender.send_message('pong!')

# Run the game
game.run()

This project is also a good example.


If you have any questions, feel free to contact me on discord: lekuru

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osu-1.0.4.tar.gz (30.1 kB view hashes)

Uploaded Source

Built Distribution

osu-1.0.4-py3-none-any.whl (34.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page