Using an Api with forge

[Creeperologist]

well I've done of modding in the past but I recently took an interest in using various api to interconnect one of the mods I have been working on since 1.3

 

I'm currently trying to use thaumcraft 3's api, and considering looking into industrial craft and such as well in the future but for now what I'm trying to figure out for either is the same

 

what is it that you must do in the setup to be able to use an external api

 

I know there is information on the tutorials page however it appears as though things are no longer the the same as they were, and I have yet to find a working guide for the current setup

 

 

 

 

[AEtherchild]

After you install Forge, go to your MCP/src/Minecraft/ folder. Post the unzipped API in there. It's instantly accessible and usable within Eclipse or whichever other editor you use.

 

For Thaumcraft's API specifically (and GregTech's), there will be various errors within the API files themselves as you open Eclipse. Find any errored lines within the affected classes, and literally delete the lines/methods until there's no more errors. The API files themselves won't be included in your mod, so provided the methods themselves aren't deleted from the API, you should get no reobf errors and it should function correctly in-game.

 

Note that the APIs will be dumped into your reobf folder. Ignore them completely. This is because the updatemd5 script is being skipped because, meh, it's effort to make it work if you use any API outside of Forestry's.

[Terristen]

Since I can't seem to find this anywhere, what about for APIs that don't distribute their source docs? Like RenderPlayer API and Player API? Obviously some people have used these in their mods already, but no reference on how to decompile them.

 

Far be it form me to complain about an API that someone is releasing for free out to the masses, but the installation instructions for modders is....lacking?

 

I'm a fairly new modder but a long-time programmer, and I'm finding myself less than gruntled on the modding documentation in general; but back to topic, does anyone know how to get these APIs into the project?

[case]

I am also trying to make a mod with a parent mod - even having the source to the api does not make it possible to actually run the mod in the development client.  As far as I can tell, you need to decompile the mod with the minecraft source, but as Forge does all that for you in one step, I'm not sure how it is *supposed* to be done.

 

If you have the API, but not the API *source*, you should be able to include the API as an external jar using Eclipe's Project > Properties > Libraries menu.  This won't help you with getting your development client working, as below, but it should make it so you have access to the types and so forth provided by the API Jar file.

 

I have been collecting some information about how to do this at http://www.minecraftforge.net/wiki/Developing_Addons_for_Existing_Mods. Perhaps it will be of help to you.  If not, if you figure it out, perhaps you can add to this.

 

I agree about the state of the documentation, although the Generic Mod documentation was very helpful for getting started.  My impression is that the community is still very fractured.  Some of the major mod creators tend to look down on people who create mods that use their mods, and others get pissy about it.  Then there is BuildCraft!  But, I don't need pipes.  So.

[Terristen]

I'll dig into that info, I hadn't come across it yet. If I figure anything out here, I'll post my solution. If I didn't keep getting sidetracked with these nuisance issues... and all this trying has pretty much screwed up my development environment beyond repair. Probably going to have to begin at scratch again.

[Terristen]

Ok, I believe I've found the solution. I had figured out a little bit on my own, but then came across the APiI developer's FAQ on another API which filled in the holes for me. Here's the scoop.

 

1) install forge as usual

2) run install.bat(sh) etc...

3) rename /src to /src_forge

4) replace the minecraft.jar file located in the /mcp/jars directory with one modded with the API you need to decompile

5) run mcp/cleanup.bat(sh)

6) run mcp/decompile.bat(sh)

7) copy the appropriate source files to the correct /src_forge/ directory

rename or delete /src (to /src_decompile/ or something)

9) rename /src_forge back to /src

 

That's it.

Thank you to Divisor for producing these APIs as well as the instructions I've paraphrased above. I found these on his Player API forum post, though I do not believe they were on his RenderPlayer API forum post (which was the API I first targeted).

 

Some people may think, "well duh...." but my feeling is the more times it's spelled out online, the more likely someone will find it when they search.

 

I guess a similar process can be followed for other APIs when src is not included. Let me know if this hits the spot, I'll be testing the whole process tonight.

[Terristen]

Followup...

Imported the files specified by Divisor in his instructions, but had so many errors in the java, I didn't know even where to start. over a hundred. a few looked like easy fixes, but the rest appeared to be too complicated for me as a mere mortal to attempt to fix.

 

<PSA>

API developers, please release the .java files if you intend to make your API widely used.

</PSA>

[case]

I don't really understand step 4 of the instructions.  The external mod can't have modified minecraft.jar itself, right?  It should just add other jar files to the minecraft system.  Otherwise how could you have more than one mod at a time?

[case]

Also, if you have a ton of errors, is it possible you have an incompatible version of forge/the mod?  They do have to both work with the same version of Minecraft, of course.