You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ChartTools/Docs/articles/configuration.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Read and write operations in ChartTools feature customizable behavior for how they handle various error cases. These behaviors can be defines throguh the use of configuration objects.
4
4
5
-
The following snippet uses a [ChartReadingConfiguration](~/api/ChartTools.IO.Chart.Configuration.ChartReadingConfiguration.yml) to only include the first of duplicate [track objects](~/api/ChartTools.ITrackObject):
5
+
The following snippet uses a [ChartReadingConfiguration](~/api/ChartTools.IO.Chart.Configuration.ChartReadingConfiguration.yml) to only include the first of duplicate [track objects](~/api/ChartTools.ITrackObject.yml):
Copy file name to clipboardExpand all lines: ChartTools/Docs/articles/dynamic-syntax.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ The dynamic syntax uses three enums to get instruments:
21
21
Drums do not an enum for their chord types as they are the only instrument using their respective chords.
22
22
23
23
## Generic vs. non-generic
24
-
When an instrument is obtained dynamically using the [InstrumentIdentity](~/api/ChartTools.InstrumentIdentity.yml) enum, the returned object is of type [Instrument](~/api/ChartTools.Instrument.yml). When a track is obtained from a non-generic instrument, either dynamically or explicitly through a property, the track will be of type [Track](~/api/ChartTools.Trac.yml). This concept extends to chords and notes.
24
+
When an instrument is obtained dynamically using the [InstrumentIdentity](~/api/ChartTools.InstrumentIdentity.yml) enum, the returned object is of type [Instrument](~/api/ChartTools.Instrument.yml). When a track is obtained from a non-generic instrument, either dynamically or explicitly through a property, the track will be of type [Track](~/api/ChartTools.Track.yml). This concept extends to chords and notes.
25
25
26
26
When working with a non-generic track, the following rules apply:
27
27
- Chords cannot be added or removed. The position of existing chords can be modified.
Copy file name to clipboardExpand all lines: ChartTools/Docs/articles/getting-started.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Getting Started
1
+
# Getting Started
2
2
This document will go over the basics of parsing and saving a chart using ChartTools.
3
3
4
4
## Installation
@@ -20,7 +20,7 @@ Every component of a chart is stored in an instance of the [Song](~/api/ChartToo
20
20
Songsong=Song.FromFile(path);
21
21
```
22
22
23
-
A configuration object may also be used to customize the error handling behavior. [Learn more about configuring IO operations](~/articles/configuration.yml).
23
+
A configuration object may also be used to customize the error handling behavior. [Learn more about configuring IO operations](~/articles/configuration.md).
Notice the use of [StandardChord](~/api/ChartTools.StandardChord.yml) as a generic type. Instruments are divided into four categories based on the type of chords they use. These categories are:
96
+
Notice the use of [StandardChord](~/api/ChartTools.StandardChord) as a generic type. Instruments are divided into four categories based on the type of chords they use. These categories are:
97
97
98
98
- Standard - Five colored notes
99
99
- Drums - Five colored notes with support for double kick and cymbal flags
@@ -103,12 +103,12 @@ A track is composed of three components:
103
103
104
104
- Chords - Defined by the generic type
105
105
- Special phrases - Primarily used for star power
106
-
-[Local events](events.md)
106
+
-[Local events](~/articles/events.md)
107
107
108
-
Instruments can also be obtained dynamically from a song, regardless of the type. [Learn more about the dynamic syntax](dynamic-syntax.md).
108
+
Instruments can also be obtained dynamically from a song, regardless of the type. [Learn more about the dynamic syntax](~/articles/dynamic-syntax.md).
109
109
110
110
### Chords and Notes
111
-
A chord is a set of notes played at the same time. For readability, most chords and notes have specific classes for each instrument type, deriving from [Chord<TNote, TLane, TModifiers>](~/api/ChartTools.Chord-3.yml) and [LaneNode\<TLane\>](~/api/ChartTools.LaneNote-1.yml).
111
+
A chord is a set of notes played at the same time. For readability, most chords and notes have specific classes for each instrument type, deriving from [Chord<TNote, TLane, TModifiers>](~/api/ChartTools.Chord-3) and [LaneNode\<TLane\>](~/api/ChartTools.LaneNote-1).
112
112
113
113
The following snippet adds an orange note to every chord on a track:
114
114
@@ -122,7 +122,7 @@ foreach (StandardChord chord in song.Instruments.StandardLeadGuitar.Expert)
122
122
```
123
123
124
124
## Tools
125
-
As the name suggests, *ChartTools* also provides various tools to help fix and optimize songs. [Learn more](~/articles/tools).
125
+
As the name suggests, *ChartTools* also provides various tools to help fix and optimize songs. [Learn more](~/articles/tools.md).
126
126
127
127
## Writing files
128
128
Finally, changes can be saved to a file, with the format determined by the file extension.
Copy file name to clipboardExpand all lines: ChartTools/Docs/articles/improving-performance.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
This guide will cover alternate techniques that will improve performance when using ChartTools.
3
3
4
4
## Configuration
5
-
By default, IO operations make multiple integrity checks to resolve errors. These checks can be configured or skipped by using a [Readingconfiguration](~/api/ChartTools.IO.Configuration.ReadingConfiguration.yml) or [WritingConfiguration](~/api/ChartTools.IO.Configuration.WritingConfiguration.yml) object. [Learn more about configuring IO operations](~/articles/configuration.yml).
5
+
By default, IO operations make multiple integrity checks to resolve errors. These checks can be configured or skipped by using a [Readingconfiguration](~/api/ChartTools.IO.Configuration.ReadingConfiguration.yml) or [WritingConfiguration](~/api/ChartTools.IO.Configuration.WritingConfiguration.yml) object. [Learn more about configuring IO operations](~/articles/configuration.md).
6
6
7
7
The following example reads a song while bypassing checks for duplicate track objects:
Copy file name to clipboardExpand all lines: ChartTools/Docs/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ If you find any bugs, you can report them in the [Issues section](https://github
6
6
As this project is in development, it should only be used with charts with a backup available. **I am not responsible for damages to charts!**
7
7
8
8
## Getting Started
9
-
For an overview on installation and taking your first steps with ChartTools, see [Articles](~/articles/getting-started). A GitHub Pages website is available with detailed articles and API documentation.
9
+
For an overview on installation and taking your first steps with ChartTools, see [Articles](~/articles/getting-started.md). A GitHub Pages website is available with detailed articles and API documentation.
10
10
11
11
## Contributing
12
12
If you like to contribute to the development of ChartTools, feel free to comment on an issue, submit a pull request or submit your own issues.
0 commit comments