Server Setup (for admins)

Danger

BlazingGames is unfinished and we make breaking changes at every update. Avoid setting up a server or writing plugins integrating with it for now.

Prerequisites

• Most features require Blazing Web, which needs an open port.
  • HTTPS is preferred but technically optional.
  • This is used for serving resource packs and API routes.
• Your server MUST run Paper. Bukkit and Spigot will not detect BlazingGames as a plugin.
• Ideally, you should run the Minecraft version that BlazingGames supports, or newer. Old versions and experimental paper builds are unsupported.

Installing the plugin

1. Grab the latest release from Codeberg, and place it in your plugins folder.

2. Restart the server. Once it starts, stop it again.

3. Enable or disable any features you’d like in the various configuration files.

   To learn about each feature, view its page in the wiki in the sidebar.

   Note that if you disable a feature, you should disable all other features that depend on it, otherwise the server will crash.

   You should spesifically pay attention to these files:

   • blazing_web.yml contains settings for the HTTP server, make sure that its port is reachable from the outside. Ideally set up HTTPS as well.

4. Once you’re done, start the server.

   Reloads are entirely unsupported and are impossible with how the plugin is architectured.

Server folder structure

Brief overview:

• server.jar your paper server
• Directoryplugins/

  • Directoryblazinggames/

    • config.yml main blazinggames config file
    • Directoryconfigs/ feature-spesific configuration files

      • Directoryotherplugin/ if other plugins add features, they’ll show up in a folder with the plugin’s name

        • otherpluginfeature.yml feature added by another plugin
      • somefeature.yml config a feature built into blazinggames
      • someotherfeature.yml another one
    • resourcepacks custom resource packs to use
    • pack.png icon of built-in resource pack
    • Directorydata/ blazinggames’s database (avoid touching)

      • …
    • state.json blazinggames’s state (avoid touching)
  • … other plugins
• … other server files

Inside blazinggames’s plugin folder, config.yml contains generic configuration, such as credentials, logging settings, and more.

BlazingGames contains many features that they each have their own file in the configs folder. If a feature comes from blazinggames it will be directly in this folder, otherwise it will be in a folder with the name of the plugin it came from.

If resource packs are enabled, resourcepacks and pack.png will also be created, where the former is a folder to place extra resource packs to enable and the latter is the thumbnail of the built-in generated pack. For more information, see the configuration file for resource packs.

Finally, data and state.json are used internally by BlazingGames to store data and state respectively. You should avoid touching these unless you know what you’re doing.