Skip to content

Commit

Permalink
feat: improve lumberjack ingame docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@klikli-dev
klikli-dev committed Dec 20, 2022
1 parent 6a1ec3e commit a10c52d
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 20 deletions.
6 changes: 5 additions & 1 deletion src/generated/resources/assets/occultism/lang/en_us.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -673,9 +673,13 @@
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_crusher_t4.intro.title": "Marid Crusher",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_crusher_t4.name": "Summon Marid Crusher",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.book_of_calling.text": "If you lose the book of calling, you can craft a new one.\n[#](ad03fc)Shift-right-click[#]() the spirit with the crafted book to assign it.\n",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.intro.text": "The lumberjack will harvest trees in it's working area and deposit the dropped items into the specified chest. **Note**: The lumberjack is using the old vanilla AI, not villager AI. That means he is ... *wonky*, and wont to get stuck. Consider him more of a semi-automatic helper, than a fully automated tree farm :)\n",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.intro.text": "The lumberjack will harvest trees in it's working area. If a deposit location is set it will collect the dropped items into the specified chest, and re-plant saplings.\n",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.intro.title": "Foliot Lumberjack",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.name": "Summon Foliot Lumberjack",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.usage.text": "Use the book of calling to set the work area and deposit location of the lumberjack.\n\\\n\\\nSee [Books of Calling](entry://getting_started/books_of_calling) for more information.\n",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.usage.title": "Usage",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.usage2.text": "The spirit might pause for a few minutes after clearing his work area, even if trees have regrown since. This is a performance-saving measure and not a bug, he will continue on his own.\n\\\n\\\nSet the work area again to make him continue work immediately.\n",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.usage2.title": "Lazy Lumberjack?",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_manage_machine.book_of_calling.text": "If you lose the book of calling, you can craft a new one.\n[#](ad03fc)Shift-right-click[#]() the spirit with the crafted book to assign it.\n",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_manage_machine.intro.text": "The machine operator transfers items specified in the dimensional storage actuator GUI, to it's managed machine, and returns crafting results to the storage system. It can also be used to automatically empty a chest into the storage actuator.\n\\\nBasically, on-demand crafting!\n",
"book.occultism.dictionary_of_spirits.summoning_rituals.summon_manage_machine.intro.title": "Djinni Machine Operator",
Expand Down
16 changes: 16 additions & 0 deletions ...ltism/modonomicons/dictionary_of_spirits/entries/summoning_rituals/summon_lumberjack.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,22 @@
"text": "book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.book_of_calling.text",
"title1": "",
"title2": ""
},
{
"type": "modonomicon:text",
"anchor": "",
"show_title_separator": true,
"text": "book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.usage.text",
"title": "book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.usage.title",
"use_markdown_in_title": false
},
{
"type": "modonomicon:text",
"anchor": "",
"show_title_separator": true,
"text": "book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.usage2.text",
"title": "book.occultism.dictionary_of_spirits.summoning_rituals.summon_lumberjack.usage2.title",
"use_markdown_in_title": false
}
],
"parents": [
Expand Down
44 changes: 43 additions & 1 deletion src/main/java/com/github/klikli_dev/occultism/datagen/OccultismBookProvider.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2862,23 +2862,63 @@ private BookEntryModel.Builder makeSummonCrusherT4Entry(BookLangHelper helper, E

private BookEntryModel.Builder makeSummonLumberjackEntry(BookLangHelper helper, EntryLocationHelper entryHelper, char icon) {
helper.entry("summon_lumberjack");
this.lang.add(helper.entryName(), "Summon Foliot Lumberjack");

helper.page("intro");
var intro = BookTextPageModel.builder()
.withTitle(helper.pageTitle())
.withText(helper.pageText())
.build();
this.lang.add(helper.pageTitle(), "Foliot Lumberjack");
this.lang.add(helper.pageText(),
"""
The lumberjack will harvest trees in it's working area. If a deposit location is set it will collect the dropped items into the specified chest, and re-plant saplings.
""");

helper.page("ritual");
var ritual = BookRitualRecipePageModel.builder()
.withRecipeId1(this.modLoc("ritual/summon_foliot_lumberjack"))
.build();
//no text

helper.page("book_of_calling");
var bookOfCalling = BookCraftingRecipePageModel.builder()
.withRecipeId1(this.modLoc("crafting/book_of_calling_foliot_lumberjack"))
.withText(helper.pageText())
.build();
this.lang.add(helper.pageText(),
"""
If you lose the book of calling, you can craft a new one.
[#](%1$s)Shift-right-click[#]() the spirit with the crafted book to assign it.
""".formatted(COLOR_PURPLE));

helper.page("usage");
var usage = BookTextPageModel.builder()
.withTitle(helper.pageTitle())
.withText(helper.pageText())
.build();
this.lang.add(helper.pageTitle(), "Usage");
this.lang.add(helper.pageText(),
"""
Use the book of calling to set the work area and deposit location of the lumberjack.
\\
\\
See [Books of Calling](entry://getting_started/books_of_calling) for more information.
""");

helper.page("usage2");
var usage2 = BookTextPageModel.builder()
.withTitle(helper.pageTitle())
.withText(helper.pageText())
.build();
this.lang.add(helper.pageTitle(), "Lazy Lumberjack?");
this.lang.add(helper.pageText(),
"""
The spirit might pause for a few minutes after clearing his work area, even if trees have regrown since. This is a performance-saving measure and not a bug, he will continue on his own.
\\
\\
Set the work area again to make him continue work immediately.
""");

return BookEntryModel.builder()
.withId(this.modLoc(helper.category + "/" + helper.entry))
Expand All @@ -2889,7 +2929,9 @@ private BookEntryModel.Builder makeSummonLumberjackEntry(BookLangHelper helper,
.withPages(
intro,
ritual,
bookOfCalling
bookOfCalling,
usage,
usage2
);
}

Expand Down
19 changes: 1 addition & 18 deletions src/main/java/com/github/klikli_dev/occultism/datagen/lang/ENUSProvider.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2352,24 +2352,7 @@ private void addSummoningRitualsCategory(BookLangHelper helper) {


helper.entry("summon_lumberjack");
this.add(helper.entryName(), "Summon Foliot Lumberjack");

helper.page("intro");
this.add(helper.pageTitle(), "Foliot Lumberjack");
this.add(helper.pageText(),
"""
The lumberjack will harvest trees in it's working area and deposit the dropped items into the specified chest. **Note**: The lumberjack is using the old vanilla AI, not villager AI. That means he is ... *wonky*, and wont to get stuck. Consider him more of a semi-automatic helper, than a fully automated tree farm :)
""");

helper.page("ritual");
//no text

helper.page("book_of_calling");
this.add(helper.pageText(),
"""
If you lose the book of calling, you can craft a new one.
[#](%1$s)Shift-right-click[#]() the spirit with the crafted book to assign it.
""".formatted(COLOR_PURPLE));
//Moved to OccultismBookProvider#makeSummonLumberjackEntry

helper.entry("summon_transport_items");
//Moved to OccultismBookProvider#makeSummonTransportItemsEntry
Expand Down

0 comments on commit a10c52d

Please sign in to comment.