summaryrefslogtreecommitdiff
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
parentb0f364399bfaa952c8692925efda9ffdf2fbd75e (diff)
Getting ready for 2.0 & Quality of Life changes
-rw-r--r--README.md10
-rw-r--r--src/main/resources/assets/transit-api/transit.pngbin0 -> 15002 bytes
-rw-r--r--src/main/resources/fabric.mod.json4
3 files changed, 12 insertions, 2 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.
diff --git a/src/main/resources/assets/transit-api/transit.png b/src/main/resources/assets/transit-api/transit.png
new file mode 100644
index 0000000..66e2fa3
--- /dev/null
+++ b/src/main/resources/assets/transit-api/transit.png
Binary files differ
diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json
index b2634d6..a2a499d 100644
--- a/src/main/resources/fabric.mod.json
+++ b/src/main/resources/fabric.mod.json
@@ -1,7 +1,7 @@
{
"schemaVersion": 1,
"id": "transit-api",
- "version": "1.0.0",
+ "version": "2.0.0",
"name": "Transit API",
"description": "Move things about!",
@@ -15,7 +15,7 @@
},
"license": "MIT",
- "icon": "assets/transit-api/icon.png",
+ "icon": "assets/transit-api/transit.png",
"environment": "*",
"entrypoints": {