chore: rename config.json.example to config-vanilla.json (#2570)

Changing file extensions can be a bit of a chore on stock Windows, so this should simplify matters. Another bonus is that the "vanilla" clarifies the general guideline for how the defaults are configured.

Reviewed-on: #2570
Co-authored-by: Sainan <63328889+Sainan@users.noreply.github.com>
Co-committed-by: Sainan <63328889+Sainan@users.noreply.github.com>

.github/workflows/build.yml

@@ -14,7 +14,7 @@ jobs:
               with:
                   node-version: ">=20.6.0"
             - run: npm ci
-            - run: cp config.json.example config.json
+            - run: cp config-vanilla.json config.json
             - run: npm run verify
             - run: npm run lint:ci
             - run: npm run prettier

.prettierignore

@@ -2,4 +2,4 @@ src/routes/api.ts
 static/webui/libs/
 *.html
 *.md
-config.json.example
+config-vanilla.json

README.md

@@ -10,7 +10,7 @@ To get an idea of what functionality you can expect to be missing [have a look t
 
 ## config.json
 
-SpaceNinjaServer requires a `config.json`. To set it up, you can copy the [config.json.example](config.json.example), which has most cheats disabled.
+SpaceNinjaServer requires a `config.json`. To set it up, you can copy the [config-vanilla.json](config-vanilla.json), which has most cheats disabled.
 
 - `logger.level` can be `fatal`, `error`, `warn`, `info`, `http`, `debug`, or `trace`.
 - `myIrcAddresses` can be used to point to an IRC server. If not provided, defaults to `[ myAddress ]`.

docker-entrypoint.sh

@@ -2,7 +2,7 @@
 set -e
 
 if [ ! -f conf/config.json ]; then
-	jq --arg value "mongodb://openwfagent:spaceninjaserver@mongodb:27017/" '.mongodbUrl = $value' /app/config.json.example > /app/conf/config.json
+	jq --arg value "mongodb://openwfagent:spaceninjaserver@mongodb:27017/" '.mongodbUrl = $value' /app/config-vanilla.json > /app/conf/config.json
 fi
 
 exec npm run start -- --configPath conf/config.json

src/index.ts

@@ -7,7 +7,7 @@ try {
     if (fs.existsSync("config.json")) {
         console.log("Failed to load " + configPath + ": " + (e as Error).message);
     } else {
-        console.log("Failed to load " + configPath + ". You can copy config.json.example to create your config file.");
+        console.log("Failed to load " + configPath + ". You can copy config-vanilla.json to create your config file.");
     }
     process.exit(1);
 }