User Tools

Site Tools


tutorial:reading_mc_code

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
tutorial:reading_mc_code [2023/08/28 08:39] – [Finding the class you want to see] cph101tutorial:reading_mc_code [2026/09/03 16:50] (current) – Use the definite article where appropriate mcgambingpro
Line 1: Line 1:
 ====== Reading the Minecraft source ====== ====== Reading the Minecraft source ======
 Reading the Minecraft source is an important skill in modding. This is mainly because Reading the Minecraft source is an important skill in modding. This is mainly because
-    * Most of the Minecraft things are not documented+    * Most of Minecraft's inner workings are not documented
     * Documentations/tutorials get outdated fairly quickly     * Documentations/tutorials get outdated fairly quickly
  
 To read the Minecraft source, you need to generate sources first. See the "Generating Minecraft Sources" section in [[tutorial:setup|Setting up a mod development environment]]. To read the Minecraft source, you need to generate sources first. See the "Generating Minecraft Sources" section in [[tutorial:setup|Setting up a mod development environment]].
  
-===== Searching for a Minecraft class ====+===== Searching for a Minecraft class =====
 To search a Minecraft class, follow these steps. To search a Minecraft class, follow these steps.
  
-==== Intellij IDEA ==== +===== Intellij IDEA ===== 
-    - Open the search pane with {{https://i.ibb.co/rmztpCy/IMG-0712.png?height=64}} or {{https://i.ibb.co/23sPQHC/IMG-0709.png?height=80}} on mac+    - Open the search pane with {{https://i.ibb.co/rmztpCy/IMG-0712.png?height=64}} or {{https://i.ibb.co/2SDypGK/kbs-meta-o.png?height=80}} on mac
     - Set the search scope to ''Project and Libraries'' or wider     - Set the search scope to ''Project and Libraries'' or wider
     - Type the class name in the search box     - Type the class name in the search box
  
-==== Visual Studio Code ====+===== Visual Studio Code =====
     - Open the search pane with ''Ctrl + P''     - Open the search pane with ''Ctrl + P''
     - Type the class name with prefix ''#''     - Type the class name with prefix ''#''
 +
 +===== Eclipse =====
 +    - Open the search pane with ''Ctrl + Shift + T''
  
 In Visual Studio Code, you can also use ''Ctrl + T'' to open the class search directly. In Visual Studio Code, you can also use ''Ctrl + T'' to open the class search directly.
Line 23: Line 26:
 Locating the part of code you want to see is a challenging task. Here are some tips. Locating the part of code you want to see is a challenging task. Here are some tips.
  
-    * Take full advantage of IDE's ability to find the relevant code such as ''Call hierarchy'', ''Method hierarchy'' or ''Type hierarchy''.+    * Take full advantage of the IDE's ability to find the relevant code such as ''Call hierarchy'', ''Method hierarchy'' or ''Type hierarchy''.
     * Take a look at open source mods which are similar to what you want to make.     * Take a look at open source mods which are similar to what you want to make.
     * If you are adding a new content, there is a good chance you need to access registries defined in ''net.minecraft.util.registry.Registries''.     * If you are adding a new content, there is a good chance you need to access registries defined in ''net.minecraft.util.registry.Registries''.
Line 47: Line 50:
  
 ===== FAQ ===== ===== FAQ =====
-**Where is the generated sources?**+**Where are the generated sources?**
  
-It's either in the user gradle cache (''~/.gradle/caches/fabric-loom'') or in the project gradle cache (''./.gradle/loom-cache'').+It's either in the user gradle cache (''~/.gradle/caches/fabric-loom'') or in the project gradle cache (''./.gradle/loom-cache''). **You may have to go inside a few folders to find what you're looking for.**
 You can use the sources jar outside of your IDE. You can use the sources jar outside of your IDE.
  
tutorial/reading_mc_code.1693211965.txt.gz · Last modified: 2023/08/28 08:39 by cph101