From 4f1ac10af51ece83bee0fa30b519382cdd6ed6fc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nils=20Kr=C3=BCger?= <radsteve@radsteve.net>
Date: Fri, 1 Nov 2024 01:18:35 +0100
Subject: [PATCH] doc: add notice for spigot module not working on paper

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 49719be..326115c 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,11 @@ public class MyPlugin extends JavaPlugin {
 }
 ```
 
+> [!CAUTION]
+> The Spigot module does not function on Paper. Please use the Paper module and check what the server
+> is running on, and decide based on that. The Spigot module uses reflection into internals which are
+> renamed on Paper due to mojang mappings at runtime.
+
 This will register an HTTP injector which will respond with `Hello, from Minecraft!`
 to any HTTP request to the Minecraft port.