https://github.com/ppy/osu-performance-datasets-generator
https://github.com/ppy/osu-performance-datasets-generator
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ppy/osu-performance-datasets-generator
- Owner: ppy
- License: mit
- Created: 2022-07-08T17:00:13.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T16:54:52.000Z (about 2 years ago)
- Last Synced: 2025-01-31T13:25:06.751Z (over 1 year ago)
- Language: Shell
- Size: 25.4 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# osu-performance-datasets-generator [](https://discord.gg/ppy)
Set of scripts generating SQL and .osu dumps from production for osu-performance developers to use locally.
These scripts are for internal use only. Please find the dumps on https://data.ppy.sh.
# Usage
Run `./dump_all.sh` monthly with the following environment variables:
- beatmaps S3 bucket: `OSU_DOWNLOAD_AWS_ACCESS_KEY_ID`, `OSU_DOWNLOAD_AWS_SECRET_ACCESS_KEY`, `OSU_DOWNLOAD_S3_BUCKET`, `OSU_DOWNLOAD_S3_ENDPOINT`
- data.ppy.sh S3 bucket: `DUMPS_UPLOAD_AWS_ACCESS_KEY_ID`, `DUMPS_UPLOAD_AWS_SECRET_ACCESS_KEY`, `DUMPS_UPLOAD_S3_BUCKET`, `DUMPS_UPLOAD_S3_ENDPOINT`, `DUMPS_UPLOAD_S3_ACL` (optional)
- osu! database: `DATABASE_HOST`, `DATABASE_USER`, `DATABASE_PASSWORD` (optional)
For DigitalOcean Spaces support, `DUMPS_UPLOAD_S3_ENDPOINT` and `DUMPS_UPLOAD_S3_ACL` need different values, eg `DUMPS_UPLOAD_S3_ENDPOINT=https://nyc3.digitaloceanspaces.com` and `DUMPS_UPLOAD_S3_ACL=public-read`.
For s3-nginx-proxy purge support, `DUMPS_UPLOAD_S3_PUBLIC_URL` and `DUMPS_UPLOAD_S3_PURGE_AUTHORIZATION_KEY` need to be set (optional).
~16GB of free disk space is recommended (estimated).
# Contributing
Contributions can be made via pull requests to this repository. We hope to credit and reward larger contributions via a [bounty system](https://www.bountysource.com/teams/ppy). If you're unsure of what you can help with, check out the [list of open issues](https://github.com/ppy/osu-performance-datasets-generator/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.
# Licence
The osu! client code, framework, and server-side components are licensed under the [MIT licence](https://opensource.org/licenses/MIT). Please see [the licence file](LICENCE) for more information. [tl;dr](https://tldrlegal.com/license/mit-license) 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.