buildcraft/README.md
Krapht 01c692834a Update README.md
Added clarification about balance
2012-11-04 01:48:43 +01:00

42 lines
No EOL
1.5 KiB
Markdown

## Welcome to Buildcraft on GitHub
### Official Builds
An official jenkins build server can be found [here](http://jenkins.mc-epoch.com:8080/). Jenkins will generate a new
build every time a change is pushed to github.
### Contributing
If you wish to submit a pull request to fix bugs or broken behaivor feel free to do so. If you would like to add
features or change existing behaivour or balance, please discuss it with Sengir or Krapht before submiting the pull request.
### Compiling and packaging Buildcraft
1. Ensure that `Apache Ant` (found [here](http://ant.apache.org/)) is installed correctly on your system.
* Linux users will need the latest version of astyle installed as well.
1. Create a base directory for the build
1. Clone the Buildcraft repository into `basedir/BuildCraft/`
* Optional: Copy BuildCraft localization repository into `basedir/BuildCraft-Localization`
1. Copy the minecraft bin dir and minecraft_server.jar into `basedir/jars/`
1. Navigate to basedir/Buildcraft in a shell and run `ant` (this will take 2-5 minutes)
1. The compiled and obfuscated jar will be in basedir/build/dist
Your directory structure should look like this:
***
basedir
\- jars
|- minecraft_server.jar
\- bin
|- minecraft.jar
|- ...
\- BuildCraft
|- buildcraft_resources
|- common
|- ...
\- BuildCraft-Localization
|- lang
***
### Localizations
Localizations can be submitted [here](https://github.com/SirSengir/BuildCraft-Localization). Localization PRs against
this repository will have to be rejected.