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.

Sign up for GitHub

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

Jump to bottom

Engineering guidebook megaupdate v2 #33062

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

Engineering guidebook megaupdate v2 #33062

wants to merge 60 commits into from
+3,250 −485

Conversation

ArtisticRoomba
Copy link
Contributor

@ArtisticRoomba ArtisticRoomba commented Oct 30, 2024 •
edited
Loading

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.

@ArtisticRoomba
pipes and pumps page, initial commit before I lose it all somehow
5682f4b
@ArtisticRoomba
Formatting and structuring changes
cb8e930
@ArtisticRoomba
another minor change to wording and small additions
8a5bb10
@ArtisticRoomba
add entries to atmosphere in/out, flesh out air out air vent entry
cbbb942 
do you know how absurdly in-depth the basic air vent is? mappers need to take advantage of this holy moly
@ArtisticRoomba
Adds the AirScrubber.xml entry and fixes a lot of issues with other e…
e0a7b7b 
…ntries
@ArtisticRoomba
Fleshing out of AirInjector.xml plus other touchups
ffc2244
@ArtisticRoomba
valves, valves, valves, batman!
b937f7e
@ArtisticRoomba
that's right, a commit for a single word
4bfb2eb 
I would like to see you try
@ArtisticRoomba
Adds a basic PneumaticValve entry
a325e21 
Although, this could use a lot more work to conform to guidebook requirements (impartial source) and for CLARITY.
@ArtisticRoomba
MixingAndFiltering.xml and GasCanisters.xml
30fbed0 
Small edits to other files for consistency
@ArtisticRoomba
sorry guys I wasn't thinking when writing this
8303e89
@ArtisticRoomba
what if you wanted to edit the guidebook but god said PARSER ERROR
792d7e2
@ArtisticRoomba
fix a bunch of formatting errors because I was editing it without loo…
1652895 
…king in-game
@ArtisticRoomba
add scrubber entry as well as start AtmosphericsSystems.xml
b2eff49 
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
@ArtisticRoomba
expands AtmosphericsSystems.xml and starts new PipeNetworks.xml
6978566
@ArtisticRoomba
hey, hey MORON!
2553717
@ArtisticRoomba
Flesh out PipeNetworks.xml
9d9d9a1
@ArtisticRoomba
resolve most comments on Ilya246's review, tysm noble atmosian
231f805
@ArtisticRoomba
recorrect PipeNetworks.xml
a53f684
@ArtisticRoomba
flesh out DeviceMonitoringAndControl.xml, fix formatting in PipeNetwo…
c75599c 
…rks.xml and add clarity to gas mixer explainer in MixingAndFiltering.xml
@ArtisticRoomba
expand DeviceMonitoringAndControl.xml
a433b9b
@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
@ArtisticRoomba ArtisticRoomba mentioned this pull request Nov 1, 2024
Merged
6 tasks
@ArtisticRoomba
THE LAWS OF THERMODYNAMICS ARE NOT REAL, ENTROPY IS A MYTH
389d959 
Expands Thermomachines.xml
@ArtisticRoomba
add and expand FireAndGasControl.xml
fdaf116 
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.
@ArtisticRoomba
nuke Fires.xml, transplanting most of its content into different entries
543621f
@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

@beck-thompson beck-thompson added P2: Raised Priority: Item has a raised priority, indicating it might get increased maintainer attention. T: New Feature Type: New feature or content, or extending existing content D3: Low Difficulty: Some codebase knowledge required. A: Guidebook Area: Ingame guidebook, content or technical implementation and removed S: Untriaged Status: Indicates an item has not been triaged and doesn't have appropriate labels. labels Dec 18, 2024
@Pumkin69
Copy link

amazing pr

@cohanna
Copy link
Contributor

cohanna commented Dec 28, 2024 •
edited
Loading

with the addition of the advanced SMES, the power storage section needs a small adjustment to clarify the difference, and the utility, of the advanced smes

@ArtisticRoomba
Copy link
Contributor Author

with the addition of the advanced SMES, the power storage section needs a small adjustment to clarify the difference, and the utility, of the advanced smes

Yeah, I guess I gotta do that now... goddammit...

@cohanna
Copy link
Contributor

cohanna commented Dec 28, 2024

Yeah, I guess I gotta do that now... goddammit...

An up to date guide book really is sisyphusian in nature huh lol

@ArtisticRoomba
Atomize DeviceMonitoringAndControl.xml into AtmosphericAlertsComputer…
992bf60 
….xml and AtmosphericNetworkMonitor.xml, start work on AtmosphericNetworkMonitor.xml
@github-actions github-actions bot added size/M Denotes a PR that changes 100-999 lines. and removed size/L Denotes a PR that changes 1000-4999 lines. labels Dec 28, 2024
@ArtisticRoomba
Copy link
Contributor Author

Yeah, I guess I gotta do that now... goddammit...

An up to date guide book really is sisyphusian in nature huh lol

You win.

image

@cohanna
Copy link
Contributor

cohanna commented Dec 30, 2024

Quick get a maintainer to merge it before they add something else lol

@ArtisticRoomba ArtisticRoomba mentioned this pull request Jan 11, 2025
Open
@github-actions github-actions bot added the S: Merge Conflict Status: Needs to resolve merge conflicts before it can be accepted label Jan 11, 2025
@github-actions GitHub Actions
Copy link
Contributor

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@ArtisticRoomba
Merge branch 'master' into engineering-guidebook-improvements-v2
ce19a4a 
# Conflicts:
#	Resources/Prototypes/Entities/Structures/Piping/Atmospherics/binary.yml
@github-actions github-actions bot removed the S: Merge Conflict Status: Needs to resolve merge conflicts before it can be accepted label Jan 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Admiral-Obvious-001 Admiral-Obvious-001 Admiral-Obvious-001 approved these changes

@Potion2112 Potion2112 Potion2112 approved these changes

@nikthechampiongr nikthechampiongr Awaiting requested review from nikthechampiongr nikthechampiongr is a code owner

@crazybrain23 crazybrain23 Awaiting requested review from crazybrain23 crazybrain23 is a code owner

Assignees
No one assigned
Labels
A: Guidebook Area: Ingame guidebook, content or technical implementation Changes: No C# Changes: Requires no C# knowledge to review or fix this item. D3: Low Difficulty: Some codebase knowledge required. P2: Raised Priority: Item has a raised priority, indicating it might get increased maintainer attention. S: Needs Review Status: Requires additional reviews before being fully accepted size/M Denotes a PR that changes 100-999 lines. T: New Feature Type: New feature or content, or extending existing content
Projects
None yet
Milestone
No milestone
8 participants
@ArtisticRoomba @ScarKy0 @Pumkin69 @cohanna @Admiral-Obvious-001 @Potion2112 @SlamBamActionman @beck-thompson