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

Add More Configurable Options via ENV #1

Open
20 tasks
lafayettegabe opened this issue Dec 22, 2024 · 0 comments
Open
20 tasks

Add More Configurable Options via ENV #1

lafayettegabe opened this issue Dec 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lafayettegabe
Copy link
Owner

Expand the server's configurability by introducing additional environment variables that can be set via the docker-compose.yml file. This will provide users with more flexibility to customize the server without modifying the configuration files manually.

Hardcoded Configurations

These are the current hardcoded configurations for the server. Each setting can be transitioned to be configurable through environment variables. Different team members can update individual options.

General Settings

  • Public: true
  • PVP: true
  • PauseEmpty: true
  • GlobalChat: true
  • Open: true
  • DisplayUserName: false

Combat & Death

  • NoFire: false
  • AnnounceDeath: true
  • PlayerBumpPlayer: true

Safehouse Settings

  • PlayerSafehouse: true
  • SafehouseAllowTrespass: false
  • SafehouseAllowFire: false
  • SafehouseAllowLoot: false
  • SafehouseAllowRespawn: true
  • SafehouseDaySurvivedToClaim: 0
  • SafeHouseRemovalTime: 72

Sleep & Loot

  • SleepAllowed: true
  • SleepNeeded: true
  • HoursForLootRespawn: 1000

Steam Settings

  • SteamScoreboard: admin

Proposed Configurable Options

Game Settings

  • PVP: Enable or disable player-vs-player combat (true/false).
  • GlobalChat: Enable or disable global chat (true/false).
  • SleepAllowed: Allow players to sleep (true/false).

Safehouse Settings

  • PlayerSafehouse: Allow players to claim safehouses (true/false).
  • SafehouseAllowTrespass: Enable trespassing in safehouses (true/false).
  • SafehouseDaySurvivedToClaim: Number of days required to claim a safehouse (integer).

Gameplay Settings

  • HoursForLootRespawn: Hours required for loot to respawn (integer).
  • SteamScoreboard: Set a Steam scoreboard admin name (string).

Benefits

  • Simplifies customization for users who deploy via Docker.
  • Reduces the need for manual edits in the servertest.ini file.
  • Provides greater control over game settings directly from the container environment.

Acceptance Criteria

  • All proposed options are supported as environment variables.
  • Documentation is updated with new configuration options.
  • The update-config.sh script dynamically updates servertest.ini with the new variables.
@lafayettegabe lafayettegabe added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Dec 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant