Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor server Engine configuration setup #7

Merged
merged 1 commit into from
Mar 4, 2024

Conversation

thejcpalma
Copy link
Owner

Update Engine Configuration Setup

Summary

This pull request introduces new configuration modes for the Engine.ini file, providing more flexibility and control over how engine settings are configured.

Motivation and Context

With the evolving needs of the project, it became essential to enhance the configuration options for the Engine.ini file. The addition of three modes (full, modular, and skip) allows users to tailor the configuration process to their specific requirements when SERVER_SETTINGS_MODE is set to auto.

Description

The ENGINE_CONFIG_MODE environment variable now plays a crucial role in determining how the engine settings are configured:

  • full: Includes all settings in the Engine.ini.template file, utilizing environment variables or default values.
  • modular: Configures settings in the engine file only when the corresponding environment variable is set and not empty.
  • skip: Always skips the configuration of settings in the engine file, regardless of SERVER_SETTINGS_MODE being set to auto.

The following table summarizes the key variables:

Variable Description Default value Allowed value
ENGINE_CONFIG_MODE How Engine.ini file is configured modular full/modular/skip

Testing Instructions

To test these changes:

  1. Set SERVER_SETTINGS_MODE to auto.
  2. Adjust ENGINE_CONFIG_MODE to full, modular, or skip.
  3. Configure individual environment variables related to engine settings.
  4. Run the server and verify that the Engine.ini file reflects the chosen configuration mode and settings.

Checklist

  • I have performed a self-review of my own code
  • I have updated the documentation (if necessary)
  • My changes do not introduce any breaking changes or bugs

@thejcpalma thejcpalma added the enhancement New feature or request label Mar 4, 2024
@thejcpalma thejcpalma self-assigned this Mar 4, 2024
@thejcpalma thejcpalma merged commit 2869d6b into main Mar 4, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant