Skip to content

RealistikOsu/pep.py

 
 

Repository files navigation

pep.py

The RealistikOsu realtime server!

image

What does it do?

This portion of the RealistikOsu manages all of the real-time, packet related portions of the Bancho protocol. This includes but is not limited to:

  • Logging in
  • Chat
  • Multiplayer
  • Spectator
  • Server Bot (RealistikBot)

Why is our fork better?

This fork of pep.py has been developed specifically to suit the need of RealistikOsu. With the rapid growth of the server, more and more demand has been placed on us in regards of features alongside performance. The original repo features a large quantity of fatal flaws alongside performance hogs, and through our usage of the software, we have solved a majority of those issues.

  • Fixed multiplayer
  • MASSIVE OPTIMISATIONS (your database will thank you)
  • Relax and Autopilot support
  • Extended Redis API
  • Extended 3rd party API support
  • Customised HWID system
  • Extended in-game bot commands
  • Python 3.9 support!

Requirements

To run pep.py, there is an list of requirements to ensure the server runs at all.

  • Python >=3.6
  • RealistikOsu MySQL Database
  • Cython + GCC
  • Linux (preferably Ubuntu 18.04)

Notes for potential users

If you are planning on using our fork of pep.py, there is a multitude of things to consider that are unique to our variant

  • Low reliance on userutils for performance reasons.

The entire userutils module promotes inefficient use of the database. This is especially bad on established servers with large databases, where the cost of each query becomes more and more expensive with every user. This appends unnecessary stress on the database and as a consequence, the server as a whole.

  • Tendency to hardcode things.

I, RealistikDash, have a bad habit of hardcoding things. While this is usually fine for the intended application of this, being used on RealistikOsu, it may be a pain to scan through the code if you are attempting to run this on your server. In this scenario, I would advise searching through constants/rosuprivs.py and constants/serverPackets.py for any references you would like to change.

  • Private database

As expected, our variant uses our own database schema. A copy of our database schema (designed for use with USSR) can be found here!

Due to the old nature of the origin code, the age of the modules is quite large. This means that we do not benefit from any improvements, bugfixes or any other quality of life improvements of any new module updates. This is an issue with the whole Python based Ripple stack, and is not an exclusive to RealistikOsu pep.py. This issue is however planned on being addressed soon.

  • No IRC

Due to the lack of usage from the RealistikOsu community, the entire IRC server has essentially been nuked. This is because while not being used, it still took up a thread and served as dead code in the repo. Not much else to say other than that it was pretty much never used.

About

RealistikOsu's realtime server!

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 95.6%
  • Cython 4.4%