Skip to content

Commit 97cc99c

Browse files
committed
docs: update release notes
1 parent 056ab1c commit 97cc99c

1 file changed

Lines changed: 78 additions & 0 deletions

File tree

docs/releases/release1_8.mdx

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,84 @@ title: v1.8
55
import { AlphaTab } from '@site/src/components/AlphaTab';
66
import { AlphaTexSample } from '@site/src/components/AlphaTexSample';
77

8+
## 1.8.1
9+
10+
This hotfix release brings following improvements
11+
12+
### Music Notation
13+
14+
#### render: respect diatonic scales for note placement
15+
16+
https://github.com/CoderLine/alphaTab/pull/2534
17+
18+
Up to this release alphaTab had rather a "chromatic spelling" when it comes to placing note heads and accidentals. This means it simply looked at the octave and
19+
applied accidentals accordingly where needed. This leads to non-optimal display of notes in various key signatures.
20+
21+
e.g. For a F# key signature we would show a F-note with a naturalize accidental instead of a E# note without any accidental (the # is applied via key signature).
22+
23+
<AlphaTexSample>{`
24+
\\title "F# Major Scale"
25+
\\ks f#
26+
\\tuning (G2 D2 A1 E1)
27+
\\clef bass
28+
:4
29+
2.4 4.4 1.3 2.3 |
30+
4.3 1.2 3.2 4.2 |
31+
4.2 3.2 1.2 4.3 |
32+
2.3 1.3 4.4 2.4
33+
`}</AlphaTexSample>
34+
35+
Thanks to [@tbreuss](https://github.com/tbreuss) for reporting this problem.
36+
37+
### Guitar Pro extensions
38+
39+
#### importer: correct GP5 bass clef detection (Guitar Pro 3-5)
40+
https://github.com/CoderLine/alphaTab/pull/2531
41+
42+
The improvements for detecting bass clefs in GP5 files caused a strange bug where we treated almost all
43+
files with a bass clef. This fix ensures the correct behavior.
44+
45+
#### importer: handle all Guitar Pro 5 percussion instruments
46+
https://github.com/CoderLine/alphaTab/pull/2537
47+
48+
As we updated the percussion handling 1.8.0 there broke some compatibility things with Guitar Pro 5.
49+
The latest Guitar Pro versions do not support all percussion instruments which existed in Guitar Pro 5 and alphaTab inherited that problem.
50+
51+
We added some workarounds to ensure we are compatible with these special percussion instruments.
52+
The affected instruments are mainly part of the "General Sound" MIDI standard and cover some rather rarely used instruments.
53+
54+
We map unsupported articulations to known ones and also handle fallback scenarios better.
55+
56+
Thanks [@LIUBINfighter](LIUBINfighter) for reporting this problem.
57+
58+
### Player
59+
60+
#### player: animate cursor to playback range end
61+
https://github.com/CoderLine/alphaTab/pull/2536
62+
63+
This is a small improvement in the cursor animation for alphaTab. Unless there are some repeats or jumps, the beat cursor typically
64+
animates from the start beat to the next beat. But if users select a part of the song to be played or the playback range is set via code,
65+
the cursor visually exceeds the selected range.
66+
67+
While technically it is not wrong to indicate that the playback reaches over to the next beat, it looks rather wrong from a UI/UX perspective.
68+
69+
With this improvement the cursor will now animate to the end of the selected beat in such cases.
70+
71+
Thanks [@AvaTheArchitect](https://github.com/AvaTheArchitect) for reporting this problem.
72+
73+
#### player: allow custom cursor handlers
74+
https://github.com/CoderLine/alphaTab/pull/2536
75+
76+
As part of the cursor animation improvements we also added the possibility to handle the cursor placement in a custom way.
77+
This extension point is similar to the `IScrollHandlers` we added (see below). The new `ICursorHandler` which can be set via `api.customCursorHandler`
78+
allows custom placing of the bar and beat cursor. It is currently tightly coupled to the way alphaTab handles the cursor placement.
79+
80+
If you are implementing a custom extended cursor (e.g. with more complex UI elements) you can now handle all the placement and animation logic in a custom implementation.
81+
You can start your own implementation by looking at our default implementations in the alphaTex codebase and work your way from there.
82+
83+
Likely this API still needs some fine-tuning and extensions, but considering this is a patch release, it should allow handling most important bits.
84+
85+
886
## 1.8.0
987

1088
This has been one of the fastest alphaTab releases so far. Within 1 month we added quite a list of improvements and fixes.

0 commit comments

Comments
 (0)