Up to date

This page is up to date for Godot 4.1. 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

""

String

application/config/description

""

String

application/config/icon

""

String

application/config/macos_native_icon

""

String

application/config/name

""

Dictionary

application/config/name_localized

{}

String

application/config/project_settings_override

""

bool

application/config/quit_on_go_back

true

bool

application/config/use_custom_user_dir

false

bool

application/config/use_hidden_project_data_directory

true

String

application/config/windows_native_icon

""

bool

application/run/delta_smoothing

true

bool

application/run/disable_stderr

false

bool

application/run/disable_stdout

false

bool

application/run/flush_stdout_on_print

false

bool

application/run/flush_stdout_on_print.debug

true

int

application/run/frame_delay_msec

0

bool

application/run/low_processor_mode

false

int

application/run/low_processor_mode_sleep_usec

6900

String

application/run/main_loop_type

"SceneTree"

String

application/run/main_scene

""

int

application/run/max_fps

0

float

audio/buses/channel_disable_threshold_db

-60.0

float

audio/buses/channel_disable_time

2.0

String

audio/buses/default_bus_layout

"res://default_bus_layout.tres"

String

audio/driver/driver

bool

audio/driver/enable_input

false

int

audio/driver/mix_rate

44100

int

audio/driver/mix_rate.web

0

int

audio/driver/output_latency

15

int

audio/driver/output_latency.web

50

float

audio/general/2d_panning_strength

0.5

float

audio/general/3d_panning_strength

0.5

bool

audio/general/text_to_speech

false

int

audio/video/video_delay_compensation_ms

0

int

compression/formats/gzip/compression_level

-1

int

compression/formats/zlib/compression_level

-1

int

compression/formats/zstd/compression_level

3

bool

compression/formats/zstd/long_distance_matching

false

int

compression/formats/zstd/window_log_size

27

bool

debug/file_logging/enable_file_logging

false

bool

debug/file_logging/enable_file_logging.pc

true

String

debug/file_logging/log_path

"user://logs/godot.log"

int

debug/file_logging/max_log_files

5

int

debug/gdscript/warnings/assert_always_false

1

int

debug/gdscript/warnings/assert_always_true

1

int

debug/gdscript/warnings/confusable_identifier

1

int

debug/gdscript/warnings/constant_used_as_function

1

int

debug/gdscript/warnings/deprecated_keyword

1

int

debug/gdscript/warnings/empty_file

1

bool

debug/gdscript/warnings/enable

true

bool

debug/gdscript/warnings/exclude_addons

true

int

debug/gdscript/warnings/function_used_as_property

1

int

debug/gdscript/warnings/get_node_default_without_onready

2

int

debug/gdscript/warnings/incompatible_ternary

1

int

debug/gdscript/warnings/inference_on_variant

2

int

debug/gdscript/warnings/int_as_enum_without_cast

1

int

debug/gdscript/warnings/int_as_enum_without_match

1

int

debug/gdscript/warnings/integer_division

1

int

debug/gdscript/warnings/narrowing_conversion

1

int

debug/gdscript/warnings/native_method_override

2

int

debug/gdscript/warnings/onready_with_export

2

int

debug/gdscript/warnings/property_used_as_function

1

int

debug/gdscript/warnings/redundant_await

1

int

debug/gdscript/warnings/redundant_static_unload

1

bool

debug/gdscript/warnings/renamed_in_godot_4_hint

1

int

debug/gdscript/warnings/return_value_discarded

0

int

debug/gdscript/warnings/shadowed_global_identifier

1

int

debug/gdscript/warnings/shadowed_variable

1

int

debug/gdscript/warnings/shadowed_variable_base_class

1

int

debug/gdscript/warnings/standalone_expression

1

int

debug/gdscript/warnings/standalone_ternary

1

int

debug/gdscript/warnings/static_called_on_instance

1

int

debug/gdscript/warnings/unassigned_variable

1

int

debug/gdscript/warnings/unassigned_variable_op_assign

1

int

debug/gdscript/warnings/unreachable_code

1

int

debug/gdscript/warnings/unreachable_pattern

1

int

debug/gdscript/warnings/unsafe_call_argument

0

int

debug/gdscript/warnings/unsafe_cast

0

int

debug/gdscript/warnings/unsafe_method_access

0

int

debug/gdscript/warnings/unsafe_property_access

0

int

debug/gdscript/warnings/unsafe_void_return

1

int

debug/gdscript/warnings/unused_local_constant

1

int

debug/gdscript/warnings/unused_parameter

1

int

debug/gdscript/warnings/unused_private_class_variable

1

int

debug/gdscript/warnings/unused_signal

1

int

debug/gdscript/warnings/unused_variable

1

String

debug/settings/crash_handler/message

"Please include this when reporting the bug to the project developer."

String

debug/settings/crash_handler/message.editor

"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"

int

debug/settings/gdscript/max_call_stack

1024

int

debug/settings/profiler/max_functions

16384

bool

debug/settings/stdout/print_fps

false

bool

debug/settings/stdout/print_gpu_profile

false

bool

debug/settings/stdout/verbose_stdout

false

bool

debug/shader_language/warnings/device_limit_exceeded

true

bool

debug/shader_language/warnings/enable

true

bool

debug/shader_language/warnings/float_comparison

true

bool

debug/shader_language/warnings/formatting_error

true

bool

debug/shader_language/warnings/treat_warnings_as_errors

false

bool

debug/shader_language/warnings/unused_constant

true

bool

debug/shader_language/warnings/unused_function

true

bool

debug/shader_language/warnings/unused_local_variable

true

bool

debug/shader_language/warnings/unused_struct

true

bool

debug/shader_language/warnings/unused_uniform

true

bool

debug/shader_language/warnings/unused_varying

true

Color

debug/shapes/avoidance/agents_radius_color

Color(1, 1, 0, 0.25)

bool

debug/shapes/avoidance/enable_agents_radius

true

bool

debug/shapes/avoidance/enable_obstacles_radius

true

bool

debug/shapes/avoidance/enable_obstacles_static

true

Color

debug/shapes/avoidance/obstacles_radius_color

Color(1, 0.5, 0, 0.25)

Color

debug/shapes/avoidance/obstacles_static_edge_pushin_color

Color(1, 0, 0, 1)

Color

debug/shapes/avoidance/obstacles_static_edge_pushout_color

Color(1, 1, 0, 1)

Color

debug/shapes/avoidance/obstacles_static_face_pushin_color

Color(1, 0, 0, 0)

Color

debug/shapes/avoidance/obstacles_static_face_pushout_color

Color(1, 1, 0, 0.5)

Color

debug/shapes/collision/contact_color

Color(1, 0.2, 0.1, 0.8)

bool

debug/shapes/collision/draw_2d_outlines

true

int

debug/shapes/collision/max_contacts_displayed

10000

Color

debug/shapes/collision/shape_color

Color(0, 0.6, 0.7, 0.42)

Color

debug/shapes/navigation/agent_path_color

Color(1, 0, 0, 1)

float

debug/shapes/navigation/agent_path_point_size

4.0

Color

debug/shapes/navigation/edge_connection_color

Color(1, 0, 1, 1)

bool

debug/shapes/navigation/enable_agent_paths

true

bool

debug/shapes/navigation/enable_agent_paths_xray

true

bool

debug/shapes/navigation/enable_edge_connections

true

bool

debug/shapes/navigation/enable_edge_connections_xray

true

bool

debug/shapes/navigation/enable_edge_lines

true

bool

debug/shapes/navigation/enable_edge_lines_xray

true

bool

debug/shapes/navigation/enable_geometry_face_random_color

true

bool

debug/shapes/navigation/enable_link_connections

true

bool