mirror of
https://github.com/Anuken/Mindustry.git
synced 2025-02-05 08:27:37 +07:00
7491366658
Old target (Jenkins) says that it is no longer up to date and that we should look at github instead.
61 lines
3.0 KiB
Markdown
61 lines
3.0 KiB
Markdown
![Logo](core/assets/sprites/logo.png)
|
|
|
|
[![Build Status](https://travis-ci.org/Anuken/Mindustry.svg?branch=master)](https://travis-ci.org/Anuken/Mindustry)
|
|
[![Discord](https://img.shields.io/discord/391020510269669376.svg)](https://discord.gg/mindustry)
|
|
|
|
A sandbox tower defense game written in Java.
|
|
|
|
_[Trello Board](https://trello.com/b/aE2tcUwF/mindustry-40-plans)_
|
|
_[Wiki](https://mindustrygame.github.io/wiki)_
|
|
|
|
### Building
|
|
|
|
Bleeding-edge live builds are generated automatically for every commit. You can see them [here](https://github.com/Anuken/MindustryBuilds/releases). Old builds might still be on [jenkins](https://jenkins.hellomouse.net/job/mindustry/).
|
|
|
|
If you'd rather compile on your own, follow these instructions.
|
|
First, make sure you have Java 8 and JDK 8 installed. Open a terminal in the root directory, `cd` to the Mindustry folder and run the following commands:
|
|
|
|
#### Windows
|
|
|
|
_Running:_ `gradlew desktop:run`
|
|
_Building:_ `gradlew desktop:dist`
|
|
|
|
#### Linux/Mac OS
|
|
|
|
_Running:_ `./gradlew desktop:run`
|
|
_Building:_ `./gradlew desktop:dist`
|
|
|
|
#### 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.](https://developer.android.com/studio#downloads) Make sure you're downloading the "Command line tools only", as Android Studio is not required.
|
|
2. Create a file named `local.properties` inside the Mindustry directory, with its contents looking like this: `sdk.dir=<Path to Android SDK you just downloaded, without these bracket>`. For example, if you're on Windows and installed the tools to C:\\tools, your local.properties would contain `sdk.dir=C:\\tools` (*note the double backslashes are required instead of single ones!*).
|
|
3. Run `gradlew android:assembleDebug` (or `./gradlew` if on linux/mac). This will create an unsigned APK in `android/build/outputs/apk`.
|
|
4. (Optional) To debug the application on a connected phone, do `gradlew android:installDebug android:run`. It is **highly recommended** to use IntelliJ for this instead, however.
|
|
|
|
##### Troubleshooting
|
|
|
|
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.*
|
|
|
|
---
|
|
|
|
Gradle may take up to several minutes to download files. Be patient. <br>
|
|
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.
|
|
|
|
### Downloads
|
|
|
|
[<img src="https://static.itch.io/images/badge.svg"
|
|
alt="Get it on Itch.io"
|
|
height="60">](https://anuke.itch.io/mindustry)
|
|
|
|
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png"
|
|
alt="Get it on Google Play"
|
|
height="80">](https://play.google.com/store/apps/details?id=io.anuke.mindustry)
|
|
|
|
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
|
|
alt="Get it on F-Droid"
|
|
height="80">](https://f-droid.org/packages/io.anuke.mindustry/)
|