Giter Club home page Giter Club logo

edelstein's Introduction

Edelstein Build

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

๐Ÿš€ Getting started

โœจ Usage

Prerequisites

Download a release

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

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

Update configuration and migrations

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

Running the server

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

  1. Run the HOST=127.0.0.1 docker compose up command
  2. 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>
  1. Remember to set your Github Username and Personal Access Token!

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

๐Ÿ“ฆ Extra Stuff

โญ๏ธ Acknowledgements

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

edelstein's People

Contributors

kaioru avatar bia10 avatar razfriman avatar matthieutran avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.