From d6578f09fbdb417b9ac5afcdb6caee5ac2051243 Mon Sep 17 00:00:00 2001
From: Joachim Stolberg <joe.stolberg@gmx.de>
Date: Mon, 31 Jul 2023 20:01:18 +0200
Subject: [PATCH] First commit

---
 README.md         |  53 ++++++++++++++++++++++++++++++++++++++++++++++
 textures/book.xcf | Bin 3095 -> 7377 bytes
 2 files changed, 53 insertions(+)

diff --git a/README.md b/README.md
index 51b9d4a..7742f9d 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,59 @@ In addition DocLib supports image links for the ingame manual:
 See examples in `manual_EN.md`.
 
 
+### Construction Plans
+
+This is a feature, mainly used by the mod techage to show construction plans of
+multi-block machines. But it can be used for any other mod, too.
+
+![Plan](https://github.com/joe7575/doclib/blob/main/construction_plan.png)
+
+A construction plan is a map with up to 12 * 10 fields. 
+Each field can contain a node/item, text, or an image.
+The arrangement is defined via a Lua table.
+
+This is an example of a map with 12 * 10 fields from the demo code in `node.lua`:
+
+
+```lua
+
+local ITEM1 = {"item", "doclib_demo_img1.png"}
+local ITEM2 = {"item", "doclib_demo_img2.png", "Tooltip 1"}
+local ITEM3 = {"item", "doclib_demo_img3.png", "Tooltip 2"}
+local ITEM4 = {"item", "doclib_demo_img4.png", "Tooltip 3"}
+local ITEM5 = {"item", "doclib_book_inv.png",  "doclib:manual"}
+local ITEM6 = {"item", "doclib:manual",  "doclib:manual"}
+local IMG_1 = {"img", "doclib_book_inv.png", "2,2"}
+local TEXT1 = {"text", "Top view"}
+local TEXT2 = {"text", "Pointless Demo"}
+local TEXT3 = {"text", "End"}
+
+local plan1 = {
+	{TEXT2, false, false, false, false, false, false, false, false, false, false, ITEM4},
+	{false, false, false, TEXT1, false, false, false, false, IMG_1, false, false, false},
+	{false, false, false, false, false, false, false, false, false, false, false, false},
+	{false, false, false, false, ITEM1, false, false, false, false, false, false, false},
+	{false, false, false, ITEM4, ITEM5, ITEM2, false, false, false, false, false, false},
+	{false, false, false, false, ITEM3, false, false, false, false, false, false, false},
+	{false, false, false, false, ITEM6, false, false, false, false, false, false, false},
+	{false, false, false, false, false, false, false, false, false, false, false, false},
+	{false, false, false, false, false, false, false, false, false, false, false, false},
+	{TEXT3, false, false, false, false, false, false, false, false, false, false, ITEM4},
+}
+
+doclib.add_manual_plan("doclib", "EN", "demo1", plan1)
+```
+
+- Unused field elements are set to `false` 
+- For a text field a table like `{"text", "Pointless Demo"}` is used
+- For an item field a table like `{"item", "doclib_demo_img2.png", "Tooltip 1"}` is used.
+  The third value is a tooltip. It can be a string, a node name, or `nil` for no tooltip.
+- For an image field a table like `{"img", "doclib_book_inv.png", "2,2"}` is used.
+  The third value is the image size in fields (width x height).
+
+With `doclib.add_manual_plan` the plan is stored under the name "demo1".
+
+
 ### License
 
 Copyright (C) 2023 Joachim Stolberg
diff --git a/textures/book.xcf b/textures/book.xcf
index a7c00648247e35d396f04c3ae8b58d264c7e86f9..97643c6be22f6808506263b06e24c1f52ef0646e 100644
GIT binary patch
literal 7377
zcmeHML2nyH6n54TP7`c5IAAI)G^QzSEk#PCiUWsM5Qz#2OGv#`C<h$Zv8^Vt6DLg@
zBwB}FIH#)Mz=0g8eB`i~{RgbHKY&Z5`~Yr|>UR0wdS~bD?$|ZCph72lyKldF@6F7c
z=Y4NB_2x!f+^?>Qdy7j;2{hpo@lQdspos}wa-gYYKtyPBph?ga=slk&xpzT-fzoxD
zUZ}P<HfozYcur8~JImX(%1-T$*lX@I#LX|uUsKO{PqevFsn-_j+s!+Kk@Rm@Iy(>6
zYogOyZ{E2&ePyj)ZLPPq#TD<iuw7rRh(+&j=_<NcHQh_X`=jpropz<#+^mahczD1c
ze12hfv$-Rho7G0GL-MV)wN7nEERs0m2W(iFX3W~eqrt=U7lV6_oWj}%f3gPwo`_a_
zZnf3AE4FK%3*G`i9(F-R;%_{{b>MNrshtB!{v*a07(dN;!T1@*zs>kG<Fnvthh<BF
zq4CK6C7;JFF;BdUhWkav%P1i|){HKD5a5aYbr`>ZmrZ~nLNk6J+!KkEo9$-Ze%ErW
zN#_NwNhj;R>{^D?w;aM=S^%;~DYw76we?fdb+<Czq<ebgINf%)`zwHM`p`Wh$cjT6
zDL~&e8i!D97>B82!&i1J2A>{(`|QcH*0JhUrb9{`etz6~_UMVBbgW>8Lv-ZCG4|Qk
zGUkfo<~4rN+mfzgQ;k8&2}~-wpwS~{uz`KrQ^dnj)_u`+tSQGu6!^hFED=Qr!U19s
zEFy4<rfp8zFK|uTkS&^q-8XH*UYY>14FpcUQ1~9(UC0y>B@Npy7K%jzis{R4gCH{w
zX`}$<E?oEyiWiK_sT0FjwoL|~o>Y2Id+ig|t4xQKIQ;yi-8*<{C>=AH;Se1;ag2So
zwT!vqxOt6V^tPm{*i>VXasrczE@<?K8Ejym_7w5ZK;RT@bINuR1%5CPOGFWZaDW&D
z^9Y=LIB@dOz*#}yWOKPaY<Dh`N0hACc0QNS6Od0A+!cb%IHZvRl%Acv2gO;Vkm?z}
zvTZW>w0HBMeQ>L%dX?#r5{IAnZXHzGhSD*E84l5r6UW$RTg#X$j+@u`MQ=;GicK{J
zDJL+g=z>O%n8612X-^RkD+ruC3mgiDNZ>#$l|TS7N+ptR63<B_vDfpS)T{}KS@<-8
z`?OcZtgi3Y@Q^U*g7&I%hBRN7a)y^gnD&fU#?m6ugin4sGqX;h-vsVNXfuxocdwlB
zUM}HsCLb+l;x8A+iTxn0IHZvRB!3?G%^%B`i(@fZl{5aUhuH}!sS%ArP|iplE12OB
z9r;_t*wNqOcxxF?N@Jd_M@~X-OS(!*F*gN}azX&b7c_dr!OI0Q^5w$H8489-IYTcO
zH(N$lDu=UDIhvLBk(EAOUVe;RvYaU+1?}5*`SWu5M*!vYZFip_GY)B_0DW@(`VUaN
zZrnyW<15=HgH<^rdzI;s5{H9wM(UWs42S5*iDT@ut!2y=$IWZ}qPHbo#ikmAloOa#
zbU~v>%wPliw5N!NePpFF%Ssdsk*owU2zm#oaNu;KffGMK*>>#EVa6ei6d-v7z`3R;
z4^XzrU{%ie$17$hq@+eP4uf(=>X^X{hv>-j2F8w_H^y7bcv2ekY&~)kdRx*}Qi{1L
zfRqygD88W4BMuHwkU>0n2PhUe6bzBTp#u~vWvHzAUz9U5UO7|WuGKavWxuM9A(_{u
zj*+z)%^7X({lVS43S5c&I%e(~c-aIPBDA@$26wNHDIpz|!gWk3TE|q8jy{~9e}E)1
zpD7{tR2`>uu~ec%aw)y!Rtd7=kVXm+PJU#mXe^<Q@s%Bm!K#jty~=b*iNir1BXz7`
zhC_7Z#4+~S)-vXb<K{Jf(c6-)VpEMl$_Y#=x}eb`X0U;M+Ect$sz^sAR>x2<MCurb
z{oCp2M4yg=&oVN#s8=phi&ElnP{&9e^-dn5Gve*7PY!2GTK~;-^yae+J~73=o9I81
zM9){_NomZF{zxJZK#+=_oY>bZCKa96KOXVTXPG2EE5&OwBxd1L`m^26UZt_VQR&?E
zzRLJnJ*Z|LLa+#$ynzcEec>RP3D7vzjPT`gOJsbWbkBp5AheG`^nWJa<o}0Al(oXo
Zco07MeTCrvKdcXI;SXHA_HZ)c{tap3hDiVb

delta 399
zcmca;IbC9c6C>M3XAwq|0tOVo<%q;p0J1@t5r}y_GV@AOi_(iq^HL_qbKRKyUzneX
zsb;c(h?Er544?uSPyjMO7zmg)Y<3X|=BVfT3*;z3F~~3=;Fg5YU{V1{f-n$p8$xIX
l2KN8_4E#u#{Xa7UGmy{xpPe+io>UD~RxgKeF*6ol0RZv?QJw$*