diff --git a/CHANGELOG.md b/CHANGELOG.md index b73a081..d5897dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ ## Changes -- Rewritten for 1.20.2 +- Rewritten for 1.20.4 - Fixed config saving bug - Allow debug help translations in all languages - Added button tooltips to debug key screen diff --git a/README.md b/README.md index 0c6e1aa..f21bc5c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![](http://cf.way2muchnoise.eu/full_debug-keybind_downloads.svg?badge_style=for_the_badge)](https://www.curseforge.com/minecraft/mc-mods/debug-keybind) [![](https://raw.githubusercontent.com/Boxadactle/coordinates-display/3a9f7f5a3592c7888b387160595f89f74f756da2/img/modrinth.svg)](https://modrinth.com/mod/debug-keybind) [![](https://raw.githubusercontent.com/Boxadactle/coordinates-display/c47768fbc605863978b6c88ca3c4fcac4a5885da/img/github.svg)](https://github.com/Boxadactle/DebugKeybind)

Ever felt annoyed that you needed to press FN + F3 JUST to open the F3 menu on a laptop?

@@ -5,7 +6,7 @@

WELL ME TOO!

-# ⌨ Debug Keybind (the solution) +# Debug Keybind (the solution)
debug keybinds screen
@@ -17,21 +18,46 @@ Don't like **F3+G**? It can be rebound in the exact same way. **Just open the debug keybinds menu, and you'll be on your way!** -## 👤 How do I open the Debug Keybinds menu? +## How do I open the Debug Keybinds menu? Opening the menu is super simple. You can open it from your modloader's Config Screen, but it can also be opened with a conveniently placed button placed next to the normal keybinds button!
new controls screen
-## 🎮 Mod Dependencies? +## Features +- Bind any key on your keyboard to activate individual debug actions or combinations. +- Enhance gameplay convenience by placing these keys at your fingertips. +- Improve accessibility for users with specific keyboard layouts or preferences. -### Fabric/Quilt Dependencies -The Fabric version of DebugKeybind doesn't immediately require any external mods. However, [Mod Menu](https://modrinth.com/mod/modmenu) is nice if you don't want to navigate the minecraft options menus. +## Installation/Dependencies -### Forge Dependencies -The Forge version of DebugKeybind does not require any dependencies. +#### This mod requires [BoxLib](https://modrinth.com/mod/boxlib) a Client-side library mod developed by me. -## 🛠 Building +1. **Install Minecraft Forge/Fabric/Neoforge:** Download and install the appropriate modloader for your Minecraft version. +2. **Download the mod:** Download the latest release of Debug Keybind for your specific modloader and Minecraft version +3. **Download BoxLib:** Download the latest release of [BoxLib](https://modrinth.com/mod/boxlib) for your specific modloader and Minecaft version +4. **Place the mod jars:** Drop the downloaded jar files into your Minecraft mods folder. The location of this folder varies depending on your operating system. + +### Fabric Dependencies +[![Requires Fabric API](https://i.imgur.com/Ol1Tcf8.png)](https://www.curseforge.com/minecraft/mc-mods/fabric-api) + +[Mod Menu](https://modrinth.com/mod/modmenu) is recommended for configuration purposes. + +### Forge/NeoForge Dependencies +This mod requires [BoxLib](https://modrinth.com/mod/boxlib) a Client-side library mod developed by me. + +## Contributing + +We encourage contributions! Don't hesitate to open issues or pull requests through the [GitHub Repository](https://github.com/Boxadactle/DebugKeybind). Your input helps the mod improve and evolve. + +### Translations +We welcome translations! If you're interested in translating this mod, please locate the [localization files](https://github.com/Boxadactle/DebugKeybind/tree/latest/common/src/main/resources/assets/debugkeybind/lang) and submit a pull request. Your contributions help make the mod accessible to more users worldwide. + +### Support + +If you encounter any issues, please [open an issue](https://github.com/Boxadactle/DebugKeybind/issues/new/choose) on the GitHub repository. + +## Building If you'd like to build this mod on your own machine, follow these steps. diff --git a/common/src/main/java/dev/boxadactle/debugkeybind/DebugKeybindMain.java b/common/src/main/java/dev/boxadactle/debugkeybind/DebugKeybindMain.java index 8e74933..e5cea8a 100644 --- a/common/src/main/java/dev/boxadactle/debugkeybind/DebugKeybindMain.java +++ b/common/src/main/java/dev/boxadactle/debugkeybind/DebugKeybindMain.java @@ -13,7 +13,7 @@ public class DebugKeybindMain { public static final String MOD_ID = "debugkeybind"; - public static final String VERSION = "9.1.0"; + public static final String VERSION = "01.0.0"; public static final String VERSION_STRING = MOD_NAME + " v" + VERSION; @@ -29,8 +29,6 @@ public static void init() { LOGGER.info("Initializing " + VERSION_STRING + "..."); CONFIG = BConfigHandler.registerConfig(KeybindConfig.class); - -// BCommandManager.register(F3Command.create()); } } diff --git a/gradle.properties b/gradle.properties index 30fee24..28b85a0 100644 --- a/gradle.properties +++ b/gradle.properties @@ -3,24 +3,24 @@ org.gradle.jvmargs=-Xmx2G org.gradle.parallel=true # Mod properties -mod_version = 9.1.0 +mod_version = 10.0.0 maven_group = dev.boxadactle archives_name = DebugKeybind enabled_platforms = fabric,forge # Minecraft properties -minecraft_version = 1.20.2 +minecraft_version = 1.20.4 # Dependencies fabric_loader_version = 0.15.11 -fabric_api_version = 0.91.6+1.20.2 -forge_version = 48.1.0 +fabric_api_version = 0.97.1+1.20.4 +forge_version = 49.1.4 -modmenu_version = 8.0.1 -boxlib_version = 11.3.2 +modmenu_version = 9.2.0 +boxlib_version = 12.1.3 #publishing -game_versions = 1.20.2,1.20.1 +game_versions = 1.20.4,1.20.3 project_id_curseforge = 901782 project_id_modrinth = DX9ioka8 release_type = release