MCPcopy
hub / github.com/Anuken/Mindustry

github.com/Anuken/Mindustry @v158.1 sqlite

repository ↗ · DeepWiki ↗ · release v158.1 ↗
10,002 symbols 44,581 edges 819 files 1,176 documented · 12%
README

Logo

Build Status Discord

The automation tower defense RTS, written in Java.

Trello Board
Wiki
Javadoc

Contributing

See CONTRIBUTING for general code style and PR guidelines.

If you are a first-time contributor looking for features to implement or bugs to fix, see the issues tagged with 'candidate' in the Mindustry-Suggestions repostiory.

Building

Bleeding-edge builds are generated automatically for every commit. You can see them here.

If you'd rather compile on your own, follow these instructions. First, make sure you have JDK 17 installed. Other JDK versions will not work. Open a terminal in the Mindustry directory and run the following commands:

Windows

Running: gradlew desktop:run
Building: gradlew desktop:dist
Sprite Packing: gradlew tools:pack

Linux/Mac OS

Running: ./gradlew desktop:run
Building: ./gradlew desktop:dist
Sprite Packing: ./gradlew tools:pack

Server

Server builds are bundled with each released build (in Releases). If you'd rather compile on your own, replace 'desktop' with 'server', e.g. gradlew server:dist.

Android

  1. Install the Android SDK here. Make sure you're downloading the "Command line tools only", as Android Studio is not required.
  2. In the unzipped Android SDK folder, find the cmdline-tools directory. Then create a folder inside of it called latest and put all of its contents into the newly created folder.
  3. In the same directory run the command sdkmanager --licenses (or ./sdkmanager --licenses if on linux/mac)
  4. Set the ANDROID_HOME environment variable to point to your unzipped Android SDK directory.
  5. Enable developer mode on your device/emulator. If you are on testing on a phone you can follow these instructions, otherwise you need to google how to enable your emulator's developer mode specifically.
  6. Run gradlew android:assembleDebug (or ./gradlew if on linux/mac). This will create an unsigned APK in android/build/outputs/apk.

To debug the application on a connected device/emulator, run gradlew android:installDebug android:run.

Troubleshooting

Permission Denied

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.

Where is the mindustry.gen package?

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.

The following is a non-exhaustive list of the "source" of generated code in mindustry.gen:

  • Call, *Packet classes: Generated from methods marked with @Remote.
  • 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.
  • Sounds, Musics, Tex, Icon, etc: Generated based on files in the respective asset folders.

Gradle may take up to several minutes to download files. Be patient.

After building, the output .JAR file should be in /desktop/build/libs/Mindustry.jar for desktop builds, and in /server/build/libs/server-release.jar for server builds.

Feature Requests

Post feature requests and feedback here.

Downloads

Extension points exported contracts — how you extend this code

Objective (Interface)
Defines a specific objective for a game. [6 implementers]
core/src/mindustry/game/Objectives.java
ContentMapper (Interface)
Converter of an ID to a content instance. [26 implementers]
core/src/mindustry/io/TypeIO.java
RotBlock (Interface)
Any block that has 360-degree rotation [10 implementers]
core/src/mindustry/world/blocks/RotBlock.java
HeatBlock (Interface)
Basic interface for any block that produces heat. [8 implementers]
core/src/mindustry/world/blocks/heat/HeatBlock.java
StatValue (Interface)
A base interface for a value of a stat that is displayed. [36 implementers]
core/src/mindustry/world/meta/StatValue.java

Core symbols most depended-on inside this repo

add
called by 2226
core/src/mindustry/entities/part/DrawPart.java
set
called by 927
core/src/mindustry/world/blocks/payloads/Payload.java
row
called by 882
core/src/mindustry/logic/LStatement.java
color
called by 877
core/src/mindustry/logic/LogicFx.java
put
called by 847
core/src/mindustry/logic/GlobalVars.java
get
called by 784
core/src/mindustry/ui/Menus.java
with
called by 639
core/src/mindustry/type/ItemStack.java
size
called by 528
core/src/mindustry/world/blocks/payloads/Payload.java

Shape

Method 8,545
Class 1,301
Interface 79
Enum 51
Function 26

Languages

Java100%
TypeScript1%

Modules by API surface

core/src/mindustry/logic/LStatements.java209 symbols
core/src/mindustry/entities/comp/BuildingComp.java200 symbols
core/src/mindustry/logic/LExecutor.java176 symbols
core/src/mindustry/game/MapObjectives.java155 symbols
core/src/mindustry/game/EventType.java148 symbols
core/src/mindustry/input/InputHandler.java139 symbols
core/src/mindustry/world/Block.java120 symbols
core/src/mindustry/io/TypeIO.java117 symbols
core/src/mindustry/mod/Mods.java94 symbols
core/src/mindustry/world/Tile.java80 symbols
core/src/mindustry/entities/comp/UnitComp.java76 symbols
core/src/mindustry/net/Administration.java75 symbols

For agents

$ claude mcp add Mindustry \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact