fix: improve transporter docs regarding whitelist/blacklist

Closes #880
klikli-dev · Jan 20, 2023 · db75981 · db75981
1 parent 795a90f
commit db75981
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/src/generated/resources/assets/occultism/lang/en_us.json b/src/generated/resources/assets/occultism/lang/en_us.json
@@ -702,6 +702,8 @@
   "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.intro.text": "The transporter is useful in that you don't need a train of hoppers transporting stuff, and can use any inventory to take from and deposit.\n\\\n\\\nTo make it take from an inventory simply sneak and interact with it's book of calling on the inventory you want.\n",
   "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.intro.title": "Foliot Transporter",
   "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.intro2.text": "You can also dictate which inventory it deposits to in the same way.\n\\\nThe transporter will move all items it can access from one inventory to another, including machines. It can also deposit into the inventories of other spirits. By setting the extract and insert side they can be used to automate various transport tasks.\n",
+  "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.item_filters.text": "By default the Transporter is in \"Blacklist\" mode and will not move anything. Shift-click the transporter to open the config UI. You can then add items to the filter list to make it move only those items, or set it to \"Whitelist\" to move everything *except* the filtered items. You can also enter a tag in the text field below to filter by tag.\n",
+  "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.item_filters.title": "Item Filters",
   "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.name": "Summon Foliot Transporter",
   "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.spirit_inventories.text": "The Transporter can also interact with the inventories of other spirits. This is especially useful to automatically supply a [Crusher spirit](entry://summoning_rituals/summon_crusher_t1) with items to crush.\n",
   "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.spirit_inventories.title": "Spirit Inventories",

diff --git a/...nomicon/books/dictionary_of_spirits/entries/summoning_rituals/summon_transport_items.json b/...nomicon/books/dictionary_of_spirits/entries/summoning_rituals/summon_transport_items.json
@@ -41,6 +41,14 @@
       "show_title_separator": true,
       "text": "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.spirit_inventories.text"
     },
+    {
+      "type": "modonomicon:text",
+      "anchor": "",
+      "title": "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.item_filters.title",
+      "use_markdown_in_title": false,
+      "show_title_separator": true,
+      "text": "book.occultism.dictionary_of_spirits.summoning_rituals.summon_transport_items.item_filters.text"
+    },
     {
       "type": "occultism:ritual_recipe",
       "anchor": "",

diff --git a/src/main/java/com/github/klikli_dev/occultism/datagen/OccultismBookProvider.java b/src/main/java/com/github/klikli_dev/occultism/datagen/OccultismBookProvider.java
@@ -3069,6 +3069,17 @@ private BookEntryModel.Builder makeSummonTransportItemsEntry(BookLangHelper help
                         The Transporter can also interact with the inventories of other spirits. This is especially useful to automatically supply a [Crusher spirit](entry://summoning_rituals/summon_crusher_t1) with items to crush.
                            """);
 
+        helper.page("item_filters");
+        var itemFilters = BookTextPageModel.builder()
+                .withTitle(helper.pageTitle())
+                .withText(helper.pageText())
+                .build();
+        this.lang.add(helper.pageTitle(), "Item Filters");
+        this.lang.add(helper.pageText(),
+                """
+                        By default the Transporter is in "Blacklist" mode and will not move anything. Shift-click the transporter to open the config UI. You can then add items to the filter list to make it move only those items, or set it to "Whitelist" to move everything *except* the filtered items. You can also enter a tag in the text field below to filter by tag.
+                           """);
+
         helper.page("ritual");
         var ritual = BookRitualRecipePageModel.builder()
                 .withRecipeId1(this.modLoc("ritual/summon_foliot_transport_items"))
@@ -3095,6 +3106,7 @@ private BookEntryModel.Builder makeSummonTransportItemsEntry(BookLangHelper help
                         intro,
                         intro2,
                         spirit_inventories,
+                        itemFilters,
                         ritual,
                         bookOfCalling
                 );