GettingStarted

Getting Started

Setting up the server

1. Create a new Minecraft server running a version of Spigot, it should work on all spigot servers v1.13.2+.

This has been tested, and confirmed working, on:

• v1.13:
  • Paper v1.13.2
• v1.14:
  • Paper v1.14.4
• v1.15:
  • Paper v1.15.2
• v1.16:
  • Paper v1.16.5
• v1.17:
  • Paper v1.17.1
• v1.18:
  • Paper v1.18.1
  • Paper v1.18.2
  • Magma v1.18.2
• v1.19:
  • Paper v1.19

Note: versions, and distributions not listed may work, but have not been tested.
If you wish to a specific distro/version tested, please ask in the StreamerBot Discord Server.

2. Put the Plugin in the server's plugins folder, and restart the server.
3. Set up the config file in the server's plugins folder.

Host: The IP/Domain of the minecraft server

• All incoming connections will need to connect through this supplied host.
  • Eg: host: localhost, port: 8887, then to connect to the server, use ws://localhost:8887 Port: The Port that the WebSocket Server will run on
• If this port is already in use, it will throw a java.net.BindException Exception. If this occurs, please change the port in the config, and restart the server. Debug: Toggle debug logs
• If true, logs used to help debug will be printed in the server console. Log Failed Auth: Log when a client fails authentication
• If true, whenever a client attempts to connect, and fails to authenticate, a message will be logged in the server console. Auth: The authentication token used to verify clients
• When connecting, the client will be asked to authenticate, this token will need to be supplied as a response.
• If this is left blank (auth:) then authentication will not be asked, or required. Blacklist: Commands that are not allowed to be ran by clients

Connecting to WebSocket Server

1. Connect to the WebSocket Server
   • If you don't know how to do this please read This Wiki
2. Once you have connected to the WebSocket Server, you will receive a message from the Server.
3. If you receive a message from the Server, you will see one the following:
   • Authentication not required...
   • Authentication needed... Send as "Bearer {Auth token}"
4. If you received the 2nd message, you will need to authenticate with the Server.
   1. You will need to send the Bearer token to the Server.
   2. The Server will send back a message with the Authentication Status, you will see one of the following:
      • Successfully Authenticated...
      • Incorrect Authentication Bearer token supplied!
   3. If you received the 2nd message, your token that you sent was incorrect. Otherwise, you have successfully authenticated with the Server.
5. You will now be able to send commands to the Server.

Sending Commands to the Server

There are a few commands that you can send to the Server.

• Minecraft commands
  • These commands are default commands that Minecraft has, and Plugin commands installed on the Server.
  • These commands are sent as Command {Command}
    • For example, Command say Hello World
      • This will send the command say Hello World to the Server, and will result in Hello World will be sent to all players.
• Event commands
• These commands allow your client to opt-in/out of events on the server
  • These commands are sent as Listen {Event} and Ignore {Event}
  • For more information on events, please see the Events page.