Mindustry/README.md

![Imgur](https://i.imgur.com/w4N0yhv.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](http://mindustry.wikia.com/wiki/Mindustry_Wiki)_ 

### Building

Bleeding-edge live builds are generated automatically for every commit. You can see them [here](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`

#### For Server Builds...

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

---

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/desktop-release.jar` for desktop builds, and in `/server/build/libs/server-release.jar` for server builds.

### Downloads

<a href="https://anuke.itch.io/mindustry"><img src="https://i.imgur.com/sk26hTV.png" width="auto" height="75"></a>

<a href="https://play.google.com/store/apps/details?id=io.anuke.mindustry&hl=en"><img src="https://i.imgur.com/8dF6l81.png" width="auto" height="75"></a>
Added build instructions to README 2017-12-10 05:58:34 +07:00			`![Imgur](https://i.imgur.com/w4N0yhv.png)`

Added discord badge to README 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)`
Code cleanup 2018-10-06 22:56:39 +07:00			`[![Discord](https://img.shields.io/discord/391020510269669376.svg)](https://discord.gg/mindustry)`
Added discord badge to README 2018-09-26 10:31:45 +07:00
Updated README 2019-01-14 08:10:43 +07:00			`A sandbox tower defense game written in Java.`
Added build instructions to README 2017-12-10 05:58:34 +07:00
Moved TODO to Trello board 2018-03-06 05:00:02 +07:00			`_[Trello Board](https://trello.com/b/aE2tcUwF/mindustry-40-plans)_`
Fixed #385 2018-12-24 05:11:19 +07:00			`_[Wiki](http://mindustry.wikia.com/wiki/Mindustry_Wiki)_`
Added build instructions to README 2017-12-10 05:58:34 +07:00
			`### Building`

Removed wiki link 2018-10-19 10:00:18 +07:00			`Bleeding-edge live builds are generated automatically for every commit. You can see them [here](https://jenkins.hellomouse.net/job/mindustry/).`
Updated readme 2017-12-22 03:43:30 +07:00
			`If you'd rather compile on your own, follow these instructions.`
Added some details to README.md 2019-02-09 15:38:30 +07:00			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:
Added build instructions to README 2017-12-10 05:58:34 +07:00
Updated README (#284) Proper formatting (md:h4) Syntactic update, '.bat' no longer needs to come after 'gradlew' for Windows building Server build instructions 2018-10-29 07:05:20 +07:00			`#### Windows`
Added wiki link 2017-12-10 06:09:34 +07:00
Updated README (#284) Proper formatting (md:h4) Syntactic update, '.bat' no longer needs to come after 'gradlew' for Windows building Server build instructions 2018-10-29 07:05:20 +07:00			_Running:_ `gradlew desktop:run`
			_Building:_ `gradlew desktop:dist`
Added build instructions to README 2017-12-10 05:58:34 +07:00
Added some details to README.md 2019-02-09 15:38:30 +07:00			`#### Linux/Mac OS`
Fixed improper linebreaks 2017-12-10 06:06:09 +07:00
Fixed newlines in README 2017-12-30 04:31:19 +07:00			_Running:_ `./gradlew desktop:run`
Fixed improper linebreaks 2017-12-10 06:06:09 +07:00			_Building:_ `./gradlew desktop:dist`

Updated README (#284) Proper formatting (md:h4) Syntactic update, '.bat' no longer needs to come after 'gradlew' for Windows building Server build instructions 2018-10-29 07:05:20 +07:00			`#### For Server Builds...`

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

Added wiki link 2017-12-10 06:09:34 +07:00			`---`

Fixed improper linebreaks 2017-12-10 06:06:09 +07:00			`Gradle may take up to several minutes to download files. Be patient. <br>`
Updated README (#284) Proper formatting (md:h4) Syntactic update, '.bat' no longer needs to come after 'gradlew' for Windows building Server build instructions 2018-10-29 07:05:20 +07:00			After building, the output .JAR file should be in `/desktop/build/libs/desktop-release.jar` for desktop builds, and in `/server/build/libs/server-release.jar` for server builds.
Added build instructions to README 2017-12-10 05:58:34 +07:00
			`### Downloads`

			`<a href="https://anuke.itch.io/mindustry"><img src="https://i.imgur.com/sk26hTV.png" width="auto" height="75"></a>`

			`<a href="https://play.google.com/store/apps/details?id=io.anuke.mindustry&hl=en"><img src="https://i.imgur.com/8dF6l81.png" width="auto" height="75"></a>`