31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
|
# ABCUnity
|
||
|
|
This library renders a subset of [ABC Music Notation](http://abcnotation.com/) in Unity. It is built on the [ABCSharp](https://github.com/matthewcpp/abcsharp) parsing library.
|
||
|
|
|
||
|
|
### Installation
|
||
|
|
The easiest way to to use the library is to download the repo as a zip archive and place the extracted directory into your Assets folder. Optionally the repo can be included as a git submodule in your project.
|
||
|
|
This project requires the installation of the basic TextMeshPro asset package.
|
||
|
|
|
||
|
|
### Basic Usage
|
||
|
|
The included sample scene shows basic layout usage.
|
||
|
|
The `ABCLayout` prefab serves as a top level container for all the sprites needed to display the score. The layout will attempt to fill as much as the area defined by the object's RectTransform.
|
||
|
|
Abc code is rendering using the `LoadString`, `LoadStream`, or `LoadFile` methods on the `ABCUnity.Layout` class.
|
||
|
|
Individual items can have their color set using the `SetItemColor` method.
|
||
|
|
|
||
|
|
### Example
|
||
|
|
The following text in ABC format:
|
||
|
|
|
||
|
|
```
|
||
|
|
X:1
|
||
|
|
M:C
|
||
|
|
L:1/4
|
||
|
|
V:1
|
||
|
|
V:2 clef=bass
|
||
|
|
K:C
|
||
|
|
[V:1] !5!c>_BAG | FGAF | !2!G/2A/2!4!_B/2G/2 A>G| !1!F !3!E !1!F2 |
|
||
|
|
[V:2] !3!!5![F,A,]4 | [F,A,]4 | !2!!4![G,_B,]2 !3!!5![F,A,]2| z2 [F,A,]2 |
|
||
|
|
[V:1] !5!c>_BAG | FGAF | G/2A/2!4!_B/2G/2 A>G| !1!F !3!E !1!F2 | Z |
|
||
|
|
[V:2] [F,A,]4 | !3!!5![F,A,]4 | !2!!4![G,_B,]2 [F,A,]2| z2 [F,A,]2 | !4!G, > A, !2!_B, G, |
|
||
|
|
```
|
||
|
|
Appears in the game engine as:
|
||
|
|
|
||
|
|
[](https://matthewcpp.github.io/assets/images/score.png)
|