Quantum64 / ExGregilo

GregTech addon for skyblock
GNU General Public License v3.0
4 stars 8 forks source link

ExGregilo

Version Gregtech

Build Status Dev builds Release builds Issues [License]()

Bringing Greg’s vision for the world into the sky…

Table of Contents

Features

Core

GregTech

ExNihilo

ExAstris

ExCompressum

MineTweaker

Contributing

Textures

Texture creation is the most valuable way that you can currently contribute. I have no artistic talent whatsoever and most of the textures are either nonexistent or desperately awaiting replacement. Note that GregTech machine overlays should simply accent the underlying machine block, not totally obscure it. Please submit textures by forking the repository, replacing the textures you want to contribute, then submitting a pull request with your updates textures. Feel free to submit changes for any textures, even ones with checked boxes, if you think that you can improve them.

Texture Locations

Blocks - Items - GregTech Tools - GregTech Machines - GregTech GUIs

Texture List

Translations

If you speak multiple languages, translating ExGregilo into another language is an appreciated contribution. Fork the repository and create a new file for your language here. If the file already exists, you can check if it needs to be updated with new entries. Copy and translate the entries from here into your language file. Check back from time to time for new entries that need to be translated. Once your changes are finished, submit a pull request so they can be included in the next release.

Programming

Currently I do most of the programming for ExGregilo myself. If you find an issue that you want to fix yourself, you can fork the repository and submit a pull request. This mod is programmed in a somewhat unconventional way using a dependency injection framework, so be sure to test your changes before submitting them. All pull requests with code changes must pass the automated TravisCI test. If your PR does not pass, check for the cause of the issue in the TravisCI and fix it so your request can be merged.

Downloads

If you want to test the latest changes and report issues, you can download the development build which is automatically generated and deployed after every commit. Do not expect this build to be stable and do not use it in a modpack. The development build of the mod is located on the GitHub releases page here.

Stable builds of the mod that can be used in modpacks and should have few stability issues are found on the official Curse project page which can be found here.

Issues or Feature Requests

Issues and feature requests should only be submitting on the GitHub issue tracker found here. When submitting an issue, try to include as much information about the problem as possible. If the game has crashed due to ExGregilo, you are absolutely required to submit a crash report in your issue description. Do not paste the entire crash report into the GitHub issue, but rather include a link to it on a paste service such as Gist. Feature requests are also accepted on the issue tracker and will be considered for a future release of the mod.

Regarding 1.12

Right now a very skilled programmer is working on porting GregTech to 1.12. In fact, the port is almost done aside from the massive amount of missing content. Currently it is used by few to no people, so I am not interested in porting to 1.12 at this time. I do, however, think that many of the 1.12 mods are superior to 1.7 mods, so after the GregTech 1.12 port is complete, I would not be surprised if packs start moving to the 1.12 version of GregTech. If this happens, I plan on updating ExGregilo to 1.12, however until then it is going to stay a 1.7 mod.

API

Although the programming style of this mod can be hard to wrap your head around, one benefit of it is that the codebase becomes very modular. This is useful for other mods that want to modify the behavior of ExGregilo. The code is currently not documented because I am concerned with adding features as quickly as possible right now with limited time. Once I believe the mod is feature complete I may document the code (probably not until after the 1.12 update, if that ends up happening). More information on how to use the API can be found here. I currently am not providing deobf jars of the mod, but you can compile one yourself if you really want to make an addon. NEVER INCLUDE MY API FILES IN YOUR MOD. The only thing this does it break version compatibility and for no reason. Just don’t do it.

Modpacks

In accordance with the GPLv3 license, you can use this code for pretty much whatever. That means you have full permission to include this mod in an unmodified or modified form in your modpacks. Just remember that any distributed modified version (or any mod that uses any code from this mod) are required to be open source and state changes to comply with the GPLv3 license.

Donate

Programming takes a lot of effort and a lot of coffee. If you want to support the development of this mod, you can send Ethereum (ETH) or ERC20 tokens to this address: 0xadf06b287a6571c7971ef65c2102d9fdd3907fd5. The only thing you get from donating is the satisfaction of knowing that you contributed to the development of this mod. Any support is greatly appreciated.