CORE/docs/references/config.gd.md

hide
navigation

CORE configuration file (core.config)

The CORE configuration file is located at res://CORE/config.gd and is used for configuring CORE behaviour. A full example configuration can be found here.

CORE

core_startscript

• type String
• default value res://init.gd
• description The initialization script. It is responsible for loading your application and for example displaying a main menu.

Window manager (wmgr)

wmgr_size_x

• type int
• default value 960
• description The window size set at startup (x coordinate).

wmgr_size_y

• type int
• default value 540
• description The window size set at startup (y coordinate).

wmgr_title

• type String
• default value "Application/Game using CORE"
• description The window title set at startup.

wmgr_mode

• type String
• default value 0
• description The window mode set at startup.
• format 0 = WINDOWED, 1 = MINIMIZED, 2 = MAXIMIZED, 3 = FULLSCREEN or 4 = EXCLUSIVE_FULLSCREEN

Splash screen (splash)

splash_enabled

• type bool
• default value false
• description Displays or hides the splash screen at startup time.
• format true = displayed or false = hidden

splash_image

• type String
• default value "res://CORE/soscore.png"
• description The path to a image, displayed in the center of the splash screen.

splash_image_size

• type float
• default value 256
• description The size of your image. Used for both the x and y coordinates.

splash_color

• type String
• default value 000000
• description The background color.
• format AARRGGBB or RRGGBB (AA = alpha, RR = red, GG = green and BB = blue)

Example configuration

This configuration can be found at res://CORE/config.gd.example.

# 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.
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 :)


# 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.
var core_startscript = "res://"

# wmgr (Window Manager)
## wmgr_size_x
## Type: int
## Default value: 960
## Defines the default window size (x axis)
var wmgr_size_x = 960
## wmgr_size_y
## Type: Int
## Default value: 540
## Defines the default window size (y axis)
var wmgr_size_y = 540
## wmgr_title
## Type: String
## Default value: "Application/Game using CORE"
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
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()
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.
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.
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.
var splash_color = "000000"