Skip to content
This repository has been archived by the owner on Oct 25, 2023. It is now read-only.

Recipe Guidebook of the Future #198

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

PHCodes
Copy link
Contributor

@PHCodes PHCodes commented Sep 24, 2023

We have a Recipe Book on our wiki. It's out of date. It's unwieldy.

I wanna look at the Recipes for the game in the game.

These scripts allow that to happen.
Running gen_recipes_wiki.exe will update the wiki.txt file in tools with the recipes needed (may need to change where this is placed.) Running update_guidebook.exe will take wiki.txt and translate it's contents using the RecipesGeneratedHeader.xml into RecipesGenerated.xml. RecipesGenerated.xml is pointed to by the new Recipes page of the Guidebook. There is a very solid chance this breaks down. Things that could make it break down: A recipe for a food with a bizarre special character in its name (think $ or @) Requiring something that is not a reagent or a solid in a recipe. (It wouldn't break badly from this, it just wouldn't display the ingredients.) Future formatting changes. (if someone changes Reagents to Liquids, for example.)

However, as-is, I've done just about everything I can to future-proof these scripts, and they're designed and commented in such a way that another person should theoretically be able to come in after me and change the variables at the head of each file to get what they want. If they want to do more than that with them, though... Good luck.

About the PR

Media

FoodWikiGenScript
FoodGuide5

  • I have added screenshots/videos to this PR showcasing its changes ingame, or this PR does not require an ingame showcase

Changelog

🆑 JJ

  • add: Added Recipes to Guidebook.

We have a Recipe Book. It's out of date. It's unwieldy.

I wanna look at the Recipes for the game in the game.

These scripts allow that to happen.
Running gen_recipes_wiki.exe will update the wiki.txt file in tools with the recipes needed (may need to change where this is placed.)
Running update_guidebook.exe will take wiki.txt and translate it's contents using the RecipesGeneratedHeader.xml into RecipesGenerated.xml.
RecipesGenerated.xml is pointed to by the new Recipes page of the Guidebook.
There is a very solid chance this breaks down. Things that could make it break down:
A recipe for a food with a bizarre special character in its name (think $ or @)
Requiring something that is not a reagent or a solid in a recipe. (It wouldn't break badly from this, it just wouldn't display the ingredients.)
Future formatting changes. (if someone changes Reagents to Liquids, for example.)

However, as-is, I've done just about everything I can to future-proof these scripts, and they're designed and commented in such a way that another person should theoretically be able to come in after me and change the variables at the head of each file to get what they want. If they want to do more than that with them, though... Good luck.
@github-actions github-actions bot added the No C# label Sep 24, 2023
@FluffiestFloof
Copy link
Contributor

FluffiestFloof commented Sep 24, 2023

Saying the wiki is "out of date" and "unwieldy" is very mean and I feel offended. /j

Also it would be neater if it could be automatically generated like the Chemicals page or at least have a search bar because that's a lot of recipes just crammed in one page.
It also doesn't seem to say how much of each reagents or solids you need going from your preview?

@PHCodes
Copy link
Contributor Author

PHCodes commented Sep 24, 2023

I did not mean any offense! I simply want to make maintaining it easier, and that is the plan with these scripts.

It is autogenerated with the scripts I've provided in the PR. The lack of a search bar is more of an issue with the Guidebook, unfortunately. Changing it that significantly seems more of an issue for Upstream. I know we have search boxes for Cargo items, but scanning through a list of entities vs a text box may take some consideration.
The wiki.txt file that it generates does contain the number of items each one needs, and I can add the cook times to it. Due to how the mark-up is laid out for the Guidebook, there is no good place for me to write in each number of ingredients. The recipes listed in the Chefs guide has the same problem. I also think that gameplay-wise it leaves a bit more to the imagination for Chefs to figure out the ratios themselves. This is mentioned in the header file used to create the guidebook entry.

Thank you for your feedback.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mystery files will not be accepted

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as previous comment

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to stay consistent and use .py or .ps1 files. Or moving these into seperate folders and using a py/Powershell/batch script to invoke them

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants