UNPKG

maniajs

Version:

ManiaPlanet (Dedicated) Server Controller.

34 lines (22 loc) 1.82 kB
# ManiaJS [![Join the chat at https://gitter.im/ManiaJS/ManiaJS](https://badges.gitter.im/ManiaJS/ManiaJS.svg)](https://gitter.im/ManiaJS/ManiaJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Dependency Status](https://www.versioneye.com/user/projects/56bc63ef2a29ed0034380562/badge.svg?style=flat)](https://www.versioneye.com/user/projects/56bc63ef2a29ed0034380562) [![NodeJS Version](https://img.shields.io/badge/NodeJS-4.0%2B-80bd01.svg)]() [![GitHub license](https://img.shields.io/badge/license-ISC-blue.svg)](https://raw.githubusercontent.com/ManiaJS/ManiaJS/master/LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/grade/895aead1328043e799ce0e82d3274948)](https://www.codacy.com/app/tomvalk/Mania-JS) [![Code Climate](https://codeclimate.com/github/ManiaJS/ManiaJS/badges/gpa.svg)](https://codeclimate.com/github/ManiaJS/ManiaJS) **Note, the controller is in heavy development right now!** # Installation **Outdated information. A CLI tool is in development to init and manage ManiaJS installations!** 1. Follow the [installation instructions for installing NodeSource](https://github.com/nodesource/distributions#debinstall) 2. Make sure NodeJS has been succesfully installed (check `npm -v`) 3. Clone the git repository (`git clone https://github.com/ManiaJS/ManiaJS.git` via git, or download the zip) 4. Move the `config.dist.yaml` to `config.yaml` and make sure to enter all information in that file 5. Install all dependencies by using: `npm install` # Getting started **A CLI tool is in development to init and manage ManiaJS installations!** To start the controller, open a terminal in the installation folder and run the following command: ``` npm start ``` (run npm install after installing, before executing npm start)