Update example configuration (#2)

Reviewed-on: StarOpenSource/core#2
Co-authored-by: JeremyStarTM <jeremystartm@staropensource.de>
Co-committed-by: JeremyStarTM <jeremystartm@staropensource.de>
This commit is contained in:
JeremyStar™ 2023-08-25 15:11:17 +02:00 committed by JeremyStar™
parent 99703cf03e
commit 610f93842e

View file

@ -1,55 +1,45 @@
# core.gd.example
# CORE example configuration file
#
# This file is part of StarOpenSource CORE (SOSCORE)
# Made by the StarOpenSource Project and Contributers
# Available in the public domain.
##############################
# THE CORE FRAMEWORK #
# EXAMPLE CONFIGURATION FILE #
# #
# THIS DOCUMENT IS PUBLICLY #
# AVAILABLE UNDER THE PUBLIC #
# DOMAIN AND IS NOT LICENSED #
##############################
extends Node
# 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
# Hello there, fellow developer!
# This is a example configuration file
# for the CORE Framework (source 0).
#
# Most settings in this config should be
# self explanitory. If not, visit the documentation:
# https://core.staropensource.de/references/Configuration_File/
#
# 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 :)
# Thank you for using the CORE Framework!
# - The StarOpenSource Project & Contributers
# CORE
## Enter the path to your startup script
var core_startscript = "res://"
var core_initscript: String ? "res://init.gd"
# Window manager
## Initial window size (x coordinate)
var wmgr_size_x = 960
## Initial window size (y coordinate)
var wmgr_size_y = 540
## Initial window title
var wmgr_title = "Application/Game using CORE"
## Initial window mode
var wmgr_mode = 0
var preprocessor_enabled: bool = true
var preprocessor_diagnostic: bool = false
# Splash screen
## Enable/disable the splash screen at startup, can be manually enabled even if false
var splash_enabled = true
## The splash screen image
var splash_image = "res://CORE/soscore.png"
## Image size, applies to both x and y coordinates
var splash_image_size = 256
## Background color
var splash_color = "000000"
var logger_enabled: bool = true
var logger_diagnostic: bool = false
# Mother Of All Mods (CORE modloader)
## The directory where all modifications should be located at
## Please note that you should use a clean directory or you will
## encounter errors and strange behaviour.
var moam_loadpath = "user://mods/"
## The name of your project (use lowercasing and snake casing!)
## Used for the mod info file, as it is named like this: "<moam_wanted_name>.coremod"
var moam_wanted_name = "a_core_using_project"
## The wanted version, for example your game version
var moam_wanted_version = 1
## The wanted api version, if you have a modification api for your app/game
## If you don't have a mod api, comment it out or set it to moam_wanted_version
var moam_wanted_api = 1
var corelog_enabled: bool = true
var debugdisplay_enabled: bool = false
var debugdisplay_fps: bool = true
var debugdisplay_delta: bool = true
var debugdisplay_rendertime: bool = true
var debugdisplay_memory: bool = true
var resourcemanager_load_invalid_file_as_null: bool = false
var splash_enabled: bool = false
var splash_image: String = "res://CORE/soscore.png"
var splash_image_size: int = 256
var splash_color: String = "000000"
# EOF <- Yes, this is the end of the example configuration! Pretty short, isn't it?