R2API
R2API copied to clipboard
risk-of-thunder
It's API's all the way down.
Please name things a little less vaguely. Make use of verbs to describe behaviours of modules/libraries instead of calling everything an API. Pretty sure a conclusion was already reached by just formalising the issue for the sake of it.
Requires breaking changes to address.
Something we have going on over in valheim is a merger between three libraries. One lib which we decided to base from had a structure such that Manager interfaces provided singletons to provide a standardised way to interact with collections via the means of abstraction layers of Entities such as CustomItem, CustomRecipe.. so on and so forth. Food for thought.
You could put explicit design patterns in the names of each API structure.
Another idea could be to organise by what the APIs are trying to accomplish, for instance ItemAPI could be doing any of adding items, changing existing items, changing how items relate to another, changing how items display, etc. which could have APIs with narrower scopes but at the same level: CustomItem, VanillaItem, ItemLinking, ItemDisplay
Is this even an issue with split assemblies anymore? sure we cant rename the submodules because that'd be a breaking change, but since each submodule is its own thing there's less reason to suffix everything with API
This issue was never a valid issue to begin with, you can only change such things when doing big refactoring breaking change, which will definitely not happen right now nor in the future due to such change being a preference / personal choice to begin with
