diff --git a/README.md b/README.md index c3339c069..e92501eb0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ -[![Travis](https://img.shields.io/travis/AppliedEnergistics/Applied-Energistics-2.svg?maxAge=2592000&style=flat-square)](https://travis-ci.org/AppliedEnergistics/Applied-Energistics-2) -[![Latest Release](https://img.shields.io/github/release/AppliedEnergistics/Applied-Energistics-2.svg?label=Latest%20Release&style=flat-square)](https://github.com/AppliedEnergistics/Applied-Energistics-2/releases) +This is a fork of AE2 i made for trying to solve issues for the [Omnifactory](https://www.curseforge.com/minecraft/modpacks/omnifactory) modpack. + +See https://github.com/PrototypeTrousers/Applied-Energistics-2/tree/AE2-Omnifactory branch for commits +and +https://github.com/PrototypeTrousers/Applied-Energistics-2/releases for the compiled jars. # Applied Energistics 2 @@ -22,13 +25,6 @@ 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) -* [Discord](https://discord.gg/GygKjjm) - ## License * Applied Energistics 2 API @@ -43,198 +39,6 @@ A Mod about Matter, Energy and using them to conquer the world.. * Text and Translations - [![License](https://img.shields.io/badge/License-No%20Restriction-green.svg?style=flat-square)](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. - * If it is already possible with vanilla and AE2 itself, the suggestion will be considered invalid. - * Asking for a smaller version, more compact version, or more efficient version of something will also be considered invalid. -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]`, `[Bug]`, or a version. - * Restrict it to a single bug or feature, it makes managing them way easier for us. - * The following details are required. Also refer to the issue template when creating one. - * Forge version - * AE2 version - * Crash log, when reporting a crash (Please make sure to use [pastebin](http://pastebin.com/)) - * Never post an excerpt of what you consider important - * Always 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 -4. 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. - -Please note that we might close any issue not matching these requirements. - -## 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, execute `gradlew genIntellijRuns` and change RunConfiguration to `*_main` as quickfix for [ForgeGradle](https://github.com/MinecraftForge/ForgeGradle/issues/357) - - 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.coremod.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/.github/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:/Applied-Energistics-2.git` or - * HTTPS `git clone https://github.com//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 ""` -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. - -Universal builds obtained [Here](http://ae2.ae-mod.info/Downloads/) should work in a development environment. - -### Maven - -When compiling against the AE2 API you can use gradle dependencies, just add - - dependencies { - compile "appeng:appliedenergistics2:rv_-_____-__:api" - } - -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:rv5-stable-1:api` for the API only or `appeng:appliedenergistics2:rv5-stable-1` for the whole mod. - -## Applied Energistics 2 CraftTweaker - -### Inscriber -Add a recipe. When `inscribe` is true the bottom and top inputs are not consumed. - - mods.appliedenergistics2.Inscriber.addRecipe(ItemStack output, ItemStack input, boolean inscribe, - @Optional ItemStack topInput, @Optional ItemStack bottomInput ); - -Remove all recipes for this output stack. - - mods.appliedenergistics2.Inscriber.removeRecipe(ItemStack output); - -### Grindstone -Add a recipe. - - mods.appliedenergistics2.Grinder.addRecipe( ItemStack output, ItemStack input, int turns, - @Optional ItemStack secondary1Output, @Optional float secondary1Chance, - @Optional ItemStack secondary2Output, @Optional float secondary2Chance); - -Remove recipes for this input. - - mods.appliedenergistics2.Grinder.removeRecipe(ItemStack input); - -### Spatial -Whitelist a TileEntity class for Spatial IO. - - mods.appliedenergistics2.Spatial.whitelistEntity( String fullEntityClassName ); - -### Attunement -Attune a ItemStack or ModID to a specific P2P-Tunnel type. ModID's are used as fallback when no ItemStack was found. - - mods.appliedenergistics2.Attunement.attuneME( ItemStack itemStack ); - mods.appliedenergistics2.Attunement.attuneME( String modID ); - mods.appliedenergistics2.Attunement.attuneItem( ItemStack itemStack ); - mods.appliedenergistics2.Attunement.attuneItem( String modID ); - mods.appliedenergistics2.Attunement.attuneFluid( ItemStack itemStack ); - mods.appliedenergistics2.Attunement.attuneFluid( String modID ); - mods.appliedenergistics2.Attunement.attuneRedstone( ItemStack itemStack ); - mods.appliedenergistics2.Attunement.attuneRedstone( String modID ); - mods.appliedenergistics2.Attunement.attuneRF( ItemStack itemStack ); - mods.appliedenergistics2.Attunement.attuneRF( String modID ); - mods.appliedenergistics2.Attunement.attuneIC2( ItemStack itemStack ); - mods.appliedenergistics2.Attunement.attuneIC2( String modID ); - mods.appliedenergistics2.Attunement.attuneLight( ItemStack itemStack ); - mods.appliedenergistics2.Attunement.attuneLight( String modID ); - -### Cannon -Add ammo types for the matter cannon. - - mods.appliedenergistics2.Cannon.registerAmmo( ItemStack itemStack, double weight ); - -## 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