Create a file for client configuration

[Hectate]

We now have a Github action to push new configurations.
The client will need to regularly fetch the config file and use it. Since this file does not exist, we have to define it first.

The steps to complete this are:

• Determine which variables, settings, etc. are to be included in this config file
• Create a schema to validate configurations against.
• Create a default, local configuration file for the client to load and apply
• Add a process to check for updated config files and fetch it
• Replace the local config file if appropriate.
• Refresh configuration with the new file.
• Create a generate script that writes a config file for upload use
• Allow command line arguments to override the configuration file

[Hectate]

Review of various files for potential configuration needs. Unlisted files appear to contain nothing that would need changed.

• src\main\config\content-sources.ts :
  • contentSources: CDN locations are hardcoded
  • findEngineReleaseUrl(): url and searchParams are hardcoded
• src\main\config\default-maps.ts: defaultMaps is hardcoded
• src\main\config\default-versions.ts: all const are hardcoded
• src\main\content\game\pool-cdn.ts: cdnUrl is hardcoded
• src\main\content\pr-downloader.ts: Two urls are hardcoded
• src\main\game\springsettings.ts: All default settings are hardcoded, however this might be moved to be part of the game files rather than a config.
• src\main\json\model\settings.ts: logUploadUrl and lobbyServer have hardcoded defaults
• src\main\services\maps.service.ts: maps is fetched from a hardcoded url
• src\main\services\news.service.ts: Two urls are hardcoded
• src\main\services\shell.service.ts: Two urls are hardcoded
• src\renderer\components\navbar\ServerSettings.vue: defaultServers is hardcoded
• src\renderer\views\watch\replays.vue: openBrowserToReplayService is hardcoded

Additionally, it should be considered that the location of the config file - which is not something that exists in the source yet - will be a configuration matter as well.

[Hectate]

Work is being done in https://github.com/Hectate/bar-lobby/tree/config-service at the moment.
There is an initial schema that provides default values to all the above items including the config file location itself.

Config file for in-client use ends up in [state]\config\config.json.
Running npm run generate-default-config will create a copy at auxiliary\config-serving\json\config.json for use in the Github workflow, since it can be committed to master.

{
    "configUrl": "https://lobby-config.beyondallreason.dev/config.json",
    "rapidHost": "repos-cdn.beyondallreason.dev",
    "rapidGame": "byar",
    "gameGithubOwner": "beyond-all-reason",
    "gameGithubRepo": "Beyond-All-Reason",
    "engineGithubOwner": "beyond-all-reason",
    "engineGithubRepo": "spring",
    "engineReleaseUrl": "https://files-cdn.beyondallreason.dev/find",
    "defaultMaps": [
        "Quicksilver Remake 1.24",
        "Red Comet Remake 1.8"
    ],
    "latestGameVersion": "byar:test",
    "defaultEngineVersion": "2025.06.21",
    "cdnUrl": "https://pool-init.beyondallreason.dev",
    "prdRapidUseStreamer": "false",
    "prdRapidRepoMaster": "https://repos-cdn.beyondallreason.dev/repos.gz",
    "prdHttpSearchUrl": "https://files-cdn.beyondallreason.dev/find",
    "logUploadUrl": "https://log.beyondallreason.dev/",
    "lobbyServer": "wss://server4.beyondallreason.info",
    "mapsMetadataUrl": "https://maps-metadata.beyondallreason.dev/latest/lobby_maps.validated.json",
    "newsRssUrl": "https://www.beyondallreason.info/news/rss.xml",
    "devlogRssUrl": "https://www.beyondallreason.info/microblogs/rss.xml",
    "replayServiceUrl": "https://bar-rts.com/replays",
    "newsServiceUrl": "https://www.beyondallreason.info/news",
    "defaultServers": [
        "wss://server4.beyondallreason.info",
        "wss://server5.beyondallreason.info",
        "wss://lobby-server-dev.beyondallreason.dev",
        "ws://localhost:4000"
    ],
    "replayDownloadUrl": "https://bar-rts.com/replays"
}

[Hectate]

@p2004a Are we able to use Github actions to generate a config.json that uses the defaults from the schema model whenever we have a push to master? I know you set up the action already, but specifically are we able to make it come from the defaults?

My thought is that if we ever change the defaults on master (or some other branch, if we need to be cautious), whatever we put as new defaults is automatically the config file.

[Hectate]

Mostly ready. Note that fetching either of the two Arrays on the renderer side requires a toRaw() to avoid Proxy objects.

[Hectate]

Note to self; need to test that a "bad" configuration is correctly supplanted by the "good" remote configuration (e.g. default engine version), and then saved locally. This includes on a first-run of the client before the user gains control, where the default values provided by the schema may be "bad" options in their release.

[p2004a]

@p2004a Are we able to use Github actions to generate a config.json that uses the defaults from the schema model whenever we have a push to master? I know you set up the action already, but specifically are we able to make it come from the defaults?

I see you figured it out.