Skip to content

Latest commit

 

History

History
181 lines (144 loc) · 4.96 KB

README.md

File metadata and controls

181 lines (144 loc) · 4.96 KB
Raw

Logo

Khyron Realm - Darkrift Server

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Project Structure
  6. Necessary Plugins
  7. License
  8. References

About The Project

The repository contains the Darkrift 2 Console Application with the Khyron Realm Game plugin that is deployed on the Google Cloud ComputeEngine virtual machine.

Built Using

Getting Started

Installation (user application)

  1. Clone the repo 
    git clone https://github.com/khyron-realm/khyron-realm-darkrift-server.git
  2. Go into folder 
    cd khyron-realm-darkrift-server
  3. Set permissions to run the script 
    chmod 755 Run.ps1
  4. Run the server script 
    ./Run.ps1

Installation (system process)

  1. Clone the repo 
    git clone https://github.com/khyron-realm/khyron-realm-darkrift-server.git
  2. Go into folder 
    cd khyron-realm-darkrift-server
  3. Copy service file to system services folder 
    sudo cp khyron-realm.service /lib/systemd/system/
  4. Reload the system process files 
    sudo systemctl daemon-reload
  5. Run the service 
    sudo systemctl start khyron-realm
  6. Run the service 
    sudo systemctl status khyron-realm
  7. Enable the service to run at boot time 
    sudo systemctl enable khyron-realm

Usage

More detailes can be found on Wiki

Roadmap

See the open issues for a list of proposed features (and known issues).

Project structure

< PROJECT ROOT >
    |
    |-- Data                                    # Folder with data generated by the server
    |
    |-- Lib                                     # Folder with required Libraries
    |    | -- Darkrift.Client.dll
    |    | -- Darkrift.dll
    |    | -- Darkrift.Server.Console.dll
    |    | -- Darkrift.Server.dll
    |    | -- BCrypt.Net.dll
    |    | -- System.Configuration.dll
    |    | -- System.Runtime.Serialization.dll
    |    | -- System.security.dll
    |    | -- System.Xml.Linq.dll
    |
    |-- Logs                                    # Folder with Logs generated by the server
    |
    |-- Plugins                                 # Folder with created Darkrift Plugins
    |    | -- Unlimited-MiningGame-Plugin.dll   # Unlimited Mining game server plugin       
    |
    |-- README.MD                               # Readme file
    |
    |-- Run.ps1                                 # Run server script
    |-- khyron-realm.service                    # System service file
    |-- Server.config                           # Server configurations
    |
    |-- ************************************************************************

Necessary Plugins

  1. Khyron Realm networking plugin

License

CC BY-NC-SA 4.0

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

CC BY-NC-SA 4.0

References

  1. Readme Template adapted from Othneil Drew / Best-README-Template.