Getting started

Installation and requirements

Requirements#

  • Spigot or Paper 1.8.8 or newer. The plugin is built against the 1.8.8 API and tested on Paper 1.21.8.
  • Java 8 or newer.
  • StrikePractice, installed and working. StrikeBoards will not load without it.
  • PlaceholderAPI is optional and only needed for the placeholders.
  • One free TCP port for the website. The default is 8123.

Install#

  1. Put StrikeBoards-2.0.1.jar in your plugins/ folder and restart the server.
  2. Open http://<your-server-ip>:8123/ in a browser.
  3. Set your server name and IP with /sb set server-name My Server and /sb set server-ip play.myserver.net.
  4. For a domain or HTTPS, put Nginx, Caddy or Cloudflare in front of the site and set web.public-url. See the Domain and HTTPS section.
Port not reachable?

Many hosts only open the game port. Ask your host for a second port, or open 8123 in your firewall. You can change the port with web.port in config.yml.

Files the plugin creates#

Path in plugins/StrikeBoards/What it is
config.ymlAll settings. Your edits are kept on update; new keys are added automatically.
messages.ymlEvery in-game message (game:) and every website string (site:).
web/The extracted website files.
themes/<name>/theme.cssYour own themes (you create these).
data/matches.ymlRecorded fight history.
data/elo-history.ymlELO chart data.
data/skins.ymlSkins captured when players join.
data/seasons.yml and data/seasons/Season counter and archived seasons.