SpaceNinjaServer/README.md

# Space Ninja Server

More information for the moment here: [https://discord.gg/PNNZ3asUuY](https://discord.gg/PNNZ3asUuY)

## Project Status

This project is in active development at <https://onlyg.it/OpenWF/SpaceNinjaServer>.

To get an idea of what functionality you can expect to be missing [have a look through the issues](https://onlyg.it/OpenWF/SpaceNinjaServer/issues?q=&type=all&state=open&labels=-4%2C-10&milestone=0&assignee=0&poster=). However, many things have been implemented and *should* work as expected. Please open an issue for anything where that's not the case and/or the server is reporting errors.

## 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.

- `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 ]`.
- `worldState.eidolonOverride` can be set to `day` or `night` to lock the time to day/fass and night/vome on Plains of Eidolon/Cambion Drift.
- `worldState.vallisOverride` can be set to `warm` or `cold` to lock the temperature on Orb Vallis.
- `worldState.nightwaveOverride` will lock the nightwave season, assuming the client is new enough for it. Valid values:
  - `RadioLegionIntermission13Syndicate` for Nora's Mix Vol. 9
  - `RadioLegionIntermission12Syndicate` for Nora's Mix Vol. 8
  - `RadioLegionIntermission11Syndicate` for Nora's Mix Vol. 7
  - `RadioLegionIntermission10Syndicate` for Nora's Mix Vol. 6
  - `RadioLegionIntermission9Syndicate` for Nora's Mix Vol. 5
  - `RadioLegionIntermission8Syndicate` for Nora's Mix Vol. 4
  - `RadioLegionIntermission7Syndicate` for Nora's Mix Vol. 3
  - `RadioLegionIntermission6Syndicate` for Nora's Mix Vol. 2
  - `RadioLegionIntermission5Syndicate` for Nora's Mix Vol. 1
  - `RadioLegionIntermission4Syndicate` for Nora's Choice
  - `RadioLegionIntermission3Syndicate` for Intermission III
  - `RadioLegion3Syndicate` for Glassmaker
  - `RadioLegionIntermission2Syndicate` for Intermission II
  - `RadioLegion2Syndicate` for The Emissary
  - `RadioLegionIntermissionSyndicate` for Intermission I
  - `RadioLegionSyndicate` for The Wolf of Saturn Six
Update README.md 2023-08-29 20:19:10 +02:00			`# Space Ninja Server`
Update README.md 2023-05-19 18:29:37 -03:00
			`More information for the moment here: [https://discord.gg/PNNZ3asUuY](https://discord.gg/PNNZ3asUuY)`
chore: initial documentation of config.json (#627) 2024-12-23 22:44:43 +01:00
chore: add "project status" section to readme (#1166) Explicitly pointing out the issue tracking should give people a better idea of the project and allow them to set expectations accordingly. Reviewed-on: https://onlyg.it/OpenWF/SpaceNinjaServer/pulls/1166 2025-03-13 02:14:21 -07:00			`## Project Status`

			`This project is in active development at <https://onlyg.it/OpenWF/SpaceNinjaServer>.`

			`To get an idea of what functionality you can expect to be missing [have a look through the issues](https://onlyg.it/OpenWF/SpaceNinjaServer/issues?q=&type=all&state=open&labels=-4%2C-10&milestone=0&assignee=0&poster=). However, many things have been implemented and should work as expected. Please open an issue for anything where that's not the case and/or the server is reporting errors.`
chore: note for mirror lookers 2025-02-27 01:12:32 -08:00
chore: initial documentation of config.json (#627) 2024-12-23 22:44:43 +01:00			`## config.json`

docs: some basic explanation of config.json & config.json.example 2025-04-16 15:35:39 +02:00			SpaceNinjaServer requires a `config.json`. To set it up, you can copy the [config.json.example](config.json.example), which has most cheats disabled.

chore: initial documentation of config.json (#627) 2024-12-23 22:44:43 +01:00			- `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 ]`.
feat: add eidolonOverride & vallisOverride to replace lockTime (#2135) I think for now it's best to keep the client time somewhat in sync with the server/database time to avoid various issues. Reviewed-on: https://onlyg.it/OpenWF/SpaceNinjaServer/pulls/2135 Co-authored-by: Sainan <63328889+Sainan@users.noreply.github.com> Co-committed-by: Sainan <63328889+Sainan@users.noreply.github.com> 2025-06-09 06:54:58 -07:00			- `worldState.eidolonOverride` can be set to `day` or `night` to lock the time to day/fass and night/vome on Plains of Eidolon/Cambion Drift.
			- `worldState.vallisOverride` can be set to `warm` or `cold` to lock the temperature on Orb Vallis.
feat: add nightwaveOverride to config (#2120) Reviewed-on: https://onlyg.it/OpenWF/SpaceNinjaServer/pulls/2120 Co-authored-by: Sainan <63328889+Sainan@users.noreply.github.com> Co-committed-by: Sainan <63328889+Sainan@users.noreply.github.com> 2025-06-07 02:16:19 -07:00			- `worldState.nightwaveOverride` will lock the nightwave season, assuming the client is new enough for it. Valid values:
			- `RadioLegionIntermission13Syndicate` for Nora's Mix Vol. 9
			- `RadioLegionIntermission12Syndicate` for Nora's Mix Vol. 8
			- `RadioLegionIntermission11Syndicate` for Nora's Mix Vol. 7
			- `RadioLegionIntermission10Syndicate` for Nora's Mix Vol. 6
			- `RadioLegionIntermission9Syndicate` for Nora's Mix Vol. 5
			- `RadioLegionIntermission8Syndicate` for Nora's Mix Vol. 4
			- `RadioLegionIntermission7Syndicate` for Nora's Mix Vol. 3
			- `RadioLegionIntermission6Syndicate` for Nora's Mix Vol. 2
			- `RadioLegionIntermission5Syndicate` for Nora's Mix Vol. 1
			- `RadioLegionIntermission4Syndicate` for Nora's Choice
			- `RadioLegionIntermission3Syndicate` for Intermission III
			- `RadioLegion3Syndicate` for Glassmaker
			- `RadioLegionIntermission2Syndicate` for Intermission II
			- `RadioLegion2Syndicate` for The Emissary
			- `RadioLegionIntermissionSyndicate` for Intermission I
			- `RadioLegionSyndicate` for The Wolf of Saturn Six