From 9436627b03dcb9a32e713f4967c59471afde77b6 Mon Sep 17 00:00:00 2001 From: Thunderblade73 <85900443+Thunderblade73@users.noreply.github.com> Date: Sat, 26 Oct 2024 03:51:22 +0200 Subject: Backend; Contributing.md Added our two Optional Plugins (#2817) --- CONTRIBUTING.md | 54 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 31 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8229a00d5..53ec5bc27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -153,6 +153,37 @@ for more information and usages. - When updating a config option variable, use the `ConfigUpdaterMigrator.ConfigFixEvent` with event.move() when moving a value, and event.transform() when updating a value. [For Example](https://github.com/hannibal002/SkyHanni/blob/e88f416c48f9659f89b7047d7629cd9a1d1535bc/src/main/java/at/hannibal2/skyhanni/features/gui/customscoreboard/CustomScoreboard.kt#L276). - Use American English spelling conventions (e.g., "color" not "colour"). +## Additional Useful Development Tools + +### DevAuth + +[DevAuth](https://github.com/DJtheRedstoner/DevAuth) is a tool that allows logging in to a Minecraft account while +debugging in IntelliJ. This is very useful for coding live on Hypixel without the need to compile a jar. + +- The library is already downloaded by Gradle. +- SkyHanni will automatically set up DevAuth. +- Start Minecraft inside IntelliJ normally. + - Click on the link in the console and verify with a Microsoft account. + - The verification process will reappear every few days (after the session token expires). + +### Hot Swap + +Hot Swap allows reloading edited code while debugging, removing the need to restart the whole game every time. + +We use [dcevm](https://dcevm.github.io/) and the IntelliJ +Plugin [HotSwap Agent](https://plugins.jetbrains.com/plugin/9552-hotswapagent) to quickly reload code changes. + +Follow [this](https://forums.Minecraftforge.net/topic/82228-1152-3110-intellij-and-gradlew-forge-hotswap-and-dcevm-tutorial/) +tutorial. + +### [Live Plugin](https://plugins.jetbrains.com/plugin/7282-liveplugin) + +Allows project specific plugins to run. Eg: Regex Intention + +### [Live Templates Sharing](https://plugins.jetbrains.com/plugin/25007-live-templates-sharing) + +Imports our custom live templates automatically. Live Templates allow for quicker code writing. + ## Software Used in SkyHanni ### Basics @@ -218,29 +249,6 @@ For info on usage, look at [DiscordRPCManager.kt](https://github.com/hannibal002 We use the [auto update library](https://github.com/nea89o/libautoupdate) from nea89. -## Additional Useful Development Tools - -### DevAuth - -[DevAuth](https://github.com/DJtheRedstoner/DevAuth) is a tool that allows logging in to a Minecraft account while -debugging in IntelliJ. This is very useful for coding live on Hypixel without the need to compile a jar. - -- The library is already downloaded by Gradle. -- SkyHanni will automatically set up DevAuth. -- Start Minecraft inside IntelliJ normally. - - Click on the link in the console and verify with a Microsoft account. - - The verification process will reappear every few days (after the session token expires). - -### Hot Swap - -Hot Swap allows reloading edited code while debugging, removing the need to restart the whole game every time. - -We use [dcevm](https://dcevm.github.io/) and the IntelliJ -Plugin [HotSwap Agent](https://plugins.jetbrains.com/plugin/9552-hotswapagent) to quickly reload code changes. - -Follow [this](https://forums.Minecraftforge.net/topic/82228-1152-3110-intellij-and-gradlew-forge-hotswap-and-dcevm-tutorial/) -tutorial. - ## 1.21 / Modern version development You might have noticed that while the SkyHanni source code is found in `src/`, the actual tasks for compiling, building and running the mod -- cgit