INDEX

src/main/java/api/hbm/redstoneoverradio/IRORInteractive.java

@@ -8,6 +8,7 @@ public interface IRORInteractive extends IRORInfo {
 	public static String EX_NULL = "Exception: Null Command";
 	public static String EX_NAME = "Exception: Multiple Name Separators";
 
+	/** Runs a function on the ROR component, usually causing the component to change or do something. Returns are optional. */
 	public Object runRORFunction(String name, String[] params);
 	
 	/** Extracts the command name from a full command string */

src/main/java/api/hbm/redstoneoverradio/IRORValueProvider.java

@@ -2,5 +2,6 @@ package api.hbm.redstoneoverradio;
 
 public interface IRORValueProvider extends IRORInfo {
 
+	/** Grabs the specified value from this ROR component, operations should not cause any changes with the component itself */
 	public Object provideRORValue(String name);
 }

src/main/java/api/hbm/redstoneoverradio/package-info.java

@@ -6,17 +6,41 @@ package api.hbm.redstoneoverradio;
 
 /*
 
-  __     __      __     _______       ________     __   __           __        __       ______     __
- /_/|   /_/\    /_/|   /______/\     /_______/|   /_/| /_/|         /_/|_____ /_/|     /_____/|   /_/|
-|  ||  |   \\  |  ||  |   ___  \\   |  ______|/  |  |||  ||        |  |/_____|  ||    |___   ||  |  ||
-|  ||  |  \ \\ |  ||  |  |   \  \\  |  ||___     |  |/|  |/        |   ______   ||     /__|  ||  |  ||__
-|  ||  |  |\ \\|  ||  |  |    \ ||  |  |/__/|     \     //         |  |/_____|  ||    |   ___|/  |  |/_/|
-|  ||  |  ||\ \|  ||  |  |    | ||  |  ____|/      >   </\         |____    ____|/_   |  |/__/|  |   __|/
-|  ||  |  || \ |  ||  |  |    / ||  |  ||_____    /  _  \/|       /_____|  |______/|  |______|/  |  ||
-|  ||  |  ||  \   ||  |  |___/  //  |  |/____/|  |  / \  ||      |________________|/             |  ||
-|__|/  |__|/   \__|/  |________//   |________|/  |__| |__|/                                      |__|/
+  __     __      __     _________      ________     __    __           __        __       ______     __
+ /_/|   /_/\    /_/|   /________/\    /_______/|   /_/|  /_/|         /_/|_____ /_/|     /_____/|   /_/|
+|  ||  |   \\  |  ||  |   ___   \ \  |  ______|/  |  |\_|  ||        |  |/_____|  ||    |___   ||  |  ||
+|  ||  |  \ \\ |  ||  |  ||  \   \/  |  ||___     |  \/_/  |/        |   ______   ||     /__|  ||  |  ||__
+|  ||  |  |\ \\|  ||  |  ||   \  ||  |  |/__/|     \      //         |  |/_____|  ||    |   ___|/  |  |/_/|
+|  ||  |  ||\ \|  ||  |  ||    | ||  |  ____|/      >    </\         |____    ____|/_   |  |/__/|  |   __|/
+|  ||  |  || \ |  ||  |  ||___/  |/  |  ||_____    /  __  \/|       /_____|  |______/|  |______|/  |  ||
+|  ||  |  ||  \   ||  |  |/__/   /   |  |/____/|  |  /| \  ||      |________________|/             |  ||
+|__|/  |__|/   \__|/  |_________/    |________|/  |__|/ |__|/                                      |__|/
 
 (not AN index, INDEX is just the codename)
 (also no i did not use an ASCII font generator i spent like half an hour on this)
 
+INDEX includes Redstone-over-Radio APIs for interacting with ROR torches in ways more complex than simple comparator output,
+simply put, certain ROR torches may run functions on the ROR component or read more complex values. This means that with the ROR
+system alone, one can make complex monitoring and logic systems controlling machines via redstone automation.
+
+INDEX includes:
+- IRORInfo, an interface that provides a list of all valid functions. This interface should never be implemented directly because
+  it is worthless on its own, rather it is extended by all other ROR API interfaces
+- IRORValueProvider, a simple interface that returns values based on names, serving as a simple getter. Get operations should never
+  cause changes within the ROR component, and should be kept simple
+- IRORInteractive, an interface providing functions equivalent to java, usually performing a state change within the component and
+  optionally returning a value
+
+On the implementation side we can expect:
+- ROR readers, torches which have a list of named values which are read, as well as frequencies on which these values are boradcasted
+- ROR controllers, torches which have one frequency and can receive commands with parameters which will be executed on the component
+- ROR programmers, torches which have a list of frequencies and return frequencies which can receive commands with parameters and
+  then send the return value on the return frequency
+- ROR logic receivers, torches which can turn signals into redstone based on various factors like arithmetic comparison and string
+  operators like matches, matches not and substring (thanks to vær for taking care of that)
+
+ROR programmers can indeed do everything that the readers and controllers can, but their added complexity requires more GUI elements
+which are more time-consuming to set up and limits the amount of command channels available, hence why readers and controllers exist
+when only a simple solution is required
+
 */

src/main/resources/assets/hbm/textures/blocks/rtty_programmer.png.mcmeta

@@ -0,0 +1,5 @@
+{
+  "animation": {
+    "frametime": 10
+  }
+}

src/main/resources/assets/hbm/textures/blocks/rtty_reader.png.mcmeta

@@ -0,0 +1,5 @@
+{
+  "animation": {
+    "frametime": 10
+  }
+}