Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

ProjectSettings

Inherits: Object

Stores globally-accessible variables.

Description

Stores variables that can be accessed from everywhere. Use get_setting, set_setting or has_setting to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options.

When naming a Project Settings property, use the full path to the setting including the category. For example, "application/config/name" for the project name. Category and property names can be viewed in the Project Settings dialog.

Feature tags: Project settings can be overridden for specific platforms and configurations (debug, release, ...) using feature tags.

Overriding: Any project setting can be overridden by creating a file named override.cfg in the project's root directory. This can also be used in exported projects by placing this file in the same directory as the project binary. Overriding will still take the base project settings' feature tags in account. Therefore, make sure to also override the setting with the desired feature tags if you want them to override base project settings on all platforms and configurations.

Tutorials

Properties

Color

application/boot_splash/bg_color

Color(0.14, 0.14, 0.14, 1)

bool

application/boot_splash/fullsize

true

String

application/boot_splash/image

""

int

application/boot_splash/minimum_display_time

0

bool

application/boot_splash/show_image

true

bool

application/boot_splash/use_filter

true

bool

application/config/auto_accept_quit

true

String

application/config/custom_user_dir_name

""