From 12180df169563a3a225e170d773b4bdadddef273 Mon Sep 17 00:00:00 2001 From: thatsIch Date: Fri, 26 Sep 2014 16:45:39 +0200 Subject: [PATCH 1/3] Update readme to match build changes --- README.md | 91 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 67 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 71c49ee84..9515af3c9 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,76 @@ -Applied Energistics 2 -========================= +# Applied Energistics 2 -### Information +## Table of Content -[Website](http://ae-mod.info/) +* [About](#about) +* [Contacts](#contacts) +* [License](#license) +* [Downloads](#downloads) +* [Installation](#installation) +* [Building](#building) +* [Contribution](#contribution) +* [Credits](#credits) -[Latest Releases](http://ae-mod.info/Downloads/) +## About -[IRC #appliedenergistics on esper.net](http://webchat.esper.net/?channels=appliedenergistics&prompt=1) +A Mod about Matter, Energy and using them to conquer the world.. -### Workspace / Building +## Contacts -Clone Repo, make sure you use --recursive. +* [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) -Download and unzip http://ae-mod.info/assets/CompileDeps.zip into the root folder ( hopefully this is temporary and a better solution is created ) - -gradle setupDecompWorkspace - -gradlew eclipse / idea / build - -In order to have FML detect AE from your dev enviornment, add the following VM Option to your run profile -``` --Dfml.coreMods.load=appeng.transformer.AppEngCore -``` - -### Contributing - -Bugfixes and Compatability patches are generally welcome. If you want to contribute something which changes game mechanics, no matter how small, please talk to someone with commit privileges first, its best to remember that those with commit access determine the direction of the mod as a whole. - -### License & Copyright +## License Applied Energistics 2 is (c) 2013 - 2014 AlgorithmX2 and licensed under LGPL v3. See the LICENSE.txt for details or go to http://www.gnu.org/licenses/lgpl-3.0.txt for more information. + +## 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. + +## Building + +1. Clone this repository via + - SSH `git clone --recursive git@github.com:AppliedEnergistics/Applied-Energistics-2.git` or + - HTTPS `git clone --recursive https://github.com/AppliedEnergistics/Applied-Energistics-2.git` + - Note the `--recursive` option. This enables to automatically clones of all submodules. AE2 uses the [AE2-API](https://github.com/AlgorithmX2/Applied-Energistics-2-API) and [AE2-Lang](https://github.com/AppliedEnergistics/AppliedEnergistics-2-Localization) repositories. +2. Setup workspace + - Decompiled source `gradlew setupDecompWorkspace` + - Obfuscated source `gradlew setupDevWorkspace` + - CI server `gradlew setupCIWorkspace` +4. Setup IDE + - IntelliJ: Import into IDE and execute `gradlew genIntellijRuns` afterwards + - Eclipse: execute `gradlew eclipse` +5. Build `gradlew build`. Jar will be in `build/libs` +6. (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` TODO) + +## Contribution + +Before you want to add major changes, you might want to discuss them with me 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). + +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 + +If you are only doing single file pull requests, GitHub supports using a quick way without the need of cloning your fork. + +## Credits + +Thanks to + +* Notch et al for Minecraft +* Lex et al for MinecraftForge +* AlgorithmX2 for AppliedEnergistics2 +* all [contributors](https://github.com/thatsIch/IntelliE-Scala/graphs/contributors) helping making this mod. From cb20d9a7a2f5361555727720d9ba8139bbe7e51e Mon Sep 17 00:00:00 2001 From: thatsIch Date: Fri, 26 Sep 2014 16:52:23 +0200 Subject: [PATCH 2/3] Wrong contributors link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9515af3c9..aae316ca6 100644 --- a/README.md +++ b/README.md @@ -73,4 +73,4 @@ Thanks to * Notch et al for Minecraft * Lex et al for MinecraftForge * AlgorithmX2 for AppliedEnergistics2 -* all [contributors](https://github.com/thatsIch/IntelliE-Scala/graphs/contributors) helping making this mod. +* all [contributors](https://github.com/AppliedEnergistics/Applied-Energistics-2/graphs/contributors) helping making this mod. From e7002b0c4d0a8cb6fa2ac90e3e14edbb5a9e5208 Mon Sep 17 00:00:00 2001 From: thatsIch Date: Fri, 26 Sep 2014 17:07:02 +0200 Subject: [PATCH 3/3] Removed unused GT API --- .../api/interfaces/IDigitalChest.java | 29 ------- .../interfaces/IHasWorldObjectAndCoords.java | 75 ------------------- 2 files changed, 104 deletions(-) delete mode 100644 src/api/java/gregtechmod/api/interfaces/IDigitalChest.java delete mode 100644 src/api/java/gregtechmod/api/interfaces/IHasWorldObjectAndCoords.java diff --git a/src/api/java/gregtechmod/api/interfaces/IDigitalChest.java b/src/api/java/gregtechmod/api/interfaces/IDigitalChest.java deleted file mode 100644 index 3c3fb6b0e..000000000 --- a/src/api/java/gregtechmod/api/interfaces/IDigitalChest.java +++ /dev/null @@ -1,29 +0,0 @@ -package gregtechmod.api.interfaces; - -import net.minecraft.item.ItemStack; - -/** - * You are allowed to include this File in your Download, as i will not change it. - */ -public interface IDigitalChest extends IHasWorldObjectAndCoords { - /** - * Is this even a TileEntity of a Digital Chest? - * I need things like this Function for MetaTileEntities, you MUST check this!!! - * Do not assume that it's a Digital Chest or similar Device, when it just implements this Interface. - */ - public boolean isDigitalChest(); - /** - * Gives an Array of Stacks with Size (of all the Data-stored Items) of the correspondent Item kinds (regular QChests have only one) - * Does NOT include the 64 "ready" Items inside the Slots, and neither the 128 Items in the overflow Buffer. - */ - public ItemStack[] getStoredItemData(); - /** - * A generic Interface for just setting the amount of contained Items - */ - public void setItemCount(int aCount); - - /** - * Gets the maximum Item count for this QChest alike Storage. This applies to the Data-Storage, not for the up to 192 buffered Items! - */ - public int getMaxItemCount(); -} \ No newline at end of file diff --git a/src/api/java/gregtechmod/api/interfaces/IHasWorldObjectAndCoords.java b/src/api/java/gregtechmod/api/interfaces/IHasWorldObjectAndCoords.java deleted file mode 100644 index f932507e8..000000000 --- a/src/api/java/gregtechmod/api/interfaces/IHasWorldObjectAndCoords.java +++ /dev/null @@ -1,75 +0,0 @@ -package gregtechmod.api.interfaces; - -import net.minecraft.entity.player.EntityPlayer; -import net.minecraft.inventory.IInventory; -import net.minecraft.nbt.NBTTagCompound; -import net.minecraft.tileentity.TileEntity; -import net.minecraft.world.World; -import net.minecraft.world.biome.BiomeGenBase; - -/** - * This is a bunch of Functions my TileEntities provide, to make life much easier, and to get rid of internal TileEntity stuff. - */ -public interface IHasWorldObjectAndCoords { - public World getWorld(); - public int getXCoord(); - public int getYCoord(); - public int getZCoord(); - - public boolean isServerSide(); - public boolean isClientSide(); - - public int getRandomNumber(int aRange); - - public TileEntity getTileEntity(int aX, int aY, int aZ); - public TileEntity getTileEntityOffset(int aX, int aY, int aZ); - public TileEntity getTileEntityAtSide(byte aSide); - public TileEntity getTileEntityAtSideAndDistance(byte aSide, int aDistance); - - public IInventory getIInventory(int aX, int aY, int aZ); - public IInventory getIInventoryOffset(int aX, int aY, int aZ); - public IInventory getIInventoryAtSide(byte aSide); - public IInventory getIInventoryAtSideAndDistance(byte aSide, int aDistance); - - public short getBlockID(int aX, int aY, int aZ); - public short getBlockIDOffset(int aX, int aY, int aZ); - public short getBlockIDAtSide(byte aSide); - public short getBlockIDAtSideAndDistance(byte aSide, int aDistance); - - public byte getMetaID(int aX, int aY, int aZ); - public byte getMetaIDOffset(int aX, int aY, int aZ); - public byte getMetaIDAtSide(byte aSide); - public byte getMetaIDAtSideAndDistance(byte aSide, int aDistance); - - public byte getLightLevel(int aX, int aY, int aZ); - public byte getLightLevelOffset(int aX, int aY, int aZ); - public byte getLightLevelAtSide(byte aSide); - public byte getLightLevelAtSideAndDistance(byte aSide, int aDistance); - - public boolean getSky(int aX, int aY, int aZ); - public boolean getSkyOffset(int aX, int aY, int aZ); - public boolean getSkyAtSide(byte aSide); - public boolean getSkyAtSideAndDistance(byte aSide, int aDistance); - - public BiomeGenBase getBiome(int aX, int aZ); - - /** - * Function of the regular TileEntity - */ - public void writeToNBT(NBTTagCompound aNBT); - - /** - * Function of the regular TileEntity - */ - public void readFromNBT(NBTTagCompound aNBT); - - /** - * Function of the regular TileEntity - */ - public boolean isInvalid(); - - /** - * Opens GUI-ID of any Mod - */ - public void openGUI(EntityPlayer aPlayer, int aID, Object aMod); -} \ No newline at end of file