dmiddlecamp / airmash-server

Server implementation for the game AIRMASH

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AIRMASH Server

Gitter chat

This is an implementation of a server for the game AIRMASH. As of this moment it aims to be fully compatible with the official servers.

Building the server

The quickest way to start a test server is using Docker. To do this run

docker-compose up

in the root directory of this repository.

For more in-depth dev work, it will be easier to use a local install of rust nightly. To install rust see here.

The central server code is located in server. Code for the CTF game mode is contained within ctf, base contains a game mode that has no addition features and should be used for testing.

To run a basic server locally, do

cargo run

within the base folder.

Compiler Version

Note that rust nightly is required. Current master builds using:

rustc 1.37.0-nightly (400b409ef 2019-06-09)

Logging in to the server

To access the server locally, run a server hosting the files here locally, then open that server in a web browser (e.g. localhost:8000) and use as a normal airmash client.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

Server implementation for the game AIRMASH

License:Apache License 2.0


Languages

Language:Rust 99.3%Language:Dockerfile 0.7%