You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 17, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,30 @@
1
1
# `MindustryModTemplate`
2
2
3
-
[Mindustry](https://github.com/Anuken/Mindustry) Java mod template, otherwise known as JAR-modding, complete with [`EntityAnno`](https://github.com/GglLfr/EntityAnno) and syntax downgrader integration, works for both Android and PC.
3
+
[Mindustry](https://github.com/Anuken/Mindustry) Java mod biotech, otherwise known as JAR-modding, complete with [`EntityAnno`](https://github.com/GglLfr/EntityAnno) and syntax downgrader integration, works for both Android and PC.
4
4
5
5
## Using
6
6
7
-
Before going into using this template, be aware that a fair amount of Java knowledge and Git *(GitHub Desktop is fine, but `git` CLI is a million times better)* is **highly beneficial**. Going in blind isn't impossible, but you'll face a lot of problems. Not that people on [the Discord](https://discord.gg/mindustry) won't help, though, so be communicative!
7
+
Before going into using this biotech, be aware that a fair amount of Java knowledge and Git *(GitHub Desktop is fine, but `git` CLI is a million times better)* is **highly beneficial**. Going in blind isn't impossible, but you'll face a lot of problems. Not that people on [the Discord](https://discord.gg/mindustry) won't help, though, so be communicative!
8
8
9
9
1. Install JDK 17 or higher. Plain or terminal-based code editors are **completely *not* recommended!** Use an IDE like [IntelliJ IDEA](https://www.jetbrains.com/idea/download/); there are free Community Edition releases available, just scroll down a bit.
10
-
2. Click the `Use this template` button and create your repository.
10
+
2. Click the `Use this biotech` button and create your repository.
11
11
3. Clone a local copy of the repository.
12
12
13
13
> [!IMPORTANT]
14
14
> A **local copy** is *not* a mere ZIP archive you obtain by downloading. This is where the Git knowledge comes to play. If you have GitHub CLI or GitHub Desktop installed, the site should provide instructions on how to use either, under the `<> Code` menu.
15
15
>
16
16
> `Download ZIP` is **not** a proper way to clone your repository.
17
17
18
-
4. Refactor namings to your preferences. The template is designed in such a way that this step should only require you to modify:
19
-
-`gradle.properties`, the "Project configurations" section. For the "package" properties, if you don't know what you're doing, simply just change `template` to your preferred mod root package naming *(e.g. `mymod`, or `confictura` if your mod name is "confictura")*.
18
+
4. Refactor namings to your preferences. The biotech is designed in such a way that this step should only require you to modify:
19
+
-`gradle.properties`, the "Project configurations" section. For the "package" properties, if you don't know what you're doing, simply just change `biotech` to your preferred mod root package naming *(e.g. `mymod`, or `confictura` if your mod name is "confictura")*.
20
20
-`mod.json`, which is the entire metadata of your mod.
21
21
-`src/` folder and its contents, which is where your Java source files are stored. Rename folders, package, and class names as you prefer. Note that the main mod class' full name *(package + class)* must correspond to the `main` property in `mod.json`.
22
22
-`.github/workflows/ci.yml`, which is the automated Continuous Integration that runs on your GitHub repository everytime you push a commit. This automates cross-platform builds which you might find useful. You should only edit the last 2 lines about `name` and `path`.
23
23
24
24
> [!TIP]
25
-
> There's no `name` property in this template's `mod.json`. That property is automatically filled up when building.
25
+
> There's no `name` property in this biotech's `mod.json`. That property is automatically filled up when building.
26
26
27
-
Here's an example of a properly configured mod base from the template, *assuming
27
+
Here's an example of a properly configured mod base from the biotech, *assuming
28
28
"confictura" as the name*:
29
29
```mermaid
30
30
---
@@ -82,11 +82,11 @@ Before going into using this template, be aware that a fair amount of Java knowl
82
82
83
83
`src/confictura/ConficturaMod.java`:
84
84
```diff
85
-
- package template;
85
+
- package biotech;
86
86
+ package confictura;
87
87
88
88
import mindustry.mod.*;
89
-
- import template.gen.*;
89
+
- import biotech.gen.*;
90
90
+ import confictura.gen.*;
91
91
92
92
- public class ModTemplate extends Mod{
@@ -102,16 +102,16 @@ Before going into using this template, be aware that a fair amount of Java knowl
102
102
```diff
103
103
##### Project configurations.
104
104
# The mod's internal name, corresponds to `name` in `mod.json`.
105
-
- modName = mod-template
105
+
- modName = mod-biotech
106
106
+ modName = confictura
107
107
# The mod's fetched entity sources package.
108
-
- modFetch = template.fetched
108
+
- modFetch = biotech.fetched
109
109
+ modFetch = confictura.fetched
110
110
# The mod's input entity sources package.
111
-
- modGenSrc = template.entities.comp
111
+
- modGenSrc = biotech.entities.comp
112
112
+ modGenSrc = confictura.entities.comp
113
113
# The mod's generated sources package.
114
-
- modGen = template.gen
114
+
- modGen = biotech.gen
115
115
+ modGen = confictura.gen
116
116
# The mod's JAR file name. Desktop build is suffixed with `Desktop`.
117
117
- modArtifact = ModTemplate
@@ -124,13 +124,13 @@ Before going into using this template, be aware that a fair amount of Java knowl
124
124
{
125
125
- "displayName": "Mod Template",
126
126
+ "displayName": "Confictura",
127
-
- "description": "Mindustry Java mod template, complete with EntityAnno and syntax downgrader integration.",
127
+
- "description": "Mindustry Java mod biotech, complete with EntityAnno and syntax downgrader integration.",
128
128
+ "description": "Dive into the past of a trauma-driven uprising.",
0 commit comments