improve conventions

Author: TinyTakinTeller

.github/workflows/gdlint.yml renamed to .github/workflows/quality_check.yml

@@ -1,12 +1,13 @@
-# Workflow to automatically lint gdscript code
-name: gdlint on push
+# Workflow to ensure quality of the code.
+name: quality-check
 
 on:
   [push, pull_request]
 
 jobs:
+  # Job to automatically lint gdscript code
   gdlint:
-    name: gdlint code
+    name: checkstyle gdlint
     runs-on: ubuntu-latest
 
     # The allowed amount of linter problems

README.md

@@ -36,11 +36,17 @@
 
 ## 📜 Conventions
 
-- Code
+- Readable Code
 	- Use **snake_case** for files, folders, variables, functions.
 	- Use **PascalCase** for nodes, classes, enums, types.
 	- Use **typed** variables and functions.
 	- Use **style** inspired by [GDScript Style](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html) (see *gdlintrc*).
+	- Ensure **order of functions** (top to bottom of file):
+		- [overrides](https://docs.godotengine.org/en/stable/tutorials/scripting/overridable_functions.html) > public > private
+		- instance > static
+	- Naming variables
+		- consider class name suffix
+		- consider `_id` suffix for `String` referencing a resource
 
 
 ## 🧩 Plugins
@@ -93,7 +99,7 @@ Otherwise, Scenes must be loaded or added to the Scene Tree.
 - **SignalBus**
 	- TODO
 
-- **Wrapper**
+- **Wrapper** : *Extend functionality of a Plugin without modifying the original.*
 	- **SceneManagerWrapper** - call SceneManager with options presets Resource.
 
 ### 🎬 Scenes
@@ -110,9 +116,11 @@ Otherwise, Scenes must be loaded or added to the Scene Tree.
 ### 📄 Scripts
 
 - **Objects**
-	- **ConfigManager** - Use to persist (save & load) app settings, stats, etc.
-		- **AppLogConfig** - TODO
-		- TODO
+	- **ConfigManager** - Persists (save & load) app settings (global app data).
+		- **ConfigManagerAppLog**
+		- **ConfigManagerSettingsAudio**
+		- **ConfigManagerSettingsControl**
+		- **ConfigManagerSettingsVideo**
 
 - **Utils**
 	- **FileSystemUtils**
@@ -132,8 +140,8 @@ Otherwise, Scenes must be loaded or added to the Scene Tree.
 
 ### ✅ Workflows
 
-- **gdlint**
-	- On git push, automatically check *gdlintrc* coding style standards.
+- **quality_check.yml**
+	- Automatically check *gdlintrc* coding style standards.
 
 ### ⚡ Hacks
 
@@ -149,7 +157,7 @@ Otherwise, Scenes must be loaded or added to the Scene Tree.
 
 ### ❓ FAQ
 
-- I have errors/warnings when opening the project for the first time?
+-  Opening the project for the first time, I have errors/warnings?
 	- Try (re)enable all Plugins and then select "Reload Current Project".
 
 

godot/autoload/configuration/configuration.gd

@@ -4,6 +4,8 @@ extends Node
 func _ready() -> void:
 	Log.debug("AUTOLOAD READY: ", name)
 
+	ConfigManagerAppLog.app_opened()
+
 	if OS.is_debug_build():
 		_init_debug_configuration()
 	else:

godot/autoload/reference/reference.gd

@@ -1,33 +1,36 @@
+## Preloads all resources (.tres files) in /resources.
+## Holds references to resources in dictionary by name as key.
+## The key also holds a prefix to avoid conflicts of equal names across different resources.
 extends Node
 
 const RESOURCE_EXTENSION = ".tres"
 
 var _resource_references: Dictionary = {}
 
 
-func get_scene_manager_options(resource_name: String) -> SceneManagerOptions:
-	return _get_resource(resource_name, SceneManagerOptions)
-
-
-func _get_resource(resource_name: String, type: Variant) -> Resource:
-	var key: String = _get_key(resource_name, type)
-	return _resource_references[key]
-
-
 func _ready() -> void:
 	Log.debug("AUTOLOAD READY: ", name)
 
 	var paths: Array[String] = FileSystemUtils.get_paths(PathConsts.RESOURCES, RESOURCE_EXTENSION)
 	_resource_references = _load_resources(paths)
 
 
+func get_scene_manager_options(resource_id: String) -> SceneManagerOptions:
+	return get_resource(resource_id, SceneManagerOptions)
+
+
+func get_resource(resource_id: String, type: Variant) -> Resource:
+	var key: String = _get_key(resource_id, type)
+	return _resource_references[key]
+
+
 static func _load_resources(paths: Array[String]) -> Dictionary:
 	var resource_references: Dictionary = {}
 	for path: String in paths:
 		var resource: Resource = load(path) as Resource
 		if resource != null:
-			var resource_name: String = FileSystemUtils.get_file_name(path)
-			var key: String = _get_key(resource_name, _get_type(resource))
+			var resource_id: String = FileSystemUtils.get_file_name(path)
+			var key: String = _get_key(resource_id, _get_type(resource))
 			if resource_references.has(key):
 				Log.warn("Duplicate resource reference key: ", key)
 				continue
@@ -42,5 +45,5 @@ static func _get_type(resource: Resource) -> Variant:
 	return resource.get_script()
 
 
-static func _get_key(resource_name: String, type: Variant) -> String:
-	return type.get_global_name() + "-" + resource_name
+static func _get_key(resource_id: String, type: Variant) -> String:
+	return type.get_global_name() + "-" + resource_id

godot/autoload/wrapper/scene_manager_wrapper/scene_manager_wrapper.gd

@@ -6,12 +6,12 @@ func _ready() -> void:
 
 
 ## Change scene using preset options.
-func change_scene(scene_name: String, scene_manager_options_name: String) -> void:
+func change_scene(scene_id: String, scene_manager_options_id: String) -> void:
 	var scene_manager_options: SceneManagerOptions = Reference.get_scene_manager_options(
-		scene_manager_options_name
+		scene_manager_options_id
 	)
 	SceneManager.change_scene(
-		scene_name,
+		scene_id,
 		scene_manager_options.create_fade_out_options(),
 		scene_manager_options.create_fade_in_options(),
 		scene_manager_options.create_general_options()

godot/project.godot

@@ -24,6 +24,7 @@ Log/break_on_error=false
 [application]
 
 config/name="TakinGodotTemplate"
+config/version="0.0"
 run/main_scene="res://scenes/view/boot_splash/boot_splash.tscn"
 config/features=PackedStringArray("4.3", "GL Compatibility")
 boot_splash/bg_color=Color(0, 0, 0, 1)

godot/scenes/component/.gitkeep

@@ -1,12 +1,12 @@
 extends Control
 
 @export_group("Next Scene")
-@export var scene: String = "main_menu"
-@export var scene_manager_options: String = "fade_basic"
+@export var scene_id: String = "main_menu"
+@export var scene_manager_options_id: String = "fade_basic"
 
 var _boot_splash_color: Color = ProjectSettings.get("application/boot_splash/bg_color")
-var _boot_splash_image: String = ProjectSettings.get("application/boot_splash/image")
-var _boot_splash_texture: Texture = load(_boot_splash_image)
+var _boot_splash_image_path: String = ProjectSettings.get("application/boot_splash/image")
+var _boot_splash_texture: Texture = load(_boot_splash_image_path)
 
 @onready var boot_splash_color_rect: ColorRect = %BootSplashColorRect
 @onready var boot_splash_texture_rect: TextureRect = %BootSplashTextureRect
@@ -18,4 +18,4 @@ func _ready() -> void:
 	boot_splash_color_rect.color = _boot_splash_color
 	boot_splash_texture_rect.texture = _boot_splash_texture
 
-	SceneManagerWrapper.change_scene(scene, scene_manager_options)
+	SceneManagerWrapper.change_scene(scene_id, scene_manager_options_id)

godot/scenes/view/boot_splash/boot_splash.gd

@@ -1,31 +1,31 @@
 ## Modified File MIT License Copyright (c) 2024 TinyTakinTeller
 ## Original File MIT License Copyright (c) 2022-present Marek Belski
+
+## Persists data in a INI-style file.
 class_name ConfigManager
 extends Object
 
-const CONFIG_FILE_NAME: String = "user_config"
+const CONFIG_FILE_NAME: String = "config"
 const CONFIG_FILE_PATH: String = PathConsts.USER + CONFIG_FILE_NAME + ".cfg"
 
-static var config_file: ConfigFile
+static var config_file: ConfigFile = null
 
 
 static func _init() -> void:
 	_load_config_file()
 
 
-static func _load_config_file(create_on_not_found: bool = true) -> void:
-	if config_file != null:
-		return
-	config_file = ConfigFile.new()
-	var err_file_cant_open: int = config_file.load(CONFIG_FILE_PATH)
-	if err_file_cant_open and create_on_not_found:
-		_save_config_file()
+static func increment_config(section: String, key: String) -> void:
+	_load_config_file()
+	var value: int = ConfigManager.get_config(section, key, 0)
+	ConfigManager.set_config(section, key, value + 1)
+	_save_config_file()
 
 
-static func _save_config_file() -> void:
-	var save_error: int = config_file.save(CONFIG_FILE_PATH)
-	if save_error:
-		Log.err("Save config file failed with error ", save_error)
+static func set_empty_config(section: String, key: String, value: Variant) -> void:
+	_load_config_file()
+	config_file.set_value(section, key, value)
+	_save_config_file()
 
 
 static func set_config(section: String, key: String, value: Variant) -> void:
@@ -50,12 +50,14 @@ static func has_section_key(section: String, key: String) -> bool:
 
 
 static func erase_section(section: String) -> void:
+	_load_config_file()
 	if has_section(section):
 		config_file.erase_section(section)
 		_save_config_file()
 
 
 static func erase_section_key(section: String, key: String) -> void:
+	_load_config_file()
 	if has_section_key(section, key):
 		config_file.erase_section_key(section, key)
 		_save_config_file()
@@ -66,3 +68,23 @@ static func get_section_keys(section: String) -> PackedStringArray:
 	if config_file.has_section(section):
 		return config_file.get_section_keys(section)
 	return PackedStringArray()
+
+
+## reads config file from file system if it is not already read, ensuring we can write updates to it
+static func _load_config_file(create_on_not_found: bool = true) -> void:
+	if config_file != null:
+		return
+	config_file = ConfigFile.new()
+	var err_file_cant_open: int = config_file.load(CONFIG_FILE_PATH)
+	if err_file_cant_open and create_on_not_found:
+		_save_config_file()
+
+
+## writes config file to file system after it is updated
+static func _save_config_file() -> void:
+	if config_file == null:
+		Log.err("Save config file failed because it is not loaded.")
+		return
+	var save_error: int = config_file.save(CONFIG_FILE_PATH)
+	if save_error:
+		Log.err("Save config file failed with error ", save_error)

godot/scripts/objects/config_manager/config_manager.gd

@@ -0,0 +1,33 @@
+## Modified File MIT License Copyright (c) 2024 TinyTakinTeller
+## Original File MIT License Copyright (c) 2022-present Marek Belski
+
+class_name ConfigManagerAppLog
+extends Node
+
+const APP_LOG_SECTION: String = "AppLog"
+
+const APP_OPENED_COUNT_KEY: String = "AppOpenedCount"
+const APP_FIRST_VERSION_OPENED_KEY: String = "AppFirstVersionOpened"
+const APP_LAST_VERSION_OPENED_KEY: String = "AppLastVersionOpened"
+
+
+static func app_opened() -> void:
+	_update_app_opened_count()
+
+	var app_version: String = ProjectSettings.get_setting("application/config/version", "0")
+	_update_app_first_version_opened(app_version)
+	_update_app_last_version_opened(app_version)
+
+
+static func _update_app_opened_count() -> void:
+	ConfigManager.increment_config(APP_LOG_SECTION, APP_OPENED_COUNT_KEY)
+
+
+static func _update_app_first_version_opened(new_value: String) -> void:
+	var value: String = ConfigManager.get_config(APP_LOG_SECTION, APP_FIRST_VERSION_OPENED_KEY, "")
+	if value == "":
+		ConfigManager.set_config(APP_LOG_SECTION, APP_FIRST_VERSION_OPENED_KEY, new_value)
+
+
+static func _update_app_last_version_opened(new_value: String) -> void:
+	ConfigManager.set_config(APP_LOG_SECTION, APP_LAST_VERSION_OPENED_KEY, new_value)