zombieb/galvanic-corrosion
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

my power's back
All checks were successful
Galvanic Corrosion Cross-Compile / build (push) Successful in 1m57s
Details

Browse Source 
* Steam authentication
* Profile events
* Objective fixes for some rooms (reccenter, goldentrophy, etc)
* Profile meta (displayname) somewhat works
* Player socket subscriptions
This commit is contained in:
zombieb
2025-05-04 02:25:09 -04:00
parent fe29602f4a
commit 9e4bfc8368
23 changed files with 400 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
CONFIG.md
View File

@@ -2,6 +2,9 @@
[<-- Click to return to README.md](./README.md)
We recommend that you store the configuration file `config.json` in a safe place where Galvanic Corrosion can access it (the current directory).<br>
No other user on your server system should be able to access the file.
## Redis
Redis is database software and must be installed for Galvanic Corrosion.
@@ -41,7 +44,8 @@ This section contains basic information regarding your server.
`serverName`: Somewhat invisible to players, but is an official label your server could appear as (to future server lists?)
`serverId`: Used in the authentication process, uniquely identifies your server to clients. Players should never see this.<br>
Ideally, this should be unique for every server, and can be chosen by the server administrator.
Ideally, this should be unique for every server, and can be chosen by the server administrator.<br>
Example: zombieb-cool-gc-server
`owner`: That's you! You can insert your handle for any social networking site or some form of identification here.
@@ -57,20 +61,31 @@ Ideally, this should be unique for every server, and can be chosen by the server
this can be anything *except* for "none" or 4, since there is only one server to connect to and the game uses offline mode when the region ID is set to none.
`initialRoom`: On game startup, redirects the player to this room name instead of their DormRoom. Set to null if a "natural" startup is preferred.<br>
Ideally, this room should not be private and should be matchmakeable.
This room must not be private and must be matchmakeable.
## Logging
These three values expose booleans you can change to enable/disable logging various messages sent by the server used for debugging or troubleshooting purposes.
These three values expose booleans you can change to enable/disable logging various messages used for debugging or troubleshooting purposes.
## Discord
Currently unused.
Can be `null`. Currently unused.
A Discord Bot is planned for interacting with your server outside of the game.
## Auth
Parameters used by the server's authentication mechanisms.
`secret`: Used to generate tokens. should never be shared (by extension, the whole file) and can be a string of characters containing no words or patterns.
`secret`: Used to generate tokens. Should never be shared (the entire file) and can be a string of characters containing no words or patterns.
<br>Use secure cryptography APIs in programming languages to generate random strings.
`timeout`: The maximum age for a token.
`timeout`: The maximum age for a token.
### Auth Verification
Can be `null`. Cloudflare Turnstile is used to verify users before they create their account.
`enabled`: `true` by default. This section may also be `null`.<br>
This enables the `GET /user/verify` endpoint that is presented to users wishing to create an account.<br>
`POST /user/verify` is used for Turnstile siteverify.
`sitekey`: Turnstile sitekey from Cloudflare dashboard
`secretkey`: Turnstile secretkey from Cloudflare dashboard