marc3842h/shiro repository overview

⁠Shiro

Shiro is a server-side implementation of the osu! cho protocol. It delivers unmatched performance and features an accurate implementation of the protocol.

It outperforms Ripple, Gigamons and even Bancho itself. In terms of implementation accuracy, Shiro's implementation is more accurate than both of Ripple and Gigamons.

Unlike other implementations, Shiro does not seperate Bancho and the Score Submission server.

⁠Features

Shiro handles all major aspects of a fully functioning osu! server, which includes:

• Client login
• IRC-less chat & chat bot
• Leaderboards
• Multiplayer
• Online user listing with their presence
• osu!direct
• osu!tourney
• Rankings
• Replays
• Score submission
• Screenshots
• Spectating

⁠Documentation

Documentation such as installation and usage of Shiro are available on the Wiki⁠.

⁠Docker

Shiro is available as ready-to-use Docker container, including its modules. Please visit the Wiki⁠ for more information on how to use the container.

⁠Contributing

We welcome all contributions to Shiro and its modules.

If you have found a issue with Shiro, feel free to open a issue⁠ describing the issue in detail and how it occurred.

Code and documentation contributions can be made using Pull requests⁠. Please make sure you conform to the general coding style of Shiro.

⁠License

Shiro is licensed under the GNU Affero General Public License, version 3.0. Please visit the LICENSE.txt⁠ file for the license and a summary of DOs & DON'Ts.

Third party libraries in the src/thirdparty may be licensed under a different, but AGPL-3.0 compatible license. Please visit the corresponding files and their associated license for more information.

In the creation of this software, the leaked 2016 source code of osu! and osu!Bancho as well as Ripple and HOPEless were used as reference.

The branding osu! and ppy are protected by trademark law. Fair use applies.