This is a Node.js wrapper and authentication frontend for the Bukkit Minecraft server.
The bukkit/
directory contains the Bukkit Minecraft server and its relevant configuration files.
The web/
directory contains the code for the Node.js/Express web frontend for the Minecraft server.
Preferred version in parentheses.
- Java JRE 64-bit (v1.8.0)
- Node.js (v8.6.0)
- Yarn (v1.1.0)
- Bukkit (v1.5.2-R1.0) - already included in
bukkit/
directory
yarn start
will start both the web server and Bukkit Minecraft server.
By default, the web server listens on port 80, and the Bukkit server listens on port 8080, although this can be changed setting the PORT
and MINECRAFT_PORT
environment variables.
On a first run, run yarn setup
to create the database tables.
To run the server as a daemon (in the background), run yarn forever
.
.env.example
contains an example environment file. To set environment variables, copy .env.example
to .env
and fill in desired environment variables.
You can visit http://localhost/admin, or type commands straight into the console used to create the server. Standard input will be piped to the Bukkit instance.
yarn watch
will start both the web server and the Bukkit Minecraft server, and will restart both when changes are made to server-side JavaScript files.
Before committing to git, please format, lint, and test your code.
# Runs Prettier
yarn format
# Runs ESLint
yarn lint
# Runs Jest
yarn test