Merge pull request #82 from neogeek/feature/godot-cpp-plugin

[feat] Godot GDExtension Plugin

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "GodotPlugin/godot-cpp"]
+	path = GodotPlugin/godot-cpp
+	url = https://github.com/godotengine/godot-cpp.git

Documentation/API/Common/InverseLerp.md

@@ -1,6 +1,6 @@
 #### `Common.InverseLerp`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -31,3 +31,14 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var value = rhythm_game_utilities.inverse_lerp(0, 10, 5)
+
+	print(value) # 0.5
+```

Documentation/API/Common/Lerp.md

@@ -1,6 +1,6 @@
 #### `Common.Lerp`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -31,3 +31,14 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var value = rhythm_game_utilities.lerp(0, 10, 0.5)
+
+	print(value) # 5
+```

Documentation/API/Parsers/ParseBpmFromChartSection.md

@@ -1,6 +1,6 @@
 #### `Parsers.ParseBpmFromChartSection`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -39,3 +39,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content)
+
+	var bpm = rhythm_game_utilities.parse_bpm_from_chart_section(sections["SyncTrack"])
+
+	print(bpm)
+```

Documentation/API/Parsers/ParseLyricsFromChartSection.md

@@ -1,6 +1,6 @@
 #### `Parsers.ParseLyricsFromChartSection`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -39,3 +39,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content)
+
+	var lyrics = rhythm_game_utilities.parse_lyrics_from_chart_section(sections["Events"])
+
+	print(lyrics)
+```

Documentation/API/Parsers/ParseMetaDataFromChartSection.md

@@ -1,6 +1,6 @@
 #### `Parsers.ParseMetaDataFromChartSection`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -43,3 +43,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content)
+
+	var meta_data = rhythm_game_utilities.parse_meta_data_from_chart_section(sections["Song"])
+
+	print(meta_data)
+```

Documentation/API/Parsers/ParseNotesFromChartSection.md

@@ -1,6 +1,6 @@
 #### `Parsers.ParseNotesFromChartSection`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -47,3 +47,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content)
+
+	var notes = rhythm_game_utilities.parse_notes_from_chart_section(sections["ExpertSingle"])
+
+	print(notes)
+```

Documentation/API/Parsers/ParseSectionsFromChart.md

@@ -1,6 +1,6 @@
 #### `Parsers.ParseSectionsFromChart`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -34,3 +34,17 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content)
+
+	print(sections)
+```

Documentation/API/Parsers/ParseTimeSignaturesFromChartSection.md

@@ -1,6 +1,6 @@
 #### `Parsers.ParseTimeSignaturesFromChartSection`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -39,3 +39,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content)
+
+	var time_signatures = rhythm_game_utilities.parse_time_signatures_from_chart_section(sections["SyncTrack"])
+
+	print(time_signatures)
+```

Documentation/API/Utilities/CalculateAccuracyRatio.md

@@ -1,6 +1,6 @@
 #### `Utilities.CalculateAccuracyRatio`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -51,3 +51,22 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var seconds = 2
+	var resolution = 192
+	var position_delta = 50
+
+	var bpm_changes = { 0: 120000 }
+
+	var current_position = rhythm_game_utilities.convert_seconds_to_ticks(seconds, resolution, bpm_changes)
+
+	var value = rhythm_game_utilities.calculate_accuracy_ratio(750, current_position, position_delta)
+
+	print(round(value * 100) / 100.0) # 0.64
+```

Documentation/API/Utilities/CalculateBeatBars.md

@@ -1,6 +1,6 @@
 #### `Utilities.CalculateBeatBars`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -50,3 +50,23 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var resolution = 192
+	var time_signature = 4
+
+	var bpm_changes = {
+		0: 88000, 3840: 112000, 9984: 89600,
+		22272: 112000, 33792: 111500, 34560: 112000,
+		42240: 111980
+	}
+
+	var beat_bars = rhythm_game_utilities.calculate_beat_bars(bpm_changes, resolution, time_signature, true)
+
+	print(beat_bars)
+```

Documentation/API/Utilities/ConvertSecondsToTicks.md

@@ -1,6 +1,6 @@
 #### `Utilities.ConvertSecondsToTicks`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -52,3 +52,23 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var seconds = 5
+	var resolution = 192
+
+	var bpm_changes = {
+		0: 88000, 3840: 112000, 9984: 89600,
+		22272: 112000, 33792: 111500, 34560: 112000,
+		42240: 111980
+	}
+
+	var ticks = rhythm_game_utilities.convert_seconds_to_ticks(seconds, resolution, bpm_changes)
+
+	print(ticks) # 1408
+```

Documentation/API/Utilities/ConvertTickToPosition.md

@@ -1,6 +1,6 @@
 #### `Utilities.ConvertTickToPosition`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -37,3 +37,17 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var tick = 2784
+	var resolution = 192
+
+	var position = rhythm_game_utilities.convert_tick_to_position(tick, resolution)
+
+	print(position) # 14.5
+```

Documentation/API/Utilities/IsOnTheBeat.md

@@ -1,6 +1,6 @@
 #### `Utilities.IsOnTheBeat`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -41,3 +41,17 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var bpm = 120
+	var current_time = 10
+	var delta = 0.05
+
+	if rhythm_game_utilities.is_on_the_beat(bpm, current_time, delta):
+		print("Is on the beat!")
+```

Documentation/API/Utilities/RoundUpToTheNearestMultiplier.md

@@ -1,6 +1,6 @@
 #### `Utilities.RoundUpToTheNearestMultiplier`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -31,3 +31,14 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var value = rhythm_game_utilities.round_up_to_the_nearest_multiplier(12, 10)
+
+	print(value) # 20
+```

GodotPlugin/.gitignore

@@ -0,0 +1,4 @@
+addons/
+
+*.os
+*.dblite