Edelstein

A v.95.1 Mushroom game server emulator written in C#.

🚀 Getting started

✨ Usage

Prerequisites

• A running PostgreSQL server!
• That's mostly it..

Download a release

1. Check the releases tab and download the correct bundle based on your OS!

Download required assets

2. Download the data from Server.NX
3. Download the scripts from Edelstein.lua or Server.Scripts (for older builds)
4. Unzip both into the data and scripts folder respectively

Update configuration and migrations

5. Edit the appsettings.json file to the appropriate settings
6. Run the scripts in with the migrate prefix in sequence

Running the server

7. Run the Edelstein.Daemon.Server executable

📦 Docker

Download required assets

1. Download the data from Server.NX
2. Download the scripts from Edelstein.lua or Server.Scripts (for older builds)
3. Unzip both into the data and scripts folder respectively

Running docker compose up

4. Run the HOST=127.0.0.1 docker compose up command
5. Do substitute or omit the HOST environment key accordingly

🏗️ Builds

A nightly build is published at 00:00 UTC when there are changes to the 'dev' branch.

• Executables are available under releases tab with the nightly tag
• Protocol and Common libraries are pushed to packages

Setting up your project for Github Packages

1. Create a Personal Access Token with the 'read:packages' scope
2. Create a nuget.config file on your project root with the following contents:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <clear />
        <add key="github" value="https://nuget.pkg.github.com/Kaioru/index.json" />
    </packageSources>
    <packageSourceCredentials>
        <github>
            <add key="Username" value="GITHUB_USERNAME" />
            <add key="ClearTextPassword" value="GITHUB_PERSONAL_ACCESS_TOKEN" />
        </github>
    </packageSourceCredentials>
</configuration>

3. Remember to set your Github Username and Personal Access Token!

Check the here for more on how to setup the NuGet registry.

📦 Extra Stuff

• Server.NX - the source for the Server.nx file.
• Edelstein.lua - various scripts for use with Edelstein.

⭐️ Acknowledgements

• Rebirth - lot's of referencing from here.
• Destiny - even more referencing from here.