openlegends-server 0.3.0

OpenLegends Game Server
Documentation

OpenLegends Game Server

build crates.io

OpenLegends socket server to play multiplayer game

[!IMPORTANT] Project in development!

Install

Dependencies

Rust

Use rustup installer to setup latest Rust environment:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Server

cargo install openlegends-server

Setup

Launch

Arguments

  • --address, -a required, server host:port to listen incoming connections
  • --identity, -i required, filepath to server identity in PKCS (PFX) format
  • --password, -p optional, unlock encrypted identity by passphrase

Start

openlegends-server --address 127.0.0.1:4321 --identity path/to/server.pfx

Commands

[!NOTE]

  • Server requires from client TLS 1.2 certificate as the user identity
  • Request size limited to 1024 bytes
  • See also official client and shared server API libraries

Server

Request

server/about\r\n

Response

{
    "version": "string"
}

Request

server/status\r\n

Response

{
    "online": "bool"
}

User

Request

user/register\r\n
{
    "username": "string"
}

Response

{
    "success": "bool",
    "message": "string"
}