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
Copy file name to clipboardExpand all lines: README.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ See [CONTRIBUTING](CONTRIBUTING.md).
18
18
Bleeding-edge builds are generated automatically for every commit. You can see them [here](https://github.com/Anuken/MindustryBuilds/releases).
19
19
20
20
If you'd rather compile on your own, follow these instructions.
21
-
First, make sure you have [JDK 16-17](https://adoptium.net/archive.html?variant=openjdk17&jvmVariant=hotspot) installed. **Other JDK versions will not work.** Open a terminal in the Mindustry directory and run the following commands:
21
+
First, make sure you have [JDK 17](https://adoptium.net/archive.html?variant=openjdk17&jvmVariant=hotspot) installed. **Other JDK versions will not work.** Open a terminal in the Mindustry directory and run the following commands:
22
22
23
23
### Windows
24
24
@@ -53,6 +53,16 @@ To debug the application on a connected device/emulator, run `gradlew android:in
53
53
54
54
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.*
55
55
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
+
56
66
---
57
67
58
68
Gradle may take up to several minutes to download files. Be patient. <br>
Copy file name to clipboardExpand all lines: SERVERLIST.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,7 @@
1
+
# Note: Server list review is currently on pause. No new servers will be merged until v8 is released!
2
+
3
+
*PRs to edit addresses of existing servers will still be accepted, although very infrequently.*
4
+
1
5
### Adding a server to the list
2
6
3
7
Mindustry now has a public list of servers that everyone can see and connect to.
@@ -18,13 +22,16 @@ You'll need to either hire some moderators, or make use of (currently non-existe
18
22
4.**Get some good maps.***(optional, but highly recommended)*. Add some maps to your server and set the map rotation to custom-only. You can get maps from the Steam workshop by subscribing and exporting them; using the `#maps` channel on Discord is also an option.
19
23
5.**Check your server configuration.***(optional)* I would recommend adding a message rate limit of 1 second (`config messageRateLimit 1`), and disabling connect/disconnect messages to reduce spam (`config showConnectMessages false`).
20
24
6. Finally, **submit a pull request** to add your server's IP to the list.
21
-
This should be fairly straightforward: Press the edit button on the [server file](https://github.com/Anuken/Mindustry/blob/master/servers_v7.json), then add a JSON object with a single key, indicating your server address.
22
-
For example, if your server address is `example.com:6000`, you would add a comma after the last entry and insert:
25
+
This should be fairly straightforward: Press the edit button on the [server file](https://github.com/Anuken/Mindustry/blob/master/servers_v7.json), then add a JSON object with the following format:
23
26
```json
24
27
{
25
-
"address": "example.com:6000"
28
+
"name": "Your Server Group Name",
29
+
"address": ["your.server.address"]
26
30
}
27
31
```
32
+
33
+
If your group has multiple servers, simply add extra addresses inside the square brackets, separated by commas. For example: `["address1", "address2"]`
34
+
28
35
> Note that Mindustry also support SRV records. This allows you to use a subdomain for your server address instead of specifying the port. For example, if you want to use `play.example.com` instead of `example.com:6000`, in the dns settings of your domain, add an SRV record with `_mindustry` as the service, `tcp` as the protocol, `play` as the target and `6000` as the port. You can also setup fallback servers by modifying the weight or priority of the record. Although SRV records are very convenient, keep in mind they are slower than regular addresses. Avoid using them in the server list, but rather as an easy way to share your server address.
29
36
30
37
Then, press the *'submit pull request'* button and I'll take a look at your server. If I have any issues with it, I'll let you know in the PR comments.
0 commit comments