Added Readme

This commit is contained in:
Björn Dahlgren 2015-04-03 12:29:41 +02:00
parent ad555cb4e5
commit d2e39c3168

35
README.md Normal file
View File

@ -0,0 +1,35 @@
# Arma Server Admin
## Requirements
- Node.js, https://nodejs.org/
- Pre-installed Arma Server
## Supported Games
- arma1
- arma2
- arma2oa
- arma3
- cwa (does not support linux)
- ofp
- ofpresistance
## Config
Key | Description
--- | --- | ---
game | Which game server to launch, see above
path | Folder path to game server
port | Web port to use
type | Which kind of server to use, can be 'linux', 'windows' or 'wine'
## How to Use
1. Copy `config.js.example` to `config.js`
2. Change values in `config.js` as described above or in the file
3. Install all dependencies with `npm install`
4. Launch the web UI with `npm start`