diff --git a/config.gd.example b/config.gd.example index f163296..e072a0a 100644 --- a/config.gd.example +++ b/config.gd.example @@ -6,69 +6,36 @@ # Available in the public domain. extends Node -# Hello fellow dev! This is the CORE configuration file. -# This file can be used to customize CORE to your liking. -# You do not need to modify any CORE script as some things -# might break (everything depends on each other). -# Thank you for using CORE :) - +# Hello there, fellow developer! This is the CORE configuration +# file and is responsible for changing CORE's behaviour. If you +# want something added or have any questions, just open a issue +# here: https://git.staropensource.de/staropensource/core/issues/new +# +# If you want a reference, look into the documentation here: +# https://core.staropensource.de/references/config.gd/ +# +# Bye the way, thank you for developing your app/game with CORE :) # CORE -## core_startscript -## Type: String -## Default value: "res://" -## Enter the path to the game/application -## start script. It will be responsible -## for loading your game or application. +## Enter the path to your startup script var core_startscript = "res://" -# wmgr (Window Manager) -## wmgr_size_x -## Type: int -## Default value: 960 -## Defines the default window size (x axis) +# Window manager +## Initial window size (x coordinate) var wmgr_size_x = 960 -## wmgr_size_y -## Type: Int -## Default value: 540 -## Defines the default window size (y axis) +## Initial window size (y coordinate) var wmgr_size_y = 540 -## wmgr_title -## Type: String -## Default value: "Application/Game using CORE" +## Initial window title var wmgr_title = "Application/Game using CORE" -## wmgr_mode -## Type:int -## Default value: 0 -## ID | Mode -## 0 | Windowed -## 1 | Minimized -## 2 | Maximized -## 3 | Fullscreen -## 4 | Exclusive fullscreen +## Initial window mode var wmgr_mode = 0 -# Splash -## splash_enabled -## Type: bool -## Default value: false -## Enables or disables the splash screen at startup. -## Can be manually enabled with core.splash.display() +# Splash screen +## Enable/disable the splash screen at startup, can be manually enabled even if false var splash_enabled = true -## splash_image -## Type: String -## Default value: "res://CORE/soscore.png" -## The path to your image that will be displayed -## in the center of the splash screen. +## The splash screen image var splash_image = "res://CORE/soscore.png" -## splash_image_size -## Type: float -## Default value: 256 -## The size of your splash image. Used for both x and y. +## Image size, applies to both x and y coordinates var splash_image_size = 256 -## splash_color -## Type: String -## Default value: "000000" -## The splash screen's background color. Do not include -## a "#" at the start. +## Background color var splash_color = "000000"