Skip to content

Commit e8e8622

Browse files
rubensworksrubensworks
committed
Add basics of infobook
1 parent 31a5dbe commit e8e8622

2 files changed

Lines changed: 108 additions & 3 deletions

File tree

‎src/main/resources/assets/integratedscripting/lang/en_us.json‎

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,52 @@
6060
"info_book.integratedscripting.section.main": "Scripting",
6161

6262
"info_book.integratedscripting.introduction": "Introduction",
63-
"info_book.integratedscripting.introduction.text1": "TODO",
64-
"info_book.integratedscripting.introduction.text2": "TODO",
65-
"info_book.integratedscripting.introduction.text3": "TODO"
63+
"info_book.integratedscripting.introduction.text1": "&lIntegrated Scripting&r is an extension to &lIntegrated Dynamics&r for creating scripts to handle operations in &lIntegrated Dynamics&r networks. By default, this mod ships with support for the JavaScript scripting language.",
64+
"info_book.integratedscripting.introduction.text2": "It allows you to define &lIntegrated Dynamics&r logic operations using a convenient scripting syntax instead of the standard visual variable card-based method, which can become cumbersome for advanced chains of operations.",
65+
"info_book.integratedscripting.introduction.text3": "For example, it allows you to easily define complex item list filters such as &o\"items that are damageable, are owned by mod X, and correspond to blocks that can be only mined with a diamond pickaxe.\"&r. Or &o\"get the item in this list with the second-largest stack size.\"&r",
66+
"info_book.integratedscripting.introduction.text4": "Basic programming knowledge is recommended when using this mod, but may be learnable through the tutorials later in this book.",
67+
68+
"info_book.integratedscripting.materials": "Materials",
69+
"info_book.integratedscripting.materials.text1": "Before getting started with scripting, you will need some &lMendesite&r blocks. These blocks are very malleable, and form a good basis for the storage and handling of scripts. &lMendesite&r is created by combining &lMenril Resin&r and &lAndesite&r in a &lDrying Basin&r.",
70+
71+
"info_book.integratedscripting.concepts": "Concepts",
72+
"info_book.integratedscripting.concepts.text1": "Editing, storing, and serving scripts to the network requires 3 elements: the &lScripting Terminal&r, &lScripting Disk&r, and &lScripting Drive&r",
73+
"info_book.integratedscripting.concepts.text2": "The &lScripting Disk&r is used to store raw script contents, but can not do anything on its own.",
74+
"info_book.integratedscripting.concepts.text3": "The &lScripting Drive&r allows you to insert a single &lScripting Disk&r, which will expose its contents to the network.",
75+
"info_book.integratedscripting.concepts.text4": "The &lScripting Terminal&r allows you to view, manage, and edit all scripts in the current network that are exposed by &lScripting Drives&r.",
76+
"info_book.integratedscripting.concepts.text5": "Each of these elements will be discussed in more detail hereafter.",
77+
78+
"info_book.integratedscripting.disk": "Scripting Disk",
79+
"info_book.integratedscripting.disk.text1": "&lScripting Disks&r are responsible for storing scripts, and are to be inserted into &lScripting Drives&r. They can be created by combining some &lVariable Cards&r with &lMendesite&r.",
80+
"info_book.integratedscripting.disk.text2": "Once a &lScripting Disk&r has been inserted into a &lScripting Drive&r, they will obtain a unique numerical identifier. This identifier will be used to modify scripts on this disk from within the &lScripting Terminal&r. The identifier is also used to link script elements to &lVariable Cards&r.",
81+
"info_book.integratedscripting.disk.text3": "A &lScripting Disk&r can safely be moved to another &lScripting Disk&r without loss of script data, even when on a different network. &lVariable Cards&r that refer to this script's identifier will however start throwing errors when not on the same network anymore.",
82+
"info_book.integratedscripting.disk.text4": "A &lScripting Disk&r has no limit in terms of its storage size, but splitting up scripts across multiple disks is recommended for management reasons.",
83+
84+
"info_book.integratedscripting.drive": "Scripting Drive",
85+
"info_book.integratedscripting.drive.text1": "Each &lScripting Drive&r is a block that is connected to your &lIntegrated Dynamics&r network that accepts a single &lScripting Disk&r, which allows the disk's script contents to be exposed to the network.",
86+
"info_book.integratedscripting.drive.text2": "It is crafted by combining a &lVariable Store&r and &lJukebox&r with some &lScripting Disks&r.",
87+
88+
"info_book.integratedscripting.terminal": "Scripting Terminal",
89+
"info_book.integratedscripting.terminal.text1": "The &lScripting Terminal&r is a part that must be connected to your &lIntegrated Dynamics&r network to manage the scripts stored in the &lScripting Disks&r of this network.",
90+
"info_book.integratedscripting.terminal.text2": "When right-clicking on a placed terminal, a simplified &oIntegrated Development Environment&r (IDE) will be shown using which you can edit scripts.",
91+
"info_book.integratedscripting.terminal.text3": "On the top-left side of the screen, you can select the identifier of a &lScripting Disk&r that is connected to the network, after which all script files stored in this disk will be shown in the script file list below.",
92+
"info_book.integratedscripting.terminal.text4": "If the disk does not contain any script files yet, you can create them by clicking on the \"+\"-button on the bottom-left side of the screen.",
93+
"info_book.integratedscripting.terminal.text5": "The script file list on the left-hand side of the screen is used to select a script for editing. When clicking on a script, its editable contents will show up on the right-hand-side of the screen.",
94+
"info_book.integratedscripting.terminal.text6": "The text field on the right-hand side of the screen allows you to edit the contents of script files, which will be saved automatically after each modification.",
95+
"info_book.integratedscripting.terminal.text7": "While the editor will perform limited syntax highlighting, it is not able to detect syntax errors at this time. Syntax errors will be reported when executing scripts via &lVariable Cards&r.",
96+
"info_book.integratedscripting.terminal.text8": "In order to use a script member as &lIntegrated Dynamics&r logic, you can bind it to a &lVariable Cards&r.",
97+
"info_book.integratedscripting.terminal.text9": "You can do this by first selecting a script member in the text editor by selecting it with your cursor, such as a variable name or function name.",
98+
"info_book.integratedscripting.terminal.text10": "After that, you can insert a &lVariable Card&r into the slot on the right-hand side of the screen to bind it to this script member.",
99+
"info_book.integratedscripting.terminal.text11": "This &lVariable Card&r can now be used elsewhere in the network, by for example showing a variable member inside a &lDisplay Panel&r, or by using a function member as operator in an item list filter.",
100+
"info_book.integratedscripting.terminal.text12": "The next chapter will provide more details on how to write scripts.",
101+
102+
"info_book.integratedscripting.writing": "Writing Scripts",
103+
104+
"info_book.integratedscripting.writing.variables": "Constants and Variables",
105+
"info_book.integratedscripting.writing.variables.text1": "TODO",
106+
"info_book.integratedscripting.writing.variables.text2": "TODO",
107+
108+
"info_book.integratedscripting.writing.functions": "Functions",
109+
"info_book.integratedscripting.writing.functions.text1": "TODO",
110+
"info_book.integratedscripting.writing.functions.text2": "TODO"
66111
}

‎src/main/resources/data/integratedscripting/info/scripting_info.xml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,64 @@
55
<paragraph>info_book.integratedscripting.introduction.text2</paragraph>
66
<paragraph>info_book.integratedscripting.introduction.text3</paragraph>
77
</section>
8+
9+
<section name="info_book.integratedscripting.materials">
10+
<tag>integratedscripting:mendesite</tag>
11+
<paragraph>info_book.integratedscripting.materials.text1</paragraph>
12+
<appendix type="integrateddynamics:drying_basin">integratedscripting:drying_basin/mendesite</appendix>
13+
<appendix type="integrateddynamics:mechanical_drying_basin">integratedscripting:mechanical_drying_basin/mendesite</appendix>
14+
</section>
15+
16+
<section name="info_book.integratedscripting.concepts">
17+
<paragraph>info_book.integratedscripting.concepts.text1</paragraph>
18+
<paragraph>info_book.integratedscripting.concepts.text2</paragraph>
19+
<paragraph>info_book.integratedscripting.concepts.text3</paragraph>
20+
<paragraph>info_book.integratedscripting.concepts.text4</paragraph>
21+
<paragraph>info_book.integratedscripting.concepts.text5</paragraph>
22+
</section>
23+
24+
<section name="info_book.integratedscripting.disk">
25+
<tag>integratedscripting:scripting_disk</tag>
26+
<paragraph>info_book.integratedscripting.disk.text1</paragraph>
27+
<paragraph>info_book.integratedscripting.disk.text2</paragraph>
28+
<paragraph>info_book.integratedscripting.disk.text3</paragraph>
29+
<paragraph>info_book.integratedscripting.disk.text4</paragraph>
30+
<appendix type="minecraft:crafting">integratedscripting:crafting/scripting_disk</appendix>
31+
</section>
32+
33+
<section name="info_book.integratedscripting.drive">
34+
<tag>integratedscripting:scripting_drive</tag>
35+
<paragraph>info_book.integratedscripting.drive.text1</paragraph>
36+
<paragraph>info_book.integratedscripting.drive.text2</paragraph>
37+
<appendix type="minecraft:crafting">integratedscripting:crafting/scripting_drive</appendix>
38+
</section>
39+
40+
<section name="info_book.integratedscripting.terminal">
41+
<tag>integratedscripting:part_terminal_scripting</tag>
42+
<paragraph>info_book.integratedscripting.terminal.text1</paragraph>
43+
<paragraph>info_book.integratedscripting.terminal.text2</paragraph>
44+
<paragraph>info_book.integratedscripting.terminal.text3</paragraph>
45+
<paragraph>info_book.integratedscripting.terminal.text4</paragraph>
46+
<paragraph>info_book.integratedscripting.terminal.text5</paragraph>
47+
<paragraph>info_book.integratedscripting.terminal.text6</paragraph>
48+
<paragraph>info_book.integratedscripting.terminal.text7</paragraph>
49+
<paragraph>info_book.integratedscripting.terminal.text8</paragraph>
50+
<paragraph>info_book.integratedscripting.terminal.text9</paragraph>
51+
<paragraph>info_book.integratedscripting.terminal.text10</paragraph>
52+
<paragraph>info_book.integratedscripting.terminal.text11</paragraph>
53+
<paragraph>info_book.integratedscripting.terminal.text12</paragraph>
54+
<appendix type="minecraft:crafting">integratedscripting:crafting/part_terminal_scripting</appendix>
55+
</section>
56+
57+
<section name="info_book.integratedscripting.writing">
58+
<section name="info_book.integratedscripting.writing.variables">
59+
<paragraph>info_book.integratedscripting.writing.variables.text1</paragraph>
60+
<paragraph>info_book.integratedscripting.writing.variables.text2</paragraph>
61+
</section>
62+
63+
<section name="info_book.integratedscripting.writing.functions">
64+
<paragraph>info_book.integratedscripting.writing.functions.text1</paragraph>
65+
<paragraph>info_book.integratedscripting.writing.functions.text2</paragraph>
66+
</section>
67+
</section>
868
</section>

0 commit comments

Comments
 (0)