Diarkis Server Template

Introduction

Diarkis provides an OSS server template to help you start development quickly.

https://github.com/Diarkis/diarkis-server-template

The server template is a highly versatile template designed to help developers kickstart their projects quickly. This template includes minimal default settings and is designed to be extendable to meet various project requirements.

Starting a Server Using the Server Template

Please refer to the tutorial Launching Diarkis Server in a Local Environment.

Alternatively, you can refer to the diarkis-server-template README.

Directory Structure of the Server Template

The following information is for v1.0.0.

For the latest information, refer to src/README.md of diarkis-server-template.

.
├── bot # Directory containing various bots
│   ├── dm 
│   ├── field 
│   ├── group
│   ├── matchmaker # Bot using the host and Search features of matchmaker
│   ├── matchmaker-ticket # Bot using the Ticket feature of matchmaker
│   ├── resonance # Bot that performs load testing on a simple custom command (resonance command) implemented in the template
│   ├── room
│   ├── scenario # Template for executing scenario tests; includes README
│   └── utils
├── build # Templates for cloudbuild
├── cloud # Contains construction procedures for Diarkis clusters for various public clouds
│   ├── aws
│   ├── azure
│   └── gcp
├── cmds # Intended implementation sections; organized by module
│   ├── custom
│   ├── dm
│   ├── http
│   ├── matchmaker
│   └── room
├── coderefs # Since Diarkis is closed-source, files for IDEs, etc. are provided to enable autocompletion
│   └── v0.9.25
├── configs # Configuration files for Diarkis servers
│   ├── connector
│   ├── http
│   ├── mars
│   ├── shared
│   ├── tcp
│   └── udp
├── connector # Functionality to co-locate Diarkis with another server. Refer to additional documentation.
├── diarkis-cli # Binaries for building code using Diarkis
│   └── os
├── docker # Dockerfiles for creating containers with Diarkis
│   ├── bot
│   ├── configs
│   ├── http
│   ├── log
│   ├── mars
│   ├── tcp
│   └── udp
├── healthcheck # Health check using Diarkis protocols
├── k8s # Manifests
│   ├── aws
│   ├── azure
│   ├── gcp
│   └── linode
├── lib # 
│   ├── meshCmds
│   ├── onlinestatus
│   └── payload
├── mars # Entry point for mars
├── mars-stats # Tools for investigating mars
├── puffer # Settings files and output destinations for puffer, which is used to auto-generate packet definitions when implementing new Diarkis commands
│   ├── cpp
│   ├── cs
│   ├── go
│   └── json_definitions
├── remote_bin # Outputs Diarkis server binaries
├── script 
└── servers # Entry points
    ├── connector
    ├── http
    ├── tcp
    └── udp