updated changelog

This commit is contained in:
MaxOhn
2022-07-05 22:59:18 +02:00
parent 308c25a24c
commit 47ddaa83bc
2 changed files with 4 additions and 4 deletions
+2 -2
View File
@@ -1,10 +1,10 @@
## Upcoming
# v0.6.0 (2022-07-05)
- Updated to [PyO3 v0.16](https://github.com/PyO3/pyo3/blob/main/CHANGELOG.md#0165---2022-05-15) from v0.15
- Updated to [rosu-pp v0.6](https://github.com/MaxOhn/rosu-pp/blob/main/CHANGELOG.md#v060-2022-07-05)
- Added the class `GameMode` to serve as enum e.g. `GameMode.Taiko`
- `ScoreParams` now have an additional field `mode: Optional[GameMode]` which can be used to convert to other modes
# v0.5.2 (2022-06-14)
## v0.5.2 (2022-06-14)
- Bumped patch version of dependencies, including a [rosu-pp](https://github.com/MaxOhn/rosu-pp/blob/main/CHANGELOG.md#v052-2022-06-14) update
## v0.5.1 (2022-03-22)
+2 -2
View File
@@ -24,6 +24,7 @@ calculator.set_od(9.2)
```
mode: Optional[GameMode],
specify for scores on convert maps, default to the map's native mode
available enum variants are GameMode.Osu, GameMode.Taiko, GameMode.Catch, and GameMode.Mania
mods: Optional[int],
bit value for mods, defaults to 0 (NM) see https://github.com/ppy/osu-api/wiki#mods
acc: Optional[float],
@@ -59,7 +60,7 @@ params = ScoreParams(acc = 98.76)
```
3) The last step is to provide the `ScoreParams` to the `Calculator` through the function `calculate`. This function takes one argument which must be either a single `ScoreParams` or an `Iterable[ScoreParams]`, i.e. anything that python can iterate over like a list, set, ...
## Example
## Example
```py
from rosu_pp_py import Calculator, ScoreParams
@@ -68,7 +69,6 @@ calculator = Calculator('./maps/1980365.osu')
params1 = ScoreParams(
mods = 8 + 16, # HDHR
mode = GameMode.Catch,
acc = 97.89,
nMisses = 13,
combo = 1388,