-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathindex.json
52 lines (52 loc) · 2.74 KB
/
index.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
[
{"h1": "Files"},
{"h2": "index.json"},
["Guide files are written in json (though you probably should use ingame editor for that!), and ", {"code": "id/index.json"}, " is selected by default, but ", {"code": "id/index.json"}, " also can be used."],
{"h2": "data.json", "id": "datajson"},
[{"code": "data.json"}, " file must be added in your guide folder."],
{
"head": [
{"text": "Key", "style": {"code": true}},
"Type",
"Required",
"Description"
],
"table": [
["id", "String", "true*", "Lowercase ID"],
["title", "String", "true", "Display name"],
["type", "String", "true**", "Type of the guide, e.g. \"mod\". Used for sorting / easier viewing."],
["icon", "Icon", "false", "Absolute path to icon. You can use items as icons, e.g. \"item:minecraft:apple\". If this key is missing, icon.png from current folder will be used."],
["authors", "String[]", "false**", "List of mod/modpack authors. If you only made the guide, don't list yourself here."],
["pages", "Page[]", "false", "List of subpages. If this key is missing or value is empty, no subpages will be listed."],
["modid", "String", "false", "For mod type only - Used in minecraft to bind a guide to a mod, if guide ID doesn't match mod ID."]
]
},
"*Autogenerated for main page.",
"**Only used in the main <code>data.json</code>.",
{"h1": "Formatting"},
{"h2": "Text"},
{
"head": ["Name", "Example", {"text": "Json", "style": {"code": true}}],
"table": [
["Plain", "Example", "\"Example\", {\"text\": \"Example\"}"],
["Bold", {"text": "Example", "bold": true}, "{\"text\": \"Example\", \"bold\": true}"],
["Italic", {"text": "Example", "italic": true}, "{\"text\": \"Example\", \"italic\": true}"],
["Underline", {"text": "Example", "underlined": true}, "{\"text\": \"Example\", \"underlined\": true}"],
["Strikeout", {"text": "Example", "strikethrough": true}, "{\"text\": \"Example\", \"strikethrough\": true}"],
["Code", {"code": "Example"}, "{\"code\": \"Example\"}, {\"text\": \"Example\", \"code\": true}"],
["Text Size", {"text": "Example", "text_size": 1.5}, "{\"text\": \"Example\", \"text_size\": 1.5}"]
]
},
{"h1": "FTBGuides mod & Special Guides"},
"With the FTBGuides mod installed, you can:",
{
"list": [
"View all guides in-game by clicking Guides button in inventory.",
["Add a modpack-specific guide in ", {"code": "config/ftbguides/modpack_guide"}, " folder."],
["Add a modpack-specific mod guides in ", {"code": "config/ftbguides/mod_guides"}, " folder."],
["Add a server-specific guide in ", {"code": "local/ftbguides/server"}, " folder."]
]
},
{"h1": "Issues & Suggestions"},
["You can report issues and suggestions on ", {"text": "FTBGuides issue tracker.", "click": "https://github.com/LatvianModder/FTBGuides/issues"}]
]