Mindustry/README.md

66 lines
3.2 KiB
Markdown
Raw Normal View History

2019-07-07 06:08:16 +07:00
![Logo](core/assets/sprites/logo.png)
2017-12-10 05:58:34 +07:00
2018-09-26 10:31:45 +07:00
[![Build Status](https://travis-ci.org/Anuken/Mindustry.svg?branch=master)](https://travis-ci.org/Anuken/Mindustry)
2019-10-30 10:06:22 +07:00
[![Discord](https://img.shields.io/discord/391020510269669376.svg)](https://discord.gg/mindustry)
2018-09-26 10:31:45 +07:00
2019-01-14 08:10:43 +07:00
A sandbox tower defense game written in Java.
2017-12-10 05:58:34 +07:00
2018-03-06 05:00:02 +07:00
_[Trello Board](https://trello.com/b/aE2tcUwF/mindustry-40-plans)_
2019-09-30 23:28:56 +07:00
_[Wiki](https://mindustrygame.github.io/wiki)_
2017-12-10 05:58:34 +07:00
### 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/).
2017-12-22 03:43:30 +07:00
If you'd rather compile on your own, follow these instructions.
2019-10-06 21:34:34 +07:00
First, make sure you have [Java 8](https://www.java.com/en/download/) and [JDK 8](https://adoptopenjdk.net/) installed. Open a terminal in the root directory, `cd` to the Mindustry folder and run the following commands:
2017-12-10 05:58:34 +07:00
#### Windows
2017-12-10 06:09:34 +07:00
_Running:_ `gradlew desktop:run`
_Building:_ `gradlew desktop:dist`
2017-12-10 05:58:34 +07:00
2019-02-09 15:38:30 +07:00
#### Linux/Mac OS
2017-12-10 06:06:09 +07:00
2017-12-30 04:31:19 +07:00
_Running:_ `./gradlew desktop:run`
2017-12-10 06:06:09 +07:00
_Building:_ `./gradlew desktop:dist`
2019-02-22 07:12:07 +07:00
#### Server
2019-02-22 07:12:07 +07:00
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`.
2019-09-12 23:40:52 +07:00
#### 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
2019-03-13 03:37:32 +07:00
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.*
2017-12-10 06:09:34 +07:00
---
2017-12-10 06:06:09 +07:00
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.
2017-12-10 05:58:34 +07:00
2019-10-31 03:56:02 +07:00
### Feature Requests
[![Feature Requests](https://feathub.com/Anuken/Mindustry?format=svg)](https://feathub.com/Anuken/Mindustry)
2017-12-10 05:58:34 +07:00
### Downloads
2019-08-30 05:57:54 +07:00
[<img src="https://static.itch.io/images/badge.svg"
alt="Get it on Itch.io"
height="60">](https://anuke.itch.io/mindustry)
2017-12-10 05:58:34 +07:00
2019-08-30 05:57:54 +07:00
[<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/)