OpenBlocks/README.md

56 lines
1.6 KiB
Markdown
Raw Normal View History

OpenBlocks
=========
An open source random collection of blocks and miscellaneous cool stuff
Version
-
Alpha 1 (Not released)
What does it contain?
-----------
* Colored mining flags
* The anywhere tank, fill any hole with a liquid
* Player graves, fight the ghost of the perished to obtain their inventory
* Light boxes to display your maps on the wall, ceiling or floor
* Archery targets for a shooting range
* Even torch arrows!
* Exciting graphics and much more to come.
Compiling
--------------
We will try keep the building instructions as up-to-date as possible, but things may change without notice.
### Windows
You will require mysysgit or git installed with cygwin. Alternatively I would suggest installing GitHub for Windows and checking out the repo with that.
#### Check out the repo
Use Github for Windows or use a command prompt/powershell with git binaries in the Environment path.
```git clone https://github.com/OpenMods/OpenBlocks.git```
#### Change directory
```cd OpenBlocks```
#### Run ant build
```ant```
The resulting file should be in the bin folder.
### Linux or OSX
Much the same as Windows, open a terminal window where you wish to checkout the repo and type
```git clone https://github.com/OpenMods/OpenBlocks.git && cd OpenBlocks```
#### Then run ant
```ant```
The mod jar will be in the bin folder after the completion of the build process.
Contact
-
Feel free to chat with us in #OpenMods on *irc.esper.net*
License
-
OpenBlocks is open source, please check the Licence.txt for more information and the licences of individual components of this mod.