EZPPFarm/akatsuki-pp-py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated readme hyperlinks

Browse Source
This commit is contained in:
MaxOhn
2024-03-25 14:24:06 +01:00
parent f7c41a516f
commit 757b807f54
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -14
View File
@@ -8,21 +8,21 @@ As such, its performance is much faster than a native python library.
## Usage
The library exposes multiple classes:
- [`Beatmap`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L23-L105): Parsed `.osu` file
- [`GameMode`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L5-L13)
- [`Beatmap`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L23-L105): Parsed `.osu` file
- [`GameMode`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L5-L13)
- Calculators
- [`Difficulty`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L107-L250): Class to calculate difficulty attributes, strains, or create gradual calculators
- [`Performance`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L252-L433): Performance attributes calculator
- [`GradualDifficulty`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L435-L459): Calculator to calculate difficulty attributes after each hitobject
- [`GradualPerformance`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L461-L487): Calculator to calculator performance attributes after each hitresult
- [`BeatmapAttributesBuilder`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L489-L660): Beatmap attributes calculator
- [`Difficulty`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L107-L255): Class to calculate difficulty attributes, strains, or create gradual calculators
- [`Performance`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L257-L443): Performance attributes calculator
- [`GradualDifficulty`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L445-L469): Calculator to calculate difficulty attributes after each hitobject
- [`GradualPerformance`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L471-L497): Calculator to calculator performance attributes after each hitresult
- [`BeatmapAttributesBuilder`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L499-L621): Beatmap attributes calculator
- Results
- [`DifficultyAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L662-L849)
- [`Strains`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L924-L994)
- [`PerformanceAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L851-L922)
- [`BeatmapAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L996-L1026)
- [`HitResultPriority`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L15-L21): Passed to `Performance`, decides whether specified accuracy should be realized through good or bad hitresults
- [`ScoreState`](https://github.com/MaxOhn/rosu-pp-py/blob/79a5af50dc263d5c36246691010290b5f2048721/rosu_pp_py.pyi#L615-L660): Hitresults and max combo of a score, found in `PerformanceAttributes` and passed to gradual calculators
- [`DifficultyAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L670-L857)
- [`Strains`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L932-L1002): Strain values of a difficulty calculation, suitable to plot difficulty over time
- [`PerformanceAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L859-L930)
- [`BeatmapAttributes`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L1004-L1034)
- [`HitResultPriority`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L15-L21): Passed to `Performance`, decides whether specified accuracy should be realized through good or bad hitresults
- [`ScoreState`](https://github.com/MaxOhn/rosu-pp-py/blob/a34cc3a1c239da3174986e78c849f5c2a23a8746/rosu_pp_py.pyi#L623-L668): Hitresults and max combo of a score, found in `PerformanceAttributes` and passed to gradual calculators
## Example
@@ -94,7 +94,7 @@ diff = rosu.Difficulty(
# Gradually calculating *difficulty* attributes
gradual_diff = diff.gradual_difficulty(map)
for i, attrs in enumerate(gradual_diff):
for i, attrs in enumerate(gradual_diff, 1):
print(f'Stars after {i} hitobjects: {attrs.stars}')
# Gradually calculating *performance* attributes