Home

Serenity Bridge Documentation

Welcome to the Serenity Bridge documentation! This guide will help you set up and configure Serenity Bridge to integrate your Minecraft and Discord servers for enhanced functionality! If you have any questions or feedback, message palm1 on discord, or if you've found an issue, create an Issue on this page.

Table of Contents

1. Introduction
2. Installation
3. Troubleshooting
4. Events
5. Embedding
6. Relays
7. Emojis
8. Contributing
9. License

Introduction

Serenity Bridge is a plugin designed to integrate your Minecraft and Discord servers. It allows you to log various server events to a Discord channel, providing real-time notifications and enhancing community engagement, and can even serve as a directly bridge to relay chat messages from and to discord, among other features.

For developers, Serenity Bridge also has an API that can be used to send alerts to your discord server through your own plugins, without the hassle of setup.

Installation

To install Serenity Bridge, follow these steps:

1. Grab the latest release, and put the .sjs file that you download into your /plugins/ folder.
2. Run your server once, so it loads the plugin.
3. Go into the new folder, then into the /config/ folder, and make the changes to the configuration files that you want.
4. Set your bot's token and channel ID in properties.scfg. (If you do not know how to do this, see the tutorial at the top of the file.)
5. Save your changes, and you're done! Start up your server to begin bridging!

Troubleshooting

Here are some common issues you might encounter, and how to fix them:

• [Error] InvalidToken
  • This error occurs when the token being used in your config is invalid; this could either mean you didn't set it, misspelled it, or it might have expired or been changed since you put it in.
• [Error] Channel not found.
  • This error occurs when the channel ID you've put in is invalid. Make sure you've put in a real channel ID, and that the channel hasn't been deleted, removed, etc. This can also occur if the channel is not a basic text channel, so make sure you the channel matches the correct type.