2012-06-20 03:51:15 +02:00
## Welcome to Buildcraft on GitHub
2012-08-20 14:08:17 +02:00
### Contributing
2013-02-14 12:45:40 +01:00
If you wish to submit a pull request to fix bugs or broken behaviour feel free to do so. If you would like to add
features or change existing behaviour or balance, please discuss it with Sengir or Krapht before submiting the pull request.
2012-08-20 14:08:17 +02:00
2013-09-13 10:00:45 +02:00
Do not submit pull requests which solely "fix" formatting. As these kinds of changes are usually very intrusive in commit history and everyone has their own idea what "proper formatting" is, they should be done by one of the main contributors.
Please only submit "code cleanup", if the changes actually have a substantial impact on readability.
2013-04-03 18:59:21 +02:00
### Reporting issues
2013-06-19 11:28:41 +02:00
* Before reporting an issue, please check that it has not been reported before.
* Issues are for bugs/crashes, please do not use them to ask general questions.
* Always include the version you are having trouble with. Or if you're building from source, which source you're building.
2013-04-03 18:59:21 +02:00
If you don't, we might assume that you are using latest-greatest and waste a bunch of time trying to reproduce
a problem that might have fixed been already. Such things makes for very grumpy devs. Grumpy devs spend
less time coding and more time doing stuff that makes them less grumpy.
2013-08-19 18:49:53 +02:00
* If the issues occurs on a server, be sure it's a vanilla forge server and < b > not</ b > a mcpc+ server.
2013-10-13 02:23:00 +02:00
* Issues with any logs mentioning Optifine will be closed on sight! Remove Optifine before reporting any issue.
2013-04-03 18:59:21 +02:00
2013-06-19 11:28:41 +02:00
#### Frequently reported
2013-06-23 01:38:49 +02:00
* java.lang.AbstractMethodError - Incompatibility between BC/Forge/Mod using BC API. Usually not a BC issue
2013-07-30 11:51:06 +02:00
* java.lang.NoSuchMethodException - Same as above
2013-06-23 01:39:35 +02:00
* Render issue (Quarry causes flickering) - Try without optifine, if it still flickers, report it
2013-06-19 11:28:41 +02:00
2012-07-10 19:13:12 +02:00
### Compiling and packaging Buildcraft
2013-06-19 09:23:39 +02:00
1. Ensure that `Apache Ant` (found [here ](http://ant.apache.org/ )) and `Git` (found [here ](http://git-scm.com/ )) are installed correctly on your system.
2012-06-20 03:51:15 +02:00
* Linux users will need the latest version of astyle installed as well.
1. Create a base directory for the build
2012-09-13 15:35:11 +02:00
1. Clone the Buildcraft repository into `basedir/BuildCraft/`
* Optional: Copy BuildCraft localization repository into `basedir/BuildCraft-Localization`
2012-09-14 01:58:38 +02:00
1. Navigate to basedir/Buildcraft in a shell and run `ant` (this will take 2-5 minutes)
2013-04-03 20:22:52 +02:00
1. The compiled and obfuscated jar will be in basedir/bin
2012-06-20 03:51:15 +02:00
2013-04-03 20:22:52 +02:00
Your directory structure should look like this before running ant:
2012-06-20 03:51:15 +02:00
***
basedir
2013-05-06 08:30:49 +02:00
\- buildcraft
2012-09-13 15:35:11 +02:00
|- buildcraft_resources
|- common
2012-06-20 03:51:15 +02:00
|- ...
2013-05-06 08:30:49 +02:00
\- buildcraft.localization
2012-09-13 15:35:11 +02:00
|- lang
2012-06-20 03:51:15 +02:00
2012-09-11 14:10:38 +02:00
***
2013-04-03 20:22:52 +02:00
And like this after running ant:
***
basedir
2013-05-06 08:30:49 +02:00
\- buildcraft
2013-04-03 20:22:52 +02:00
|- bin
|- build
|- buildcraft_resources
|- common
|- download
|- ...
2013-05-06 08:30:49 +02:00
\- buildcraft.localization
2013-04-03 20:22:52 +02:00
|- lang
***
2012-09-11 14:10:38 +02:00
### Localizations
2013-01-23 15:07:03 +01:00
Localizations can be submitted [here ](https://github.com/BuildCraft/BuildCraft-Localization ). Localization PRs against
this repository will have to be rejected.
