From 7e6ecdefb990cd11afa419c7b6e55d52a3367321 Mon Sep 17 00:00:00 2001
From: Boblet <hbmmods@gmail.com>
Date: Fri, 23 Aug 2024 14:23:44 +0200
Subject: [PATCH] INDEX

---
 .../redstoneoverradio/IRORInteractive.java    |   1 +
 .../redstoneoverradio/IRORValueProvider.java  |   1 +
 .../hbm/redstoneoverradio/package-info.java   |  42 ++++++++++++++----
 .../hbm/textures/blocks/rtty_programmer.png   | Bin 0 -> 260 bytes
 .../blocks/rtty_programmer.png.mcmeta         |   5 +++
 .../hbm/textures/blocks/rtty_reader.png       | Bin 0 -> 254 bytes
 .../textures/blocks/rtty_reader.png.mcmeta    |   5 +++
 .../gui/machine/gui_rtty_programmer.png       | Bin 0 -> 2778 bytes
 .../textures/gui/machine/gui_rtty_reader.png  | Bin 0 -> 1993 bytes
 9 files changed, 45 insertions(+), 9 deletions(-)
 create mode 100644 src/main/resources/assets/hbm/textures/blocks/rtty_programmer.png
 create mode 100755 src/main/resources/assets/hbm/textures/blocks/rtty_programmer.png.mcmeta
 create mode 100644 src/main/resources/assets/hbm/textures/blocks/rtty_reader.png
 create mode 100755 src/main/resources/assets/hbm/textures/blocks/rtty_reader.png.mcmeta
 create mode 100644 src/main/resources/assets/hbm/textures/gui/machine/gui_rtty_programmer.png
 create mode 100644 src/main/resources/assets/hbm/textures/gui/machine/gui_rtty_reader.png

diff --git a/src/main/java/api/hbm/redstoneoverradio/IRORInteractive.java b/src/main/java/api/hbm/redstoneoverradio/IRORInteractive.java
index 821fc8598..a05b280c9 100644
--- a/src/main/java/api/hbm/redstoneoverradio/IRORInteractive.java
+++ b/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 */
diff --git a/src/main/java/api/hbm/redstoneoverradio/IRORValueProvider.java b/src/main/java/api/hbm/redstoneoverradio/IRORValueProvider.java
index 26e615c6b..297882c31 100644
--- a/src/main/java/api/hbm/redstoneoverradio/IRORValueProvider.java
+++ b/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);
 }
diff --git a/src/main/java/api/hbm/redstoneoverradio/package-info.java b/src/main/java/api/hbm/redstoneoverradio/package-info.java
index ef1d4eaad..425d8e629 100644
--- a/src/main/java/api/hbm/redstoneoverradio/package-info.java
+++ b/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
+
 */
\ No newline at end of file
diff --git a/src/main/resources/assets/hbm/textures/blocks/rtty_programmer.png b/src/main/resources/assets/hbm/textures/blocks/rtty_programmer.png
new file mode 100644
index 0000000000000000000000000000000000000000..def98da385a0fd8aade1f31132fbbeb04e45f903
GIT binary patch
literal 260
zcmeAS@N?(olHy`uVBq!ia0vp^0zj<5!3HFyJAa%3QY^(zo*^7SP{WbZ0p#!Yba4#v
z=zKfHkc-Js#HC&LdQi?DmkkEjKL|9nns>Mq39nDgRpt=8mZbe6DO1qo=0<@xe-6dB
z=$5S#`DxtGY45Onns#`?I)|5jioEvh$}wHvBd5;Wp>}e<$bH{+58kejVPkkMvv%t)
zK86K4-d9R>+d9|`-Ih#oVGiuI{&4TI#A5Rdp9?E_xfGaJR3Bsbv}JGcW~*+sM|xj=
z9jGu0VXV<eyYc$^&xc|bH+D)~`t*N6A^T1JjmDS%3+-VDFwd#YE|1UvdV|5!)z4*}
HQ$iB}Q=DUR

literal 0
HcmV?d00001

diff --git a/src/main/resources/assets/hbm/textures/blocks/rtty_programmer.png.mcmeta b/src/main/resources/assets/hbm/textures/blocks/rtty_programmer.png.mcmeta
new file mode 100755
index 000000000..92dd223c8
--- /dev/null
+++ b/src/main/resources/assets/hbm/textures/blocks/rtty_programmer.png.mcmeta
@@ -0,0 +1,5 @@
+{
+  "animation": {
+    "frametime": 10
+  }
+}
diff --git a/src/main/resources/assets/hbm/textures/blocks/rtty_reader.png b/src/main/resources/assets/hbm/textures/blocks/rtty_reader.png
new file mode 100644
index 0000000000000000000000000000000000000000..22366c094c2e11a13714a0df973d63af2bcc0eb1
GIT binary patch
literal 254
zcmeAS@N?(olHy`uVBq!ia0vp^0zj<5!3HFyJAa%3QY^(zo*^7SP{WbZ0pxG>ba4#v
z=zKe6Bkv&t0oVFV3Om_0I!SR!<sVeyX-Iiia8_zdh=+$xLR5>$qAxCoJ}!5d5_93=
zk`Jq6e*D}2c{^{4o8SG0T4t|mua!S6qZjGj&z@TSWS$E9?jL$Z?6<o&NifVQ-g52L
zIR=IvLl4bPwM7osOFIl-u{v>RbUEn<gkF8Xp;W(of+Xv_mgPon{&MU2-}!CTP`Y>I
zWlMzavt4X<u?fZ3?9<C{ACkMa$o(IG+YiN7@iTH65$8o3B7q)Y@O1TaS?83{1OO3~
BVmkl;

literal 0
HcmV?d00001

diff --git a/src/main/resources/assets/hbm/textures/blocks/rtty_reader.png.mcmeta b/src/main/resources/assets/hbm/textures/blocks/rtty_reader.png.mcmeta
new file mode 100755
index 000000000..92dd223c8
--- /dev/null
+++ b/src/main/resources/assets/hbm/textures/blocks/rtty_reader.png.mcmeta
@@ -0,0 +1,5 @@
+{
+  "animation": {
+    "frametime": 10
+  }
+}
diff --git a/src/main/resources/assets/hbm/textures/gui/machine/gui_rtty_programmer.png b/src/main/resources/assets/hbm/textures/gui/machine/gui_rtty_programmer.png
new file mode 100644
index 0000000000000000000000000000000000000000..6529e3ac5f865317da206902b8f0c48ed833cfff
GIT binary patch
literal 2778
zcmeHJdsI?u7C+!K%go2k$))C$m5)*@v(gkQ6U|3nGq_oZQz@FEjiM+bV%C^-%V%j9
zl^zx)A!gbGCAhsaAD75Xy`Vk37%HGCmOPvT*<9zpnLlT(IqQ7u+rRHS-`V^3+xx7u
z3&O(?rY1Hf005W<1^Pz-00cB4fUzMs?N7NL2TuB_+kzsE!HZ;k=p+D`6bJcljm)SV
z72Znz{f{Nj#$-#}O!OeNy~hsJh!XMf=8aAR&Lww45-1r98a~pVV~STC%y;#cm<`2M
zm0LOW+Mr)8u)*<8jIL(JSlQL(Wxp!$wtwMMGBuR_V5viWT8*?iE8zj@Yl$lM;fc*9
z>nb8=*3En_g-Ne34mwDb^TqO{er~Q0x2$y|CdWV)pt5wa<MnGa!lc>~&r_@VtD#3p
zq_#7I22xdo+s0o|#gQ&Pfb-h_aNMFcyTK(A4oyQEo~j6=lN2xV>}v~9yR6dz_W5gq
zPe?9|+D;U{yWAx>PX}BczBqD+-!M|Q$4EZ%g!-E1K8dSeIMDHd{(GjXacT<JY$+0D
zwHD4yk+3w_>#6c-&*!$hahS@dkTyR3F289wDJ3#n@!oVwDyl`3vt-U#ce71dlYUtD
z<j<uTjfX@`_^OdS<G*_s@bVui<leQkM~6~w#rTPbhT<oPlKqU`lsj(e8oiEayAihS
znStImNXW{{%E}S;snoomfoPaYu5x;dpV&umWJcLCsbn!1HoXLVd#XZ0F|#MbrgaVw
zjpn@jgI8u=C9c{U0L?=is-C$^^^UT{AcIF5<-lg!Ek?bvfo!rSydPs-i+IJhs~sgS
zK{J#9+m;!uBBAfJEZ=C#5Pm}SWg69QnMaUGnXZ;cPSg4pa+TLF)zwM7Bd%l)&fL2z
zDT~S976KJDXAQT8aaH1R;&$|D%<Fo|dX(C^$?L-LzA@`<cwi4B0J=R(@xJ|BCmxIX
zWawk?rHhb^?Z@=vstqt3S};wYO?#YIo2eOeNV<OS&Ph*)BBnPb?a>%k7WeDk+hJ)#
z+zeb-XPVtZuMKrXSsD$M&17|=V9U@L7<b~QD$>oYY=q%b$ZEIz*iyB!uzjzl{dlEb
zk>}YejG=97?aNG;M|khp#X|~F{3M>AXjK0f#T$;-)1&vK5!H5EH~T3+{u=ghy~LkE
zKYcj>2rVUUCqT`;;Wti4`%ngR2AV7M_Yp4qW=_F(Ih0afA~<^xPyTw7O|2&?rN5O6
z-=wA6tAF@WW(OB|+`}`{@dWaYF3?F5Vkz4)-upeO+$<q8pCCpZ+7SkQvnJIdoPG0o
z5Kp33MH`kOT@UL646Kr{c47({gEo4S2F$k~yBg;=-(iJUhEqJUhs&+Y2jxJ+I;+*6
zui`RI99F~`{rkA1aN)^j<n&vTBF`ds?w5P%dq2eTI2=y&>7K_LjUSy(hyP66xriBh
zrEB-GK`*92;zyBnYI=gVQm2LLUGCY%=<eOe;&C?2YKzD|{5hl@?;|H#@+q|O`>9%R
zNd>dcnQ6yp(h_<wIZDk{n)OQtt9uRW0Y<2N({+U$+1EIlo)DE>I@(-oZ+dXp94>6Q
zW>2CH+S^Tc-w9PlCHD<V5ZdKpj&u?Oi_WQGDdgw?3veIReGPXvSZK~+tEp#Ip_A7!
zRR{oG_yvcNjVr<Zjjt7nN;0*MK8ml_i}y}JVOTz5)`MN>LarpOaG{!!D0mW>bSWtd
zg&?6}Sixjtl_&rhCSyx!-5e?ZQVzdkRQUA6TcUnAA?fZ<Ea}MsV~6vX{s4N(9oL2v
zeDc~McwdW6(6?*EK+0iX=yhs)a@O(WD3N0S?e;82v)l6eJ*>Mz@>$@(m>&R9qlG<+
zDfahpx`){<qxTP@eI<x)hEM4526c2d(Q^UKV9_F$R`c4Y3uAI}Xi6pR?2o~&e2Mec
zMz1r-T`z2WC<1}tDZ=EL6{x&_q9A^<tS!*Pd97t`$*DKjzz1^+;I%*K@&>iceI2Dc
zb|XaJB4$}QQZ&zr=YR3$ELsVjCr{wbK_>}GGB5l50ys28zqQrh0n!0E6uYblu*_{3
z2Pv$C#(qb80mxXdXO!>Nb>@NZw8o0{bBvvB{ugU5Hzk0z5VNf4@D5#+Jb#C##k#m$
zEOYfMjLXgupe7#XPOh^E^h&bvn1kL|^);V)_P1~TK|hpKVDANEM=gOCGdQIH{vDAP
z!{IGjbwHXC_jEGNF-k1fn>*e3R;d-nHBo$BxE|(#%x`gNd4kLat0>=D&+?=hw$1K=
ztSK2{Mbd}ASA6pi3OHa3M}h)s3CQ#oX~msI|4Jc9)2dFJ%XM>%n#UpfJ6)ov0SvnS
zO6U!wE<N+Wa1(WLY4y}H%UpF)tNJX`vZh0B|A`z#_c?tTwzD2V0XG>HotsUY63~e|
zi?9&=$2$2zDkr{G%N*nXW%IvKHVsX7ymAa_3(~G6ou~cQXZxArRsGS``|i&Ru_sM@
zRZ&@7c0+hX&&uE&8jLs*k3A7+(>XS_mUk#3Gy6eal;fFXsK<pc`aao&;8R)85#(ry
zqXEHEB<1y0w8#0DElW5e-UzK~i}RpyeO-s-Vm_b0@MU?Usk`3Jf*wd<K`7V(wa_;M
zs~}espKb=*Dg+R5z<N2Qv^03W<m?EpyVR;5{QtKsM-j$d2*eu;q78~HZtMLy7^Vie
zUyRG}YUT(~Iar<|w}Q8h$mK^n`W!FfW=b7{O8(p1M4pqsVv);}RGSL0Sp|Z2g!$KP
Hi#hgB9>eS>

literal 0
HcmV?d00001

diff --git a/src/main/resources/assets/hbm/textures/gui/machine/gui_rtty_reader.png b/src/main/resources/assets/hbm/textures/gui/machine/gui_rtty_reader.png
new file mode 100644
index 0000000000000000000000000000000000000000..bfc870f73c80fd845d1762646afbe3ff10214745
GIT binary patch
literal 1993
zcmb7Fdo+}39Dcts#z+%paEfBG)1*}=lS{U78GMy#CrMVZ(PYbLC03$BW-2kOEzxBn
zm#hsLR2no%ZINx$MJ^SKITfu-Daq`N#eVP1=;W`?e*e7loHNh!J@4~-zV{V+d#xtT
zFr5JaAhA7B9{>>SCjy8BY}p)D6oM`I-R^8(BKE`+x1|7}!)K#zzI)HT>AbPah-XBQ
zMHnp5KC!rm?4D~yHjZJRq9&1>A}O1-N!x!GTFG%w>IVn~R_wC{???sf`qv^3qc656
zI`Kvub6%e?kTLH3o$}4@keJ#tWeHb9S=yb$OHGCzb`ADz;xnA%N5m5S*Av;juabR&
zZtj2Ho-Di>_AN;!cb)j_(R$=p$GEtzfUt0fED3Yta!1Aa)69XJ+K#@az~}<P+WLhh
zCbnA#bV%j(8>_ljcgx=-51G%3v{M}8nVEu&7WsJT#J}+_79)r6$2et0>D_X3%zhNx
z?w3sfNjreIhzI5#&UpDUyK?2Vnm3yk2MkD$o0+7>L`5xAz844MWK>S?9M)4wb8~Zo
zMg0O2|4>>ut~&Z-e_~IVe<uHXKo3*U0_+1KlnKT=0H>{$vai#)m7Qoy0+vfoPc+=f
z+NC@Chb>5H+tcUuuO7CQUK5bNq?<s?M<Q*m#9wV|KXu&vjD<^?QkfG9=Hk~WVqeYy
zMj<$El(IJB16nQ*VdjKKmrCldS1d2JpLBNgjT{}Vk+ik%bl9y2PQg8Bw(`H01PAh9
zL+%0d0Y^S{X^v~qweWDdY<x@}JCS<)*s*qnLQyK;Q1AWGCpO^v#1Qw?FYa!W6GP?M
zvt(mB>&oWcDjO>fF4|wrEKN`j$>?VG{I^}y2HR%`E_%o2hqnNe$=XRp)|SZ~rIOK(
zsx3id<4LLI<sJH2{@=;B4^);gO9t%_u{2+N{Yf=BoYyQZ?<jjKzS4@n)GxnJ5m-0b
zw6!L5$|IDoi^9@$xkb8y0S-XTw&9+Qtm#>EbshyYae(kFND0At4(11y<XjfV^<Js5
z*o5Jo%`226Nr9wgNc?!J_4>nsuHpVw7S%Fme%+Cah0=;Y{V2DFjd{)1kB1LDYrKeU
z!sD_Dm9b}GdpjXAI=aPtuJg5zTkKlkUhZD1M9$^rmIwM&3(t>kNRrwTPH??NXdX(#
zF=#>-<txLK`D}cq<DP|?XkHx+XZRqCFZ3sQ+6h_0ds@`YRz7q|*QYW*x6H9Lfd1Kd
z%PCgeG!($EYsn5J3(|dJ?@|q|7VY89Bn$FvFilT<uqRnSUu9|FkxsPxsox8}2<j|H
zC>5q@7>Asp!?G(uD7J{fT60z~9ps+{WDGpOr-@K11Q|qhiY1?hBtTfqY@*>7{Py;!
zo29o;|HIidoZD7R^8~RjjfPu$6r~=a8HT=4nN#UR;OHUtRLG(0^F#f#=pi_2rW3yo
zo0cs?gFu(c5V9bk8>Xo2VQ(LrhQbi?hS+>Ie$ATBIfu}^f|hKCC;s4VOw&@G?rb4z
zCfo9Ho!T7K>B4gwe`G-p#~d_?37kee%WmIPBOsu#g2@6{512Ky2U%L5qc$Av!do<h
zc=9ARRUwOA%={sZh)=>aQFXcuvS4;PnkQ77gE}?3B2g<Jazsub-=8EB>GDH|KgEjy
zI$u=+b=J@xWa+4q*C4UBC#O?LpPH(A#KakxW{Nu9U`@3ORp#K#_EBsYB?#m&_5rlQ
z)CQL6)u(vX&4MLRXASK^7FIeec@6T{OA|>cYp15F9<hNDrfH~2S5qx7l{v`#K<5Vg
zX^}Bb@G$nJ*>ho;?rC{y;#D^bmPws8v<F#O>9FKAs6zE+VJ%lr6^{50&+Jy}>*Eb8
zW^wh=gKnDheLgRu+*M!N5inrxvcGcgcz@4AGr^s<K*h%wea(e&Oarb{#dEQwO}eXZ
zAk}%Uo=t5T25N^Q5}wEtx_dt;qHK}$>mBW5lz$vB1d?$_-wdzJYgW`q>R*fp{%+!$
zd+yxe`*(tlcMPiPUJ2}$rwVeAy+k5KedO|QyLf@Z!lw>m=@sliXB{|0lJyH~;?tMz
zesX8)yG7HkBWn-0r_MzDg`v9y*&^2#nF;us>EaS}RnBHrjl;|L3y+R0(P6gMDl3nX
P9{5l8N-wm`oqO;<+))>~

literal 0
HcmV?d00001