mirror of
https://github.com/ppy/osu-tools.git
synced 2025-06-07 23:07:01 +09:00
79 lines
5.4 KiB
Markdown
79 lines
5.4 KiB
Markdown
# osu!tools
|
|
|
|
[](https://github.com/ppy/osu-tools/actions/workflows/ci.yml)
|
|
[](https://www.codefactor.io/repository/github/ppy/osu-tools)
|
|
[](https://discord.gg/ppy)
|
|
|
|
Tools for [osu!](https://osu.ppy.sh).
|
|
|
|
# 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](https://github.com/ppy/osu-infrastructure/wiki/Star-Rating-and-Performance-Points) for the latest information.
|
|
|
|
# Requirements
|
|
|
|
- A desktop platform with the [.NET 8.0 SDK](https://dotnet.microsoft.com/download) installed.
|
|
- When working with the codebase, we recommend using an IDE with intelligent code completion and syntax highlighting, such as the latest version of [Visual Studio](https://visualstudio.microsoft.com/vs/), [JetBrains Rider](https://www.jetbrains.com/rider/) or [Visual Studio Code](https://code.visualstudio.com/) with the [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) and [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) plugin installed.
|
|
- These instructions assume you have the the [CLI git client](https://git-scm.com/) installed, but any other GUI client such as GitKraken will suffice.
|
|
|
|
# Getting Started
|
|
|
|
## I just want to run it
|
|
- Clone the repository (`git clone https://github.com/ppy/osu-tools`)
|
|
- Navigate to each tool's directory (i.e. `cd PerformanceCalculator`) and follow the instructions listed in the tool's README.
|
|
- [PerformanceCalculator](https://github.com/ppy/osu-tools/blob/master/PerformanceCalculator/README.md) - A tool for calculating the difficulty of beatmaps and the performance of replays.
|
|
- [PerformanceCalculatorGUI](https://github.com/ppy/osu-tools/blob/master/PerformanceCalculatorGUI/README.md) - A GUI tool for calculating the difficulty of beatmaps, changes in profile scores and leaderboards.
|
|
|
|
## I want to make changes
|
|
Most relevant code is in the main [ppy/osu](https://github.com/ppy/osu) repository. To make any meaningful changes you will likely need to edit that as well.
|
|
|
|
- Clone all relevant repos into the same directory
|
|
```shell
|
|
git clone https://github.com/ppy/osu-tools
|
|
git clone https://github.com/ppy/osu
|
|
```
|
|
- If you're planning to work on the difficulty and/or performance calculation changes you will need to use the `pp-dev` branch of the `osu` repository
|
|
```shell
|
|
cd osu
|
|
git checkout -b pp-dev origin/pp-dev
|
|
```
|
|
- Run the `./UseLocalOsu.ps1` powershell script (or `./UseLocalOsu.sh`) to use your local copy of ppy/osu
|
|
|
|
### Code analysis
|
|
|
|
Before committing your code, please run a code formatter. This can be achieved by running `dotnet format` in the command line, or using the `Format code` command in your IDE.
|
|
|
|
We have adopted some cross-platform, compiler integrated analyzers. They can provide warnings when you are editing, building inside IDE or from command line, as-if they are provided by the compiler itself.
|
|
|
|
JetBrains ReSharper InspectCode is also used for wider rule sets. You can run it from PowerShell with `.\InspectCode.ps1`. Alternatively, you can install ReSharper or use Rider to get inline support in your IDE of choice.
|
|
|
|
## I want to run someone else's changes
|
|
|
|
- Clone all relevant repos into the same directory
|
|
```shell
|
|
git clone https://github.com/ppy/osu-tools
|
|
git clone https://github.com/ppy/osu
|
|
```
|
|
- Navigate to `osu` repository and [checkout](https://stackoverflow.com/a/14383288) version you want to run
|
|
```shell
|
|
cd osu
|
|
git remote add smoogi https://github.com/smoogipoo/osu.git
|
|
git fetch smoogi branch_name
|
|
git checkout -b branch_name smoogi/branch_name
|
|
```
|
|
- Run the `./UseLocalOsu.ps1` powershell script (or `./UseLocalOsu.sh`) to use your local copy of ppy/osu
|
|
|
|
|
|
# Contributing
|
|
|
|
When it comes to contributing to the project, the two main things you can do to help out are reporting issues and submitting pull requests. You might want to refer to the [contributing guidelines](https://github.com/ppy/osu/blob/master/CONTRIBUTING.md) in the main osu! repository to understand how to help in the most effective way possible.
|
|
|
|
We love to reward quality contributions. If you have made a large contribution, or are a regular contributor, you are welcome to [submit an expense via opencollective](https://opencollective.com/ppy/expenses/new). If you have any questions, feel free to [reach out to peppy](mailto:pe@ppy.sh) before doing so.
|
|
|
|
# Licence
|
|
|
|
*osu!*'s code, framework, and tools 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.
|
|
|
|
Please also note that game resources are covered by a separate licence. Please see the [ppy/osu-resources](https://github.com/ppy/osu-resources) repository for clarifications.
|