summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKyle Gunger <kgunger12@gmail.com>2021-01-26 00:10:09 -0500
committerKyle Gunger <kgunger12@gmail.com>2021-01-26 00:10:09 -0500
commitd94d1d89565998fdccff071a7c9b65ea1e264ce7 (patch)
treeab39d145d2cf97599bbb245b7220b397826c883c /README.md
parentb0f364399bfaa952c8692925efda9ffdf2fbd75e (diff)
Getting ready for 2.0 & Quality of Life changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 873c2b5..c29baef 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,16 @@ When working with blocks, the convention is such:
1. The BlockEntity will impliment the INode/IAcceptorNode/IProviderNode interfaces.
2. The Placed block will ask the blocks around it to become a provider and or an acceptor, not the other way around.
+(These conventions assume a server-side approach to your mod's pipes implementation)
+
+### Note from the author
+I won't try to update the requirements for the API too much, so it should keep consistant across MC versions. However, when a common requirement is determined, I will update the API. This can be determined by the major version of the mod.
+
+API updates/upgrades will only happen on Minecraft version increases (i.e. 1.16 -> 1.17, but not 1.16.4 -> 1.16.5) so all versions of the mod will work with other mods for the same MC version.
+
+First few changes may come quickly as the API stabilizes, but by version 3 or 4 I think there will be a lasting API.
+
+Release Candadites or Beta versions may or may not reflect the release API.
## License
This mod is available under the MIT licence.