Skip to content

Getting Started

RedPolygon edited this page Nov 28, 2021 · 10 revisions

For this plugin to work, you need to already have a web server yourself! It is mainly meant for people that already have a website for their Minecraft server.

On Minecraft server

  1. Download the .jar file from the latest release and place it in the plugins/ folder, like you would with any plugin.
    (note: if you downloaded from the Spigot resources page, you will get a .zip file with the files needed for both the minecraft server and the web server)

  2. Open a port for the plugin to communicate over.

  3. Restart your server to let it generate the config file. Change the port number in plugins/WebStats/config.yml to the one you opened in the previous step.

On Web server

  1. Download the web.zip file from the latest release, and upload the .js files to a directory on your web server.
    (note: if you downloaded from the Spigot resources page, the files you need are in that zip file, along with the .jar)

  2. Have a look at /web/example/index.html. It contains a basic starting point for you to use, along with some nice-to-have features. The most important things are:

    1. Include the JavaScript files
    2. Initialise WebStats when the page is loaded

Further steps

TODO

Clone this wiki locally