188 lines
9.2 KiB
Markdown
188 lines
9.2 KiB
Markdown
[](https://travis-ci.org/AppliedEnergistics/Applied-Energistics-2)
|
|
[](https://github.com/AppliedEnergistics/Applied-Energistics-2/tags)
|
|
[](https://github.com/AppliedEnergistics/Applied-Energistics-2/releases)
|
|
|
|
# Applied Energistics 2
|
|
|
|
## Table of Contents
|
|
|
|
* [About](#about)
|
|
* [Contacts](#contacts)
|
|
* [License](#license)
|
|
* [Downloads](#downloads)
|
|
* [Installation](#installation)
|
|
* [Issues](#issues)
|
|
* [Building](#building)
|
|
* [Contribution](#contribution)
|
|
* [API](#applied-energistics-2-api)
|
|
* [Localization](#applied-energistics-2-localization)
|
|
* [Credits](#credits)
|
|
|
|
## About
|
|
|
|
A Mod about Matter, Energy and using them to conquer the world..
|
|
|
|
## Contacts
|
|
|
|
* [Website](http://ae-mod.info/)
|
|
* [IRC #appliedenergistics on esper.net](http://webchat.esper.net/?channels=appliedenergistics&prompt=1)
|
|
* [GitHub](https://github.com/AppliedEnergistics/Applied-Energistics-2)
|
|
|
|
## License
|
|
|
|
* Applied Energistics 2 API
|
|
- (c) 2013 - 2015 AlgorithmX2 et al
|
|
- [](http://opensource.org/licenses/MIT)
|
|
* Applied Energistics 2
|
|
- (c) 2013 - 2015 AlgorithmX2 et al
|
|
- [](https://raw.githubusercontent.com/AppliedEnergistics/Applied-Energistics-2/rv2/LICENSE)
|
|
* Textures and Models
|
|
- (c) 2013 - 2015 AlgorithmX2 et al
|
|
- [](https://creativecommons.org/licenses/by-nc-sa/3.0/)
|
|
* Text and Translations
|
|
- [](https://creativecommons.org/publicdomain/zero/1.0/)
|
|
|
|
## Downloads
|
|
|
|
Downloads can be found on [CurseForge](http://www.curse.com/mc-mods/minecraft/223794-applied-energistics-2) or on the [official website](http://ae-mod.info/Downloads/).
|
|
|
|
## Installation
|
|
|
|
You install this mod by putting it into the `minecraft/mods/` folder. It has no additional hard dependencies.
|
|
|
|
## Issues
|
|
|
|
Applied Energistics 2 crashing, have a suggestion, found a bug? Create an issue now!
|
|
|
|
1. Make sure your issue has not already been answered or fixed and you are using the latest version. Also think about whether your issue is a valid one before submitting it.
|
|
2. Go to [the issues page](https://github.com/AppliedEnergistics/Applied-Energistics-2/issues) and click [new issue](https://github.com/AppliedEnergistics/Applied-Energistics-2/issues/new)
|
|
3. Enter your a title of your issue (something that summarizes your issue), and then create a detailed description of the issue.
|
|
* Do not tag it with something like `[Feature]` or `[Bug]`. When it is applicable, we will take care of it.
|
|
* The following details are required. Not including them can cause the issue to be closed.
|
|
* Forge version
|
|
* AE2 version
|
|
* Crash log, when reporting a crash (Please make sure to use [pastebin](http://pastebin.com/))
|
|
* Do not post an excerpt of what you consider important, instead:
|
|
* Post the full log
|
|
* Other mods and their version, when reporting an issue between AE and another mod
|
|
* Also consider updating these before submitting a new issue, it might be already fixed
|
|
* A detailed description of the bug or feature
|
|
* To further help in resolving your issues please try to include the follow if applicable:
|
|
* What was expected?
|
|
* How to reproduce the problem?
|
|
* This is usually a great detail and allows us to fix it way faster
|
|
* Server or Single Player?
|
|
* Screen shots or Pictures of the problem
|
|
* Mod Pack using and version?
|
|
* Keep in mind that some mods might use an outdated version of AE2
|
|
* If so you should report it to your modpack
|
|
5. Click `Submit New Issue`, and wait for feedback!
|
|
|
|
Providing as many details as possible does help us to find and resolve the issue faster and also you getting a fixed version as fast as possible.
|
|
|
|
## Building
|
|
|
|
1. Clone this repository via
|
|
- SSH `git clone git@github.com:AppliedEnergistics/Applied-Energistics-2.git` or
|
|
- HTTPS `git clone https://github.com/AppliedEnergistics/Applied-Energistics-2.git`
|
|
2. Setup workspace
|
|
- Decompiled source `gradlew setupDecompWorkspace`
|
|
- Obfuscated source `gradlew setupDevWorkspace`
|
|
- CI server `gradlew setupCIWorkspace`
|
|
3. Build `gradlew build`. Jar will be in `build/libs`
|
|
4. For core developer: Setup IDE
|
|
- IntelliJ: Import into IDE and execute `gradlew genIntellijRuns` afterwards
|
|
- Eclipse: execute `gradlew eclipse`
|
|
5. For add-on developer: Core-Mod Detection
|
|
- In order to have FML detect AE from your dev environment, add the following VM Option to your run profile
|
|
- `-Dfml.coreMods.load=appeng.transformer.AppEngCore`
|
|
|
|
## Contribution
|
|
|
|
Before you want to add major changes, you might want to discuss them with us first, before wasting your time.
|
|
If you are still willing to contribute to this project, you can contribute via [Pull-Request](https://help.github.com/articles/creating-a-pull-request).
|
|
|
|
The [guidelines for contributing](https://github.com/AppliedEnergistics/Applied-Energistics-2/blob/master/CONTRIBUTING.md) contain more detailed information about topics like the used code style and should also be considered.
|
|
|
|
Here are a few things to keep in mind that will help get your PR approved.
|
|
|
|
* A PR should be focused on content. Any PRs where the changes are only syntax will be rejected.
|
|
* Use the file you are editing as a style guide.
|
|
* Consider your feature. [Suggestion Guidelines](http://ae-mod.info/Suggestion-Guidelines/)
|
|
- Is your suggestion already possible using Vanilla + AE2?
|
|
- Make sure your feature isn't already in the works, or hasn't been rejected previously.
|
|
- Does your feature simplify another feature of AE2? These changes will not be accepted.
|
|
- If your feature can be done by any popular mod, discuss with us first.
|
|
|
|
Getting Started
|
|
|
|
1. Fork this repository
|
|
2. Clone the fork via
|
|
* SSH `git clone git@github.com:<your username>/Applied-Energistics-2.git` or
|
|
* HTTPS `git clone https://github.com/<your username>/Applied-Energistics-2.git`
|
|
3. Change code base
|
|
4. Add changes to git `git add -A`
|
|
5. Commit changes to your clone `git commit -m "<summery of made changes>"`
|
|
6. Push to your fork `git push`
|
|
7. Create a Pull-Request on GitHub
|
|
8. Wait for review
|
|
9. Squash commits for cleaner history
|
|
|
|
If you are only doing single file pull requests, GitHub supports using a quick way without the need of cloning your fork. Also read up about [synching](https://help.github.com/articles/syncing-a-fork) if you plan to contribute on regular basis.
|
|
|
|
## Applied Energistics 2 API
|
|
|
|
The API for Applied Energistics 2. It is open source to discuss changes, improve documentation, and provide better add-on support in general.
|
|
|
|
Development and standard builds can be obtained [Here](http://ae2.ae-mod.info/Downloads/).
|
|
|
|
### Maven
|
|
|
|
When compiling against the AE2 API you can use gradle dependencies, just add
|
|
|
|
dependencies {
|
|
compile "appeng:appliedenergistics2:rv_-_____-__:dev"
|
|
}
|
|
|
|
or add the compile line to your existing dependencies task to your build.gradle
|
|
|
|
Where the __ are filled in with the correct version criteria; AE2 is available from the default forge maven so no additional repositories are necessary.
|
|
|
|
An example string would be `appeng:appliedenergistics2:rv2-alpha-30:dev`
|
|
|
|
## Applied Energistics 2 Localization
|
|
|
|
### English Text
|
|
|
|
`en_US` is included in this repository, fixes to typos are welcome.
|
|
|
|
### Encoding
|
|
|
|
Files must be encoded as UTF-8.
|
|
|
|
### New or updated Translations
|
|
|
|
The language files are located in `/src/main/resources/assets/appliedenergistics2/lang/` and use the [appropriate locale code](http://minecraft.gamepedia.com/Language) as name and `.lang` as extension.
|
|
|
|
To update an translation edit the corresponding file and improve/correct the existing entry. Or copy any entries from `en_US.lang` for missing translation.
|
|
|
|
To create a new translation, copy the contents of `en_US.lang`, create a new file with appropriate filename, and translate it to your language.
|
|
|
|
Please keep in mind that we use [String format](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html) to pass additional data to the text for displaying.
|
|
Therefore you should preserve parts like `%s` or `%1$d%%`, which allows us to replace them with the correct values while you still have the option to change their order for match the rules of grammar.
|
|
This might not be possible for some languages. Should this be the case, please contact us.
|
|
|
|
### Final Note
|
|
|
|
If you have have issues localizing something feel free to contact us on IRC, at #AppliedEnergistics on Esper.net
|
|
|
|
Thanks to everyone helping out to improve localization of AE2.
|
|
|
|
## Credits
|
|
|
|
Thanks to
|
|
|
|
* Notch et al for Minecraft
|
|
* Lex et al for MinecraftForge
|
|
* AlgorithmX2 for AppliedEnergistics2
|
|
* all [contributors](https://github.com/AppliedEnergistics/Applied-Energistics-2/graphs/contributors)
|