Skip to content

Commit 00dee31

Browse files
committed
Updated README.md [skip ci]
1 parent 7bbf8ba commit 00dee31

File tree

2 files changed

+60
-32
lines changed

2 files changed

+60
-32
lines changed

README.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,24 @@ for (var x = 0; x < waveform.Length; x += 1)
9696
_texture2D.Apply();
9797
```
9898

99+
### Common
100+
101+
#### `Common.Lerp`
102+
103+
```csharp
104+
using RhythmGameUtilities;
105+
106+
var value = Common.Lerp(0, 10, 0.5f);
107+
```
108+
109+
#### `Utilities.InverseLerp`
110+
111+
```csharp
112+
using RhythmGameUtilities;
113+
114+
var value = Common.InverseLerp(0, 10, 5);
115+
```
116+
99117
### `Parsers`
100118

101119
Read more about `.chart` files: <https://github.com/TheNathannator/GuitarGame_ChartFormats/blob/main/doc/FileFormats/.chart/Core%20Infrastructure.md>
@@ -108,6 +126,16 @@ using RhythmGameUtilities;
108126
var sections = Parsers.ParseSectionsFromChart(contents);
109127
```
110128

129+
#### `Parsers.ParseMetaDataFromChartSection`
130+
131+
```csharp
132+
using RhythmGameUtilities;
133+
134+
var sections = Parsers.ParseSectionsFromChart(contents);
135+
136+
var metaData = Parsers.ParseMetaDataFromChartSection(sections[NamedSection.Song]);
137+
```
138+
111139
#### `Parsers.ParseTimeSignaturesFromChartSection`
112140

113141
```csharp
@@ -195,23 +223,9 @@ using RhythmGameUtilities;
195223
var value = Utilities.RoundUpToTheNearestMultiplier(12, 10);
196224
```
197225

198-
### Common
199-
200-
#### `Common.Lerp`
201-
202-
```csharp
203-
using RhythmGameUtilities;
226+
#### `Utilities.CalculateScore`
204227

205-
var value = Common.Lerp(0, 10, 0.5f);
206-
```
207-
208-
#### `Utilities.InverseLerp`
209-
210-
```csharp
211-
using RhythmGameUtilities;
212-
213-
var value = Common.InverseLerp(0, 10, 5);
214-
```
228+
#### `Utilities.CalculateBeatBarsInternal`
215229

216230
## Architecture
217231

UnityPackage/README.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,24 @@ for (var x = 0; x < waveform.Length; x += 1)
9696
_texture2D.Apply();
9797
```
9898

99+
### Common
100+
101+
#### `Common.Lerp`
102+
103+
```csharp
104+
using RhythmGameUtilities;
105+
106+
var value = Common.Lerp(0, 10, 0.5f);
107+
```
108+
109+
#### `Utilities.InverseLerp`
110+
111+
```csharp
112+
using RhythmGameUtilities;
113+
114+
var value = Common.InverseLerp(0, 10, 5);
115+
```
116+
99117
### `Parsers`
100118

101119
Read more about `.chart` files: <https://github.com/TheNathannator/GuitarGame_ChartFormats/blob/main/doc/FileFormats/.chart/Core%20Infrastructure.md>
@@ -108,6 +126,16 @@ using RhythmGameUtilities;
108126
var sections = Parsers.ParseSectionsFromChart(contents);
109127
```
110128

129+
#### `Parsers.ParseMetaDataFromChartSection`
130+
131+
```csharp
132+
using RhythmGameUtilities;
133+
134+
var sections = Parsers.ParseSectionsFromChart(contents);
135+
136+
var metaData = Parsers.ParseMetaDataFromChartSection(sections[NamedSection.Song]);
137+
```
138+
111139
#### `Parsers.ParseTimeSignaturesFromChartSection`
112140

113141
```csharp
@@ -195,23 +223,9 @@ using RhythmGameUtilities;
195223
var value = Utilities.RoundUpToTheNearestMultiplier(12, 10);
196224
```
197225

198-
### Common
199-
200-
#### `Common.Lerp`
201-
202-
```csharp
203-
using RhythmGameUtilities;
226+
#### `Utilities.CalculateScore`
204227

205-
var value = Common.Lerp(0, 10, 0.5f);
206-
```
207-
208-
#### `Utilities.InverseLerp`
209-
210-
```csharp
211-
using RhythmGameUtilities;
212-
213-
var value = Common.InverseLerp(0, 10, 5);
214-
```
228+
#### `Utilities.CalculateBeatBarsInternal`
215229

216230
## Architecture
217231

0 commit comments

Comments
 (0)