Skip to content

Deprecation rules

Olafcio1 edited this page Sep 28, 2026 · 24 revisions

§ Deprecation rules in the Avoid Framework


Here are the rules:

  1. Stable elements should use the annotation @NeverRemoval.
    Type presence doesn't always indicate all-member presence.

  2. Incubating elements should use the annotation @Discouraged.
    This means they're not yet fully established; incompatible changes may emerge.

  3. Deprecated elements should use the annotation @Deprecated.
    This means they shouldn't be used anymore.

Unfortunately however 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/concept errors, then you're most likely fine.


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


    🧳 v1.25 -> v1.26
    🧳 v1.26 -> v1.27

Clone this wiki locally