Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/gtmega/ingame-info-xml

Display various information directly on the in-game GUI.
https://github.com/gtmega/ingame-info-xml

Last synced: 1 day ago
JSON representation

Display various information directly on the in-game GUI.

Awesome Lists containing this project

README 

          
## Welcome to InGame Info XML!

[Compiling InGame Info XML](#compile-ingame-info-xml) - for those that want the latest unreleased features



[Contributing](#contributing) - for those that want to help out



### Compiling

[Setup Java](#setup-java)



[Setup Git](#setup-git)



[Setup InGame Info XML](#setup-ingame-info-xml)



[Compile InGame Info XML](#compile-ingame-info-xml)



[Updating Your Repository](#updating-your-repository)



#### Setup Java

The Java JDK is used to compile InGame Info XML.



1. Download and install the Java JDK.

    * [Windows/Mac download link](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html). Scroll down, accept the `Oracle Binary Code License Agreement for Java SE`, and download it (if you have a 64-bit OS, please download the 64-bit version).

    * Linux: Installation methods for certain popular flavors of Linux are listed below. If your distribution is not listed, follow the instructions specific to your package manager or install it manually [here](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html).

        * Gentoo: `emerge dev-java/oracle-jdk-bin`

        * Archlinux: `pacman -S jdk7-openjdk`

        * Ubuntu/Debian: `apt-get install openjdk-7-jdk`

        * Fedora: `yum install java-1.7.0-openjdk`

2. Set up the environment.

    * Windows: Set environment variables for the JDK.

        1. Go to `Control Panel\System and Security\System`, and click on `Advanced System Settings` on the left-hand side.

        2. Click on `Environment Variables`.

        3. Under `System Variables`, click `New`.

        4. For `Variable Name`, input `JAVA_HOME`.

        5. For `Variable Value`, input something similar to `C:\Program Files\Java\jdk1.7.0_45` exactly as shown (or wherever your Java JDK installation is), and click `Ok`.

        6. Scroll down to a variable named `Path`, and double-click on it.

        7. Append `;%JAVA_HOME%\bin` EXACTLY AS SHOWN and click `Ok`. Make sure the location is correct; double-check just to make sure.

3. Open up your command line and run `javac`. If it spews out a bunch of possible options and the usage, then you're good to go. If not try the steps again.



#### Setup Git

Git is used to clone InGame Info XML and update your local copy.



1. Download and install Git [here](http://git-scm.com/download/).

2. *Optional* Download and install a Git GUI client, such as Github for Windows/Mac, SmartGitHg, TortoiseGit, etc. A nice list is available [here](http://git-scm.com/downloads/guis).



#### Setup InGame Info XML

This section assumes that you're using the command-line version of Git.



1. Open up your command line.

2. Navigate to a place where you want to download InGame Info XML's source (eg `C:\Development\Github\Minecraft\`) by executing `cd [folder location]`. This location is known as `mcdev` from now on.

3. Execute `git clone git@github.com:Lunatrius/InGame-Info-XML.git`. This will download InGame Info XML's source into `mcdev`.

4. Right now, you should have a directory that looks something like:



***

    mcdev

    \-InGameInfoXML

        \-InGameInfoXML's files (should have build.gradle)

***



#### Compile InGame Info XML

1. Execute `gradlew setupDevWorkspace`. This sets up Forge and downloads the necessary libraries to build InGame Info XML. This might take some time, be patient.

    * You will generally only have to do this once until the Forge version in `build.properties` changes.

2. Execute `gradlew build`. If you did everything right, `BUILD SUCCESSFUL` will be displayed after it finishes. This should be relatively quick.

    * If you see `BUILD FAILED`, check the error output (it should be right around `BUILD FAILED`), fix everything (if possible), and try again.

3. Go to `mcdev\InGameInfoXML\build\libs`.

    * You should see a `.jar` file named `InGameInfoXML-#.#.#-#.#.#.#-universal.jar`.

4. Copy the jar into your Minecraft mods folder, and you are done!



#### Updating Your Repository

In order to get the most up-to-date builds, you'll have to periodically update your local repository.



1. Open up your command line.

2. Navigate to `mcdev` in the console.

3. Make sure you have not made any changes to the local repository, or else there might be issues with Git.

    * If you have, try reverting them to the status that they were when you last updated your repository.

4. Execute `git pull master`. This pulls all commits from the official repository that do not yet exist on your local repository and updates it.



### Contributing

#### Submitting a Pull Request (PR)

So you found a bug in the code? Think you can make it more efficient? Want to help in general? Great!



1. If you haven't already, create a [GitHub account](https://github.com/signup/free).

2. Click the `Fork` icon located at the top-right of this page (below your username).

3. Make the changes that you want to and commit them.

    * If you're making changes locally, you'll have to do `git add -A`, `git commit` and `git push` in your command line.

4. Click `Pull Request` at the right-hand side of the gray bar directly below your fork's name.

5. Click `Click to create a pull request for this comparison`, enter your pull request title, and create a detailed description explaining what you changed.

6. Click `Send pull request`, and wait for feedback!



##### Instructions/Advice when submitting a Pull Request (PR)

I use [this](https://gist.github.com/460be5119b93d73c24ab) IDEA formatting. To be short:



* spaces for indentation

* braces on same lines



When you finish up your PR you'll want to [squash](http://davidwalsh.name/squash-commits-git) them into a single commit (unless it makes sense to have them split).



1. Make sure your working directory is clean by executing `git status`.

2. Execute `git rebase -i HEAD~X` where `X` is the amount of your commits. This will make sure you squash only your own commits.

3. You should now see a list of all your commits, prefixed with `pick`. Change all instances of `pick` (excluding the first!) into `squash` or simply `s`. Then save/quit the editor once.

4. A second screen should show up, displaying all the commit messages (you may edit them, delete or add some). After your done save/quit the editor again.

5. If git successfuly rebased things simply push your cleaned up commits by executing `git push -f`.



#### Creating an Issue

Crashing? Have a suggestion? Found a bug? Create an issue now!



1. Make sure your issue hasn't already been answered or fixed. Also think about whether your issue is a valid one before submitting it.

2. Go to the issues page.

3. Click `New Issue` right below `Star` and `Fork`.

4. Enter your issue title (something that summarizes your issue), and then add a detailed description ("Hey, could you add/change xxx?" or "Hey, found an exploit: stuff").

    * If you are reporting a bug, make sure you include the following:

        * Version (can be found in the mcmod.info file or in the mod list)

        * ForgeModLoader log (please use [gists](https://gist.github.com/) for large amounts of text!)

        * Detailed description of the bug

5. Click `Submit new issue`, and wait for feedback!



Shamelessly based this README off [pahimar's version](https://github.com/pahimar/Equivalent-Exchange-3).