Skip to content

Commit

Permalink
Fix article bookmarks
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBoxyBear committed Jan 19, 2024
1 parent 2cfc418 commit 4afe494
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Docs/articles/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ syncTrack.TimeSignatures.RemoveUnneeded();
ChartTools includes other utilities for various purposes. [Learn more](tools.md).

## Writing files
Finally, changes can be saved to a file using [Song.ToFile](~/api/ChartTools.Song.yml#ChartTools_Song_ToFile_System_String_ChartTools_IO_Chart_Configuration_ChartWritingConfiguration_), with the format determined by the file extension.
Finally, changes can be saved to a file using [Song.ToFile](~/api/ChartTools.Song.yml#ChartTools_Song_ToFile_System_String_ChartTools_IO_Configuration_WritingConfiguration_), with the format determined by the file extension.

```csharp
song.ToFile("output.chart", <WritingConfiguration>);
Expand Down
2 changes: 1 addition & 1 deletion Docs/articles/lyrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ phrase.Syllables.Add(new Syllable(0, new VocalsPitch(3 << 4 | VocalsPitch.D));
> **NOTE**: Clone Hero also supports color data in the text. This is currently not supported in ChartTools and special characters related to color data will appear as part of [DisplayedText](~/api/ChartTools.Lyrics.Syllable.yml#ChartTools_Lyrics_Syllable_DisplayedText).

## Phrases
Unlike other chords, [phrases](~/api/ChartTools.Lyrics.Phrase.yml) define a length and end position in addition to a start position. The end position is driven by the end of the last syllable but can be replaced by setting the [LengthOverride](~/api/ChartTools.Lyrics.Phrase.yml#ChartTools_Lyrics_Phrase_LengthOverride) property. Phrases also define [RawText](~/api/ChartTools.Lyrics.Syllable.yml#ChartTools_Lyrics_Phrase_RawText) and [DisplayedText](~/api/ChartTools.Lyrics.Syllable.yml#ChartTools_Lyrics_Phrase_DisplayedText) properties which combine the text from their syllables.
Unlike other chords, [phrases](~/api/ChartTools.Lyrics.Phrase.yml) define a length and end position in addition to a start position. The end position is driven by the end of the last syllable but can be replaced by setting the [LengthOverride](~/api/ChartTools.Lyrics.Phrase.yml#ChartTools_Lyrics_Phrase_LengthOverride) property. Phrases also define [RawText](~/api/ChartTools.Lyrics.Phrase.yml#ChartTools_Lyrics_Phrase_RawText) and [DisplayedText](~/api/ChartTools.Lyrics.Phrase.yml#ChartTools_Lyrics_Phrase_DisplayedText) properties which combine the text from their syllables.

## Reading and writing vocals
Chart files define lyrics through global events that can be converted to a set of phrases. When reading a full song from a chart file, the vocals instrument will be null. To benefit of the more advanced lyrics API, a dummy set of phrases instrument can be generated using the [GetLyrics](~/api/ChartTools.Events.EventExtensions.yml#ChartTools_Events_EventExtensions_GetLyrics_System_Collections_Generic_IEnumerable_ChartTools_Events_GlobalEvent__) extension method.
Expand Down

0 comments on commit 4afe494

Please sign in to comment.