Documentation icon indicating copy to clipboard operation
Documentation copied to clipboard

[Page Request] Designing a mod API

Open Bluexin opened this issue 7 years ago • 3 comments

Basically some "recommended guidelines" for what mod APIs should look like. Ama said in stream chat he's had it planned, I'm just adding it here so people can add their input and for it to be officially on the todo-list ^-^

Bluexin avatar Jun 17 '18 00:06 Bluexin

What do you expect from this? Everyone images a perfect API differently. I would like to do something into that direction though if you can explain it better.

JTK222 avatar Jun 18 '18 20:06 JTK222

Was about what kind of stuff to expose trough capabilities, interfaces, or other means (and how to properly go about exposing the things), and the proper way to consume them (like how to not use @Optional which is getting removed and apparently was bad practice in the first place, not including the API classes etc).

Even though different people see APIs in different ways, as a result some are very bad to work with. Maybe some guidelines could help having a more uniform API style, where using different mod APIs could be done in a similar way.

Bluexin avatar Jun 22 '18 23:06 Bluexin

Kevin, ask on the Forge Forums. This isn't the place to get mod support.

TheCurle avatar Mar 25 '21 10:03 TheCurle