1
0
mirror of synced 2024-11-14 18:47:40 +01:00

Update changelog

Add info on duplicate bpms in the docs
This commit is contained in:
Stepland 2021-12-20 03:28:54 +01:00
parent e5cfe918fb
commit d088c74208
2 changed files with 54 additions and 1 deletions

View File

@ -1,5 +1,39 @@
# Changelog
## v1.0.0
- **Added**
- Symbolic times such as `t` and `l` in notes can also now be expressed as a tuple of 3 ints representing a mixed number
- Decimal numbers such as the offset or the bpm can now also be stored as strings to make it easier to preserve clean decimal notations
- **Changed**
- In note objects :
- `l` and `p` are now optional for tap notes
- `p` now uses the 6-notation
- `metadata` is now optional
- In the metadata object :
- `preview` can now also be a string, replacing `preview path`
- Renamed `song title` to `title`
- Renamed `music path` to `audio`
- Renamed `album cover path` to `jacket`
- All keys are now optional
- In the preview object :
- Renamed `position` to `start`
- Renamed `length` to `duration`
- In the chart object :
- `level` can now also be a decimal number, either as a number literal or as a string
- `level` is now optional
- `resolution` is now optional
- `resolution` now has an implicit default value of 240 in case the key is missing from the chart object
- Timing information is now stored in dedicated timing objects, one at the root of the memon file to act as a fallback, and one for each chart for per-chart timing info
- In the timing object :
- `offset` changed sign, it's now the time at which the first beat occurs in the audio file, instead of its opposite
- `offset` now has an implicit default value of 0 in case no timing object in the file defines it
- BPM changes can now be stored in the `bpms` array !
- **Removed**
- In the metadata object :
- `preview path` is now replaced with the polymorphic `preview`
- `offset` is now replaced by the offset in timing objects
- `BPM` is now replaced by the bpms in timing objects
## v0.3.0
- **Added**
- `metadata.preview path` allows audio preview files to be specified

View File

@ -95,8 +95,27 @@ If possible, non-integer values like `bpm` or `offset` should be manipulated usi
{ "bpm": "195.3" }
```
## Timing objects
## Multiple Timing Objects
### Duplicate BPMs
If there are several different bpms hapenning at the same beat in the `bpms` array, the last one is used.
For example, in this case :
```json
{
"bpms": [
{"beat": 0, "bpm": 120},
{"beat": 0, "bpm": 124}
]
}
```
The BPM on beat zero is set to 124
(multiple-timing-objects)=
### Multiple Timing Objects
memon version 1.0.0 introduced [timing objects](schema.md#timing) in two different places in the file, either at the root or in a chart.