Edelstein

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

🚀 Getting started

👨🏼‍💻 Developers

This project is built on .NET! make sure you have it installed before continuing.

Downloading required assets

1. Download the scripts from Server.Scripts
2. Download the data from Server.NX
3. Unzip both into their own folders

Running the server

1. cd src/app/Edelstein.Daemon.Server
2. cp appsettings.json appsettings.Production.json
3. Edit the appsettings.Production.json appropriately (remember to set the scripts and data path!)
4. dotnet run

🏗️ Builds

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

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.

Installing packages

Now that your NuGet sources is all set up and authenticated, you can now install nightly builds of Edelstein.

See the packages tab for an index of the packages!

📦 Extra Stuff

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

⭐️ Acknowledgements

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