Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Engineering guidebook megaupdate v2 #33062

Open
wants to merge 55 commits into
base: master
Choose a base branch
from

Conversation

ArtisticRoomba
Copy link
Contributor

@ArtisticRoomba ArtisticRoomba commented Oct 30, 2024

About the PR

Significantly updates the Engineering guidebook (more explicitly the Atmos section) to have a lot more relevant and useful information.

Why / Balance

Right now engineering has been getting update after update with no real change to the relevant guidebook entry. This has lead to a lot of out of date information and bad practices being prevalent in the guidebook, something that pains me to read.

As a terminal CE main I feel like I am at least partially qualified to revise the guidebook to decent standards, and I don't mind keeping it up to date with new changes.

Keep in mind I am respecting the guidebook entries guidelines as best I can, explicitly this one:

Refrain from including specific advice and “meta” strategies. The guide should be an impartial source of information.

This PR closes #32622, closes #32311.

This PR is a reopening of #32894.

Media

Showing links between guidebook pages:
https://github.com/user-attachments/assets/c4acfec8-c33c-4e07-b996-42104ebad9a5

Showing devices linking to their guidebook page:
https://github.com/user-attachments/assets/4546faa8-4bf6-41df-bb16-ad9b6d8f5a57

Oh, and you can't forget:
https://github.com/user-attachments/assets/875ed942-74d7-42dc-88e6-131e1a1280d9

Requirements

Changelog

🆑

  • add: The Engineering Guidebook has been significantly revamped and is now mostly up to date.
  • add: Most Atmospherics and Engineering-related devices and equipment now have a link to their relevant guidebook entry upon examine.

do you know how absurdly in-depth the basic air vent is? mappers need to take advantage of this holy moly
I would like to see you try
Although, this could use a lot more work to conform to guidebook requirements (impartial source) and for CLARITY.
Small edits to other files for consistency
probably going to be renamed, this is to explain distronet/recyclernet/wastenet/air alarms, firelocks, fire alarms, and how they all relate to each other
…rks.xml and add clarity to gas mixer explainer in MixingAndFiltering.xml
@github-actions github-actions bot added the Changes: No C# Changes: Requires no C# knowledge to review or fix this item. label Oct 30, 2024
@ArtisticRoomba ArtisticRoomba changed the title Engineering guidebook improvements v2 Engineering guidebook megaupdate v2 Oct 30, 2024
when i'm sending my worst enemy to hell i'm forcing them to tell me how a fire alarm works. and watch their brain explode. into gibs. i'm also putting them into the pear wiggler for a thousand years just for fun.
Yeah, I probably got the entire frezon section wrong. They'll learn. They always do.
…huttlecraft.xml, add Airlocks.xml, update Shuttlecraft.xml
Copy link
Contributor

@Admiral-Obvious-001 Admiral-Obvious-001 left a comment

Choose a reason for hiding this comment

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

Will need to look over the rest later.

Resources/ServerInfo/Guidebook/Engineering/AirVent.xml Outdated Show resolved Hide resolved
Resources/ServerInfo/Guidebook/Engineering/AME.xml Outdated Show resolved Hide resolved
Copy link
Contributor

@Admiral-Obvious-001 Admiral-Obvious-001 left a comment

Choose a reason for hiding this comment

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

That's it. Very, very good, way better than what we have now.

@ArtisticRoomba
Copy link
Contributor Author

That's it. Very, very good, way better than what we have now.

thanks a bunch!

Entries for PneumaticValve.xml downwards as they appear in-game still need formatting and guidebook links.
Worked up to Power.xml, continue first with AME.xml downwards from ingame guidebook
@github-actions github-actions bot added size/L Denotes a PR that changes 100-1000 lines. and removed size/XL Denotes a PR that changes 1000+ lines. labels Dec 17, 2024
# Conflicts:
#	Resources/Prototypes/Entities/Structures/Piping/Atmospherics/binary.yml
#	Resources/Prototypes/Entities/Structures/Piping/Atmospherics/trinary.yml
#	Resources/Prototypes/Entities/Structures/Piping/Atmospherics/unary.yml
@ArtisticRoomba ArtisticRoomba marked this pull request as ready for review December 17, 2024 16:53
@github-actions github-actions bot added the S: Needs Review Status: Requires additional reviews before being fully accepted label Dec 17, 2024
@ArtisticRoomba
Copy link
Contributor Author

By royal decree I declare this PR open for review. I'd say it's in a good state to merge, content-wise. I've included some media so you can see what it looks like in-game.

And thanks in advance to whoever fully reviews this poor PR.

@ScarKy0
Copy link
Contributor

ScarKy0 commented Dec 17, 2024

newguide is real

@ArtisticRoomba
Copy link
Contributor Author

newguide is real

Merge just a week away
I dare you to review it

@ScarKy0
Copy link
Contributor

ScarKy0 commented Dec 17, 2024

Merge just a week away
I dare you to review it

Bold of you to assume I know anything of engineering to make sure the info is accurate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changes: No C# Changes: Requires no C# knowledge to review or fix this item. S: Needs Review Status: Requires additional reviews before being fully accepted S: Untriaged Status: Indicates an item has not been triaged and doesn't have appropriate labels. size/L Denotes a PR that changes 100-1000 lines.
Projects
None yet
5 participants