Skip to content

Commit e697337

Browse files
committedOct 8, 2024
Added explanation of mindustry.gen
1 parent 1f62892 commit e697337

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed
 

‎README.md

+10
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,16 @@ To debug the application on a connected device/emulator, run `gradlew android:in
5353

5454
If the terminal returns `Permission denied` or `Command not found` on Mac/Linux, run `chmod +x ./gradlew` before running `./gradlew`. *This is a one-time procedure.*
5555

56+
#### Where is the `mindustry.gen` package?
57+
58+
As the name implies, `mindustry.gen` is generated *at build time* based on other code. You will not find source code for this package in the repository, and it should not be edited by hand.
59+
60+
The following is a non-exhaustive list of the "source" of generated code in `mindustry.gen`:
61+
62+
- `Call`, `*Packet` classes: Generated from methods marked with `@Remote`.
63+
- All entity classes (`Unit`, `EffectState`, `Posc`, etc): Generated from component classes in the `mindustry.entities.comp` package, and combined using definitions in `mindustry.content.UnitTypes`.
64+
- `Sounds`, `Musics`, `Tex`, `Icon`, etc: Generated based on files in the respective asset folders.
65+
5666
---
5767

5868
Gradle may take up to several minutes to download files. Be patient. <br>

0 commit comments

Comments
 (0)
Please sign in to comment.