Skip to content

Getting Help The Right Way

Matej edited this page May 18, 2024 · 1 revision

If you have a question or a bug to report, this page guides you on how to get the quickest and most efficient response.

Where To Get Help

  1. To get the official support given by developers, open a ticket on GitHub.
  2. To chat with our volunteers and community, join our Discord.

Reading Stack Traces

Stack traces are essential to allow you to see where exactly the problem lies. Make sure you always check your startup log and console for any errors when having issues. Paste the entire error log to pastebin.com.

When having that annoying error popping in your console, something went unexpected. To protect your data, the plugin rather shuts itself down than corrupting configuration files.

The key to understanding stack traces is to read them. For some people, this is a matter of course, but sometimes (oftentimes) I receive issues that could easily be solved by just reading the error itself.

Many times it will tell what you need to do. Here, for example, settings contain a value that cannot be set. I recommend checking the file content on this website.

Ugly Error

Other times it might be something else; take a bit of time to read and try to understand the error stack before posting issues. Also, make sure your Java and server meet minimum requirements, see Compatibility.

Before You Report

  1. Give it ten minutes and experiment. Either you do it, or I do it. We have limited time, and I would rather spend it on actual development and adding new features to the product.

  2. Be clear and provide steps to reproduce when opening a ticket.

Bad: Plugin doesn't work at all!

Good: I would like the Crate item to be confiscated in hardcore and creative world, however it's confiscated everywhere. Here is my /protect debug ... please see rules/main.rs line 27 for the rule. I am using Protect X.Y.Z, LuckPerms X, and Paper X. Is there anything I could have done wrong there?

  1. Ensure no similar issue already exists. Use Search or 'CTRL + F'.

What You Should NEVER Do

  • Reloading (/reload, PlugMan, ..) may cause issues. Do a clean server restart first.
  • Never edit any files on a running server.
  • Run the latest version of Protect on all of your servers. DO NOT RUN DIFFERENT VERSIONS OF THE PLUGIN IF YOU HAVE BUNGEE NETWORK, THIS WILL BREAK.
  • Run the newest server for your server version (last 1.20.x, or last 1.8.8 build, etc.).
  • Run the correct (usually latest) versions of dependencies (pay special attention to ViaVersion, ProtocolLib, EssentialsX, and others)

All the best running Protect and ask out if you need help!