From 4be0cf550c418d63177eff77b7bd1fafd988b73c Mon Sep 17 00:00:00 2001 From: Marotheit Date: Mon, 6 May 2024 02:03:07 -0600 Subject: [PATCH] Create README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..944b3dc --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# FunctionHotkeyFix +### Provides permission node support for the F3+F4 (or F3+N) Gamemode Switcher hotkey. +This project would not be possible without [RodneyMKay](https://github.com/SlimeNexus/F3NPerm). He did all the heavy lifting, I have simply updated the plugin for my personal needs. + +This plugin will enable the Gamemode Switcher hotkeys (F3+F4 or F3+N) to work properly when the player has the `minecraft.command.gamemode` permission. The plugin also contains a LuckPerms hook to enable instant permission recognition, but will function fine without it. +

+ +## How to Compile + +```bash +# Test gradle to ensure your environment is acceptable. +./gradlew test +``` +```bash +# Build plugin jar file; The destination directory for the plugin file will be `\build\libs\`. +./gradlew build +``` + +This plugin was designed to be reliable and lightweight. It does not use any non-public APIs. +Please report any issues, and I will see what I can remedy.