Repository navigation
Deprecation rules
§ Deprecation rules in the Avoid Framework
Sometimes you may be wondering, is this API safe to use?
Good thought. And, well, the answer depends on the library you use.
In most Minecraft mods, the answer is no.
Most likely Minecraft will receive a hundred more incompatible changes in the next update, and the given library would adapt (what other way after all?).
But what about Avoid? Well, the answer is: high chance it is.
Okay, well sorry for disappointing you. But it's not as bad as you think - let me explain.
-
Stable elements should use the annotation
@NeverRemoval.
Type presence doesn't always indicate all-member presence. -
Incubating elements should use the annotation
@Discouraged.
This means they're not yet fully established; incompatible changes may emerge. -
Deprecated elements should use the annotation
@Deprecated.
This means they shouldn't be used anymore.
Well then, with those excellent rules, why worry?
Unfortunately I don't always keep the promise. I do my best to not disappoint you, but sometimes that stupid @NeverRemoval element preventing further progress just has to be wiped out of existence.
Don't hesitate to use cool-looking APIs, though.
If an API looks good and you don't see any implementation or concept errors/mistakes, then you're most likely fine.
©️ Copyright 2026 Olafcio (on behalf of the AvoidLib org)
📝 All Rights Reserved
Avoid Framework
🏚️ 1. Home
📽️ 2. Creating your mod
🌄 3. Adding assets to your mod
🧊 4. Creating a block
💧 5. Creating a fluid
✏️ 6. Creating an item
🎯 7. Creating an entity selector
🤖 8. Creating a command
⌨️ 9. Creating a keybind
🐺 10. Creating an entity
🌫️ 11. Creating a fog
🔩 12. Creating an item component
🔮 13. Creating an effect
📚 14. Language support & adding libraries
🚩 15. Deprecation rules
⏳ 16. Loading philosophy
Migrations