Hotswap - Revision history

Tmvkrpxl0 at 16:14, 6 October 2022

2022-10-06T16:14:01Z

Tmvkrpxl0 at 15:36, 6 October 2022

2022-10-06T15:36:07Z

Tmvkrpxl0 at 15:18, 6 October 2022

2022-10-06T15:18:01Z

Tmvkrpxl0: Guide about hot-swapping both code and resources

2022-10-06T13:32:41Z

Guide about hot-swapping both code and resources

New page

== What even is this? ==
Hot-swapping is a feature letting you to see code/resource changes in-game without restarting it.
This article is divided into 2 sections: Basic hot-swapping and schema change hot-swapping, as latter one requires more setup.

== Basic hot-swapping ==
Here, you would be able to swap out resource pack/data pack of your mod without restarting the game. You can also swap out code if only method's internal has been changed. You would still need to restart game if you added/removed/renamed method/variable/class.

@@ Line 1: / Line 1: @@
 {{Under construction}} <!-- Guide for other IDEs is missing -->
 == What is Hot-swapping? ==
-Hot-swapping is a feature letting you to swap-out parts of game without restarting it, allowing you to see resources and code changes quickly and tinker around with it more easily.
+Hot-swapping is a feature letting you to swap-out code of your mod without restarting game, allowing you to see changes quickly and tinker around with it more easily.
-{{Tip|It is recommended that you run the game with debug mode in order to use hot-swapping, as code changes will only get applied under debug mode.}}
+In this article, we will also be covering how to swap resources so that you can change models and textures, and see it in-game quickly.
-== Hot-swapping resources ==
+== Swapping resources ==
-=== Hot-swapping resources on Intellij Idea ===
+=== Swapping resources on Intellij Idea ===
 After you made changes to resource file, hit this "hammer icon", or build button.
 [[File:Intellij_idea_menu_for_hot_swap_doc.png]]
@@ Line 18: / Line 18: @@
 [[File:Debugmodeintellij.png]]
 === Hot-swapping code on Intellij Idea ===
-It's more simple than hot-swapping resources. After making changes to the code, just hit the build button. Then It will show you this message on bottom-left corner. If your mod project is big and it takes a long time to do so, hit <code>Build -> Recompile "currently opened file's name"</code>, this will only recompile file that is currently open. This option will not be visible if you don't have compile-able file opened. Files with extensions such as <code>.java</code> or <code>.kt</code> are compile-able.
+It's more simple than swapping out resources. After making changes to the code, just hit the build button. Then It will show you this message on bottom-left corner. If your mod project is big and it takes a long time to do so, hit <code>Build -> Recompile "currently opened file's name"</code>, this will only recompile file that is currently open. This option will not be visible if you don't have compile-able file opened. Files with extensions such as <code>.java</code> or <code>.kt</code> are compile-able.
 [[File:Hotswapmessage.png]]
 If you changed class's schematics then will show you error messages saying it is unsupported. Head to Applying schema changes section if you need to change schematics.
 === Applying schema changes ===
-This requires more setup and specific find of JDK, Jetbrains Runtime (JBR). The reason why JBR is suggested is that it has [https://dcevm.github.io/ DCEVM](It allows class schema change in debug mode) by default and requires less configuration than other JDKs, such as hot-swap agent and IDE-specific plugins, etc. Although, there isn't exactly "installer" for it, you would have to download and unpack it manually.
+This requires more setup and specific JDK, Jetbrains Runtime (JBR).
 ==== Downloading JBR ====
 Download JBR with right java version and platform from here: https://github.com/JetBrains/JetBrainsRuntime/releases
-There are many different "flavors" but I recommend you downloading "JBR (vanilla)" one if you don't know what are these.
+There are many different "flavors" but I recommend you downloading "JBR (vanilla)" one if you don't know what these are.
 After downloading has finished unpack it into suitable location
@@ Line 63: / Line 70: @@
 Then re-generate run configurations by running <code>genIntellijRuns</code>
-Done! Now launch one of these on debug mode and you can now change classes' schematic as much as you want, it will swap those just fine.
+Done! Now launch one of these on debug mode and you can now change classes' schematic as much as you want, and then hit build button. it will swap those just fine.
 [[File:Runconfigs.png]]

@@ Line 1: / Line 1: @@
 {{Under construction}} <!-- Guide for other IDEs is missing -->
 == What is Hot-swapping? ==
-Hot-swapping is a feature letting you to see code/resource changes in-game without restarting it.
+Hot-swapping is a feature letting you to swap-out parts of game without restarting it, allowing you to see resources and code changes quickly and tinker around with it more easily.
 {{Tip|It is recommended that you run the game with debug mode in order to use hot-swapping, as code changes will only get applied under debug mode.}}
@@ Line 18: / Line 18: @@
 [[File:Debugmodeintellij.png]]
 === Hot-swapping code on Intellij Idea ===
-It's more simple then hot-swapping resources. After making changes to the code, just hit the build button. Then It will show you this message on bottom-left corner. If your mod project is big and it takes a long time to do so, hit <code>Build -> Recompile "currently opened file's name"</code>, this will only recompile file that is currently open. This option will not be visible if you don't have compile-able file opened. Files with extensions such as <code>.java</code> or <code>.kt</code> are compile-able.
+It's more simple than hot-swapping resources. After making changes to the code, just hit the build button. Then It will show you this message on bottom-left corner. If your mod project is big and it takes a long time to do so, hit <code>Build -> Recompile "currently opened file's name"</code>, this will only recompile file that is currently open. This option will not be visible if you don't have compile-able file opened. Files with extensions such as <code>.java</code> or <code>.kt</code> are compile-able.
 [[File:Hotswapmessage.png]]
 If you changed class's schematics then will show you error messages saying it is unsupported. Head to Applying schema changes section if you need to change schematics.
 === Applying schema changes ===
-This requires more setup and specific find of JDK.
+This requires more setup and specific find of JDK, Jetbrains Runtime (JBR). The reason why JBR is suggested is that it has [https://dcevm.github.io/ DCEVM](It allows class schema change in debug mode) by default and requires less configuration than other JDKs, such as hot-swap agent and IDE-specific plugins, etc. Although, there isn't exactly "installer" for it, you would have to download and unpack it manually.
 ==== Downloading JBR ====
-Download Jetbrain runtime(JBR) with right java version and platform from here: https://github.com/JetBrains/JetBrainsRuntime/releases
+Download JBR with right java version and platform from here: https://github.com/JetBrains/JetBrainsRuntime/releases
 There are many different "flavors" but I recommend you downloading "JBR (vanilla)" one if you don't know what are these.
 After downloading has finished unpack it into suitable location