IC² API and IC² Addon Creation. (The Code Part)

GregoriusT · Apr 13th 2014

This is the Thread about the IC2 API and IC2 Addons. If you have a Question about the API or the Dev Environment, you can post it here. If you look for the License Stuff then go here

API shipping

If you make an IC2 Addon where IC2 is always installed, you do not need to ship this API inside your Mod, since it is already contained in IC2 itself. So when you compile your Mod do not zip/jar up the IC2 API itself, because then your old IC2 API can accidentally override the IC2 API of IC2 itself what causes crashes.

If IC2 is not always installed (optional) you can use FML's @Optional annotation to strip missing interfaces at load-time. If you also don't call IC2 code without checking if IC2 is available first, the API isn't even required if IC2 is not installed. Calls to missing classes should only crash when the call actually happens, unreachable calls, e.g. due to a false if clause, don't.

Summary: There's no need to ship the API ever.

IDE / Eclipse / Dev environment

Start with a normal Forge workspace using the Forge src zip, extracting it, running gradle(w) setupDecomWorkspace and gradle(w) eclipse and importing it into Eclipse.
If you want to you can create a separate project for IC2 or just add IC2 to Forge's project. Add the IC2 dev jar as a library to the build path. You can get it from http://jenkins.ic2.player.to/job/IC2_experimental/, the file name is "industrialcraft-x-x.x.xxx-experimental-dev.jar" (should be the second one). It also needs to be copied to your eclipse working (run) directory's mods-Folder.

A Documentation of the API: http://ic2api.player.to/ic2api/html/annotated.html

build.gradle

A maven compatible repository for the api an dev jars is available at http://maven.ic2.player.to.
Add the following to your build.gradle to use it, adjusting the version number as needed:

Code

repositories {
	maven {
		name = "ic2"
		url = "http://maven.ic2.player.to/"
	}
}




dependencies {
	compile 'net.industrial-craft:industrialcraft-2:2.1.470-experimental:api'
}

Display More

1.8.9:

Code

repositories {
	maven {
		name = "ic2"
		url = "http://maven.ic2.player.to/"
	}
}




dependencies {
	compile 'net.industrial-craft:industrialcraft-2:2.3.225-ex18:api'
}

Display More

Note that the repositories block is different/outside the existing "buildscript { repositories {} }" block. Ordering matters in build.gradle.
If you use IC2 core functionality, which isn't recommended, you have to replace api with dev at the end of dependencies - compile. Alternatively, you can use forged "deobfCompile" with the normal jar file instead of the dev one. This will make sure, that it will work no matter if you use different mappings than we use.

Foghrye4 · Apr 25th 2014

I've got a question. I use

Quote

ElectricItem.manager.discharge(this.dischargeSlot.get(),20,1, false,false);

to discharge battery in discharge slot. In GUI everything looks fine, but when i extract battery from slot, it returns to full charge. What i forgot to add to code?

Player · Apr 26th 2014

You probably call it client side, only the server should do this, typically from the tile entity providing the slot.

Foghrye4 · Apr 26th 2014

Quote from Player

You probably call it client side, only the server should do this, typically from the tile entity providing the slot.

Yes, thank you. Also i forgot to write

Code

public void updateProgressBar(int index, int value)

in container class.

luacs1998 · May 10th 2014

Those who want to use the dev jar have to include this line in the dependencies closure as well:

compile 'com.googlecode.efficient-java-matrix-library:ejml:0.23'

luacs1998 · May 10th 2014

Those who want to use the dev jar have to include this line in the dependencies closure as well:

compile 'com.googlecode.efficient-java-matrix-library:ejml:0.23'

Foghrye4 · May 17th 2014

Quote from GregoriusT

Code

repositories {
	maven {
		name = "ic2"
		url = "http://maven.ic2.player.to/"
	}
}
dependencies {
	compile 'net.industrial-craft:industrialcraft-2:2.1.470-experimental:api'
}

It seems, that it won't work with my version of gradle.

Display Spoiler

Code

A:\Forge 1.7.2>gradlew build




FAILURE: Build failed with an exception.




* Where:
Build file 'A:\Forge 1.7.2\build.gradle' line: 21




* What went wrong:
A problem occurred evaluating root project 'Forge 1.7.2-1061'.
> Could not find method compile() for arguments [net.industrial-craft:industrial
craft-2:2.1.470-experimental:dev] on org.gradle.api.internal.artifacts.dsl.depen
dencies.DefaultDependencyHandler_Decorated@23442dbd.




* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug
option to get more log output.




BUILD FAILED




Total time: 4.939 secs

Display More

Here is build.gradle

Code

buildscript {
    repositories {
        mavenCentral()
        maven {
            name = "forge"
            url = "http://files.minecraftforge.net/maven"
        }
        maven {
           name = "sonatype"
          url = "https://oss.sonatype.org/content/repositories/snapshots/"
        }
	maven {
		name = "ic2"
		url = "http://maven.ic2.player.to/"
	}
    }




    dependencies {




        classpath 'net.minecraftforge.gradle:ForgeGradle:1.2-SNAPSHOT'
	compile 'net.industrial-craft:industrialcraft-2:2.1.470-experimental:dev'




    }
}




apply plugin: 'forge'




version = "0.40"
group= "com.yourname.modid" // http://maven.apache.org/guides/mini/guide-naming-conventions.html
archivesBaseName = "modid"




minecraft {
    version = "1.7.2-10.12.1.1061"
    assetDir = "eclipse/assets"
}




processResources
{
    // this will ensure that this task is redone when the versions change.
    inputs.property "version", project.version
    inputs.property "mcversion", project.minecraft.version




    // replace stuff in mcmod.info, nothing else
    from(sourceSets.main.resources.srcDirs) {
        include 'mcmod.info'

        // replace version and mcversion
        expand 'version':project.version, 'mcversion':project.minecraft.version
    }

    // copy everything else, thats not the mcmod.info
    from(sourceSets.main.resources.srcDirs) {
        exclude 'mcmod.info'
    }
}

Display More

Any guess?

Player · May 18th 2014

They have to go outside buildscript {}, that block is exclusively for Forge.

Foghrye4 · May 18th 2014

*facepalm* I was had to read first message carefully! What a shame...

inucune · Jun 4th 2014

I have minecraft and forge set up in eclipse and have downloaded the dev version of ic2e. How do i add the IC2 dev jar as a library to the build path, where is the eclipse working (run) directory's mods-Folder(or what is it called), and is the maven repository required?

Foghrye4 · Jun 5th 2014

You don't need a special folder to ic2 dev. Place it anywhere you want. Run eclipse with your project, right-click your project root folder, select properties->Java build path-> Libraries-> Add external Jar and select ic2-dev to add.
How to modify build.gradle file is written right in first message in this thread. Just don't repeat my mistake.

xbony2 · Jun 8th 2014

getTransferLimit is confusing me. I see what it's for, but I have no idea what to put as an value. What does the Advanced RE-Battery and Energy Crystal use as their value?

Foghrye4 · Jun 8th 2014

256 and 2048

GregoriusT · Jun 8th 2014

Nope, it is not 256 and 2048, even though it SHOULD be like that, the Values are actually much higher making them charge much faster than they should.

Foghrye4 · Jun 8th 2014

Quote from GregoriusT

Nope, it is not 256 and 2048, even though it SHOULD be like that, the Values are actually much higher making them charge much faster than they should.

(with enthusiastic voice) It's magical! Even Notch himself don't know truth!

...i guess.

Player · Jun 8th 2014

It just determines how long the user has to wait until the item is fully charged in a mfe etc, about 10-30s for a full charge depending on the tool should work well

Foghrye4 · Jun 14th 2014

About IC2 recipe manager. I tried to add this recipe:

Code

Recipes.advRecipes.addRecipe(new ItemStack(IHLMod.chargerEjectorItem,1), new Object[] { "PGP", "GCG", "GLG", Character.valueOf('P'), IC2Items.getItem("platelapi"), Character.valueOf('G'), new ItemStack(Blocks.glass,1), Character.valueOf('C'), IC2Items.getItem("glassFiberCableItem"), Character.valueOf('L'), IC2Items.getItem("lapotronCrystal")});

No result. Nonetheless, this code is working:

Code

Recipes.advRecipes.addRecipe(new ItemStack(IHLMod.chargerEjectorItem,1), new Object[] { "PGP", "GCG", "G G", Character.valueOf('P'), IC2Items.getItem("platelapi"), Character.valueOf('G'), new ItemStack(Blocks.glass,1), Character.valueOf('C'), IC2Items.getItem("glassFiberCableItem")});

It seems, that item damage is important as recipe input, although normal IC2 recipes are working with any charge level.
How i can use items with any charge level as recipe input?

GregoriusT · Jun 14th 2014

Use "OreDictionary.Wildcard" as Damage for your Item to make Damage irrelevant. All other Mods and vanilla Minecraft do that too.

Foghrye4 · Jun 14th 2014

GregoriusT, thank you!

Code

ItemStack crystal = IC2Items.getItem("lapotronCrystal").copy();
crystal.setItemDamage(OreDictionary.WILDCARD_VALUE);
Recipes.advRecipes.addRecipe(new ItemStack(IHLMod.chargerEjectorItem,1), new Object[] { "PGP", "GCG", "GLG", Character.valueOf('P'), IC2Items.getItem("platelapi"), Character.valueOf('G'), new ItemStack(Blocks.glass,1), Character.valueOf('C'), IC2Items.getItem("glassFiberCableItem"), Character.valueOf('L'), crystal});

Now it is working.

P.S.:
Khem... it was supposed to be a thread about IC2 API and addon development. I don't mind, if irrelevant questions will be erased from that thread, or moved to another section.

Chocohead · Jun 14th 2014

Quote from Foghrye4

it was supposed to be a thread about IC2 API and addon development. I don't mind, if irrelevant questions will be erased from that thread, or moved to another section.

Someone else might have the same problem, so it makes sense if most of the answers are in the same place.

Share