Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 2.49 KB

README.md

File metadata and controls

45 lines (27 loc) · 2.49 KB

osu-queue-score-statistics-processor dev chat

An osu-queue-processor designed to handle updating general statistics updates from user scores.

Current Versions

This is part of a group of projects which are used in live deployments where the deployed version is critical to producing correct results. The master branch tracks ongoing developments. If looking to use the correct version for matching live values, please consult this wiki page for the latest information.

Contributing

Contributions can be made via pull requests to this repository. We hope to credit and reward larger contributions via a bounty system. If you're unsure of what you can help with, check out the list of open issues.

Note that while we already have certain standards in place, nothing is set in stone. If you have an issue with the way code is structured; with any libraries we are using; with any processes involved with contributing, please bring it up. I welcome all feedback so we can make contributing to this project as pain-free as possible.

Environment Setup

BYO

To setup a testing environment, the minimum requirements are having a MySQL instance available at localhost:3306 and a redis instance available at localhost:6379.

Make sure all data is expendable. It may will be nuked without remorse.

Docker

You can setup an environment and have it map to the correct localhost ports:

docker-compose up -d

You can stop the environment using:

docker-compose down

Alternatively, you can stop and remove all volumes (ie. nuke your test database) using:

docker-compose down -v

Licence

The osu! client code, framework, and server-side components are licensed under the MIT licence. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.

Please note that this does not cover the usage of the "osu!" or "ppy" branding in any software, resources, advertising or promotion, as this is protected by trademark law.