How to create an API for my mod?

[HyagoSanter]

Hi guys, I wanted to take a very quick question. How do I create an API for my mod, so that other mods can use my items, blocks and machines?

 

  Thanks =)

[Mew]

For others to use your blocks and machines... That is easy. Forge has built in stuff for that I believe. But for the use of machines... I really can't be bothered to explain it all... I am sorry, school and no sleep are starting to bug me

[Guff]

Do you want modders to interface with your machines, or just add recipes (I assume your machines are some sort of furnace, modified to fit your mod's theme), or maybe use them in recipes to make upgraded versions? Using Optionals would be a good place to start for actually getting a possible instance of the item or block. For recipes, you could add a method that does it using reflection.

 

It really all depends on what you want modders to be able to do with your mod. My APIs generally don't provide the blocks and items for use, but they do usually provide ways to add custom behavior (MA allows mods to disable mashing, cloning, enchanting, and repairs; PR allows new special rewards, map types, teleport types, etc) and file listers.

 

I'd recommend starting with Optionals, though.

[GotoLink]

Give interfaces and register methods, just like Forge

[mrkirby153]

Give interfaces and register methods, just like Forge

 

I have an API for my mod similar to that.

 

Have a look: https://github.com/mrkirby153/MscHouses/tree/master/common/mrkirby153/MscHouses/api

[hydroflame]

most importantly

generate your javadocs

please

[mrkirby153]

most importantly

generate your javadocs

please

And what would I do with them once they're generated?

[hydroflame]

you nake them accessible so we can read them

[Mazetar]

you nake them accessible so we can read them

Yeah!

This is vital to getting anyone to spend time on the API.

 

This is a part of documenting the API, without documentation we who use your API can only GUESS on how it works.

This means we will either spend hours in frustration, whine about it or most likely avoid using the API