README.md

# OpenJam Servers

A collection of open source servers for FreeJam games

## Usage

### CardLife

To get CardLife to use these servers, replace the `ServerConfig.json` file in the game files with [this ServerConfig.json](assets/cardlife/ServerConfig.json).

### Robocraft

To get Robocraft to use these servers, place [this servenvmulti.config](assets/robocraft/serenvmulti.config) file in the game files.

// TODO Don't expect people to run these servers on their own computer

## Privacy

The minimum amount of data is (and should be) collected to provide the expected functionality.
In most cases, these means no data is collected or logged except some debug log messages in development versions.
Some personal identifiers are sent but only exist ephemerally.
The exception is Robocraft servers, which store the minimum account info possible on disk.
This includes a unique user identifier, username, vehicle data, and user configuration data.
The current PC's MAC address is also sent to the server (this is a Robocraft client feature, it is not recorded by any server).

## Development

### Robocraft

Run all of the servers using their respective `run_debug.sh` scripts and use the `dev` profile in `servenvmulti.config` to point the game to your local dev servers.

It is possible to remove the obfuscation from the Robocraft's `Assembly-CSharp.dll` if you need to figure out how it expects the server to behave.

## Contributing

If you can program or are learning Rust, pull requests are appreciated! If you can't and would prefer not to learn, reporting issues is also welcome.

If you'd like to discuss, contact NGnius on Signal `rfc.1149` or email `ngniusness@gmail.com`. I'll make a Signal group chat if there's enough interest.

# Acknowledgements

A big thanks to the RC15 team for their work on deobfuscating Robocraft .NET assemblies and specifically to RandomScientist for hooking me up with a deobfuscated assembly. Without them, progress would have been too slow and frustrating.

Thanks for the moral support from community members who reached out and the few IRL people who I went into unnecessary detail with.
Add some useful info files 2025-01-25 18:20:07 -05:00			`# OpenJam Servers`

			`A collection of open source servers for FreeJam games`

			`## Usage`

			`### CardLife`

Add server for game data (implement login sequence) 2025-02-12 18:46:27 -05:00			To get CardLife to use these servers, replace the `ServerConfig.json` file in the game files with [this ServerConfig.json](assets/cardlife/ServerConfig.json).
Add some useful info files 2025-01-25 18:20:07 -05:00
			`### Robocraft`

Add server for game data (implement login sequence) 2025-02-12 18:46:27 -05:00			`To get Robocraft to use these servers, place [this servenvmulti.config](assets/robocraft/serenvmulti.config) file in the game files.`
Add basic RC steam and user/pass authentication 2025-01-27 19:52:57 -05:00
			`// TODO Don't expect people to run these servers on their own computer`
Add some useful info files 2025-01-25 18:20:07 -05:00
			`## Privacy`

Move common components to shared lib 2025-03-30 16:22:25 -04:00			`The minimum amount of data is (and should be) collected to provide the expected functionality.`
			`In most cases, these means no data is collected or logged except some debug log messages in development versions.`
			`Some personal identifiers are sent but only exist ephemerally.`
			`The exception is Robocraft servers, which store the minimum account info possible on disk.`
			`This includes a unique user identifier, username, vehicle data, and user configuration data.`
Update configs for release ready 2025-04-02 20:59:52 -04:00			`The current PC's MAC address is also sent to the server (this is a Robocraft client feature, it is not recorded by any server).`
Complete bare minimum to seem logged in 2025-03-01 16:22:57 -05:00
			`## Development`

			`### Robocraft`

			Run all of the servers using their respective `run_debug.sh` scripts and use the `dev` profile in `servenvmulti.config` to point the game to your local dev servers.
Add some contributing info 2025-03-11 22:55:57 +00:00
Move common components to shared lib 2025-03-30 16:22:25 -04:00			It is possible to remove the obfuscation from the Robocraft's `Assembly-CSharp.dll` if you need to figure out how it expects the server to behave.

Add some contributing info 2025-03-11 22:55:57 +00:00			`## Contributing`

Move common components to shared lib 2025-03-30 16:22:25 -04:00			`If you can program or are learning Rust, pull requests are appreciated! If you can't and would prefer not to learn, reporting issues is also welcome.`
Add some contributing info 2025-03-11 22:55:57 +00:00
			If you'd like to discuss, contact NGnius on Signal `rfc.1149` or email `ngniusness@gmail.com`. I'll make a Signal group chat if there's enough interest.
Update configs for release ready 2025-04-02 20:59:52 -04:00
			`# Acknowledgements`

			`A big thanks to the RC15 team for their work on deobfuscating Robocraft .NET assemblies and specifically to RandomScientist for hooking me up with a deobfuscated assembly. Without them, progress would have been too slow and frustrating.`

			`Thanks for the moral support from community members who reached out and the few IRL people who I went into unnecessary detail with.`