Engineering guidebook improvements (#34695)

* engineering guidebook improvements

* whoops

* Changes

* this game is en-US, so it shall be gasses, not gases

* make changes to AccessConfigurator.xml, SolarPanels.xml, TeslaEngine.xml

---------

Co-authored-by: ScarKy0 <scarky0@onet.eu>

Content.Server/Solar/Components/SolarPanelComponent.cs

@@ -1,4 +1,5 @@
 using Content.Server.Solar.EntitySystems;
+using Content.Shared.Guidebook;
 
 namespace Content.Server.Solar.Components
 {
@@ -15,6 +16,7 @@ public sealed partial class SolarPanelComponent : Component
         /// Maximum supply output by this panel (coverage = 1)
         /// </summary>
         [DataField("maxSupply")]
+        [GuidebookData]
         public int MaxSupply = 750;
 
         /// <summary>

Resources/Prototypes/Entities/Objects/Devices/flatpack.yml

@@ -83,8 +83,8 @@
     - state: singularity-generator
   - type: GuideHelp
     guides:
-      - SingularityEngine
-      - Power
+    - SingularityEngine
+    - Power
 
 - type: entity
   parent: BaseFlatpack

Resources/Prototypes/Entities/Structures/Power/Generation/PA/particles.yml

@@ -48,8 +48,8 @@
             Level3: {state: particle3}
     - type: GuideHelp # why does this even have a guidebook link in the first place
       guides:
-        - SingularityTeslaEngine
-        - Power
+      - SingularityTeslaEngine
+      - Power
 
 - type: entity
   name: anti particles

Resources/Prototypes/Entities/Structures/Power/Generation/ame.yml

@@ -204,8 +204,8 @@
     node: ameShielding
   - type: GuideHelp
     guides:
-      - AME
-      - Power
+    - AME
+    - Power
   - type: Electrified
     onHandInteract: false
     onInteractUsing: false

Resources/Prototypes/Entities/Structures/Power/Generation/teg.yml

@@ -98,8 +98,8 @@
         path: /Audio/Ambience/Objects/vending_machine_hum.ogg
     - type: GuideHelp
       guides:
-        - TEG
-        - Power
+      - TEG
+      - Power
     - type: StealTarget
       stealGroup: Teg
 
@@ -159,8 +159,8 @@
     - type: Pullable
     - type: GuideHelp
       guides:
-        - TEG
-        - Power
+      - TEG
+      - Power
 
     # functionality
     - type: NodeContainer

Resources/ServerInfo/Guidebook/Engineering/AccessConfigurator.xml

@@ -27,8 +27,24 @@
 
   A device with no access requirements set, like a public access airlock, can be modified using any valid station ID card.
 
-  ## Repairing damaged ID card readers
-  Syndicate agents may attempt to hack access-restricted devices through the use of a [color=#a4885c]Cryptographic Sequencer (EMAG)[/color]. This nefarious tool will completely short out any ID card readers that are attached to the device.
+  ## Repairing access-broken ID card readers
+  Syndicate agents may attempt to hack access-restricted devices through the use of an [color=#a4885c]Authentication Disruptor[/color].
+  This nefarious tool will completely short out any ID card readers that are attached to the device, making it all-access.
+
+  <Box>
+    <GuideEntityEmbed Entity="AccessBreaker"/>
+  </Box>
+
+  To repair the damage, you'll commonly need to partially deconstruct the device and reconstruct it.
+  This will reset the access requirements to defaults, allowing you to reconfigure the device as needed.
+
+  ## Repairing access-broken Airlocks
+  Airlocks can be repaired multiple ways if their access requirements have been tampered with.
+
+  If you have an Access Configurator, you can use a [color=#a4885c]Screwdriver[/color] to remove the airlock's maintenance panel, and then use the Access Configurator to reconfigure the airlock's access requirements.
+  No partial deconstruction is needed.
+
+  If you don't have an Access Configurator, you can still fix the airlock by partially deconstructing it until you remove the door electronics, and then reconstructing it.
+  This will reset the airlock to the default access requirements it had at the start of the shift.
 
-  Engineers will need to partially de/reconstruct affected devices, and then set appropriate access permissions afterwards using the access configurator (or network configurator, for airlocks), to re-establish access restrictions.
 </Document>

Resources/ServerInfo/Guidebook/Engineering/AirInjector.xml

@@ -4,12 +4,11 @@
   <Box>
     <GuideEntityEmbed Entity="GasOutletInjector"/>
   </Box>
-  It is primarily used to force gasses into high-pressure rooms like the station's [textlink="gas storage rooms" link="GasMiningAndStorage"], or a burn chamber.
+  It is primarily used to force gasses into high-pressure rooms like the station's [textlink="gas storage rooms" link="GasMiningAndStorage"] or a burn chamber.
 
   The air injector does not require [textlink="power" link="Power"] to function.
 
   The air injector will inject gasses into the atmosphere it's exposed to until the atmosphere reaches [color=orange][protodata="GasOutletInjector" comp="GasOutletInjector" member="MaxPressure"/] kPa[/color].
 
   The air injector's speed is proportional to the amount of gas in the injector.
-  The more gas in the injector, the faster it will inject gas into the exposed atmosphere.
 </Document>

Resources/ServerInfo/Guidebook/Engineering/AirVent.xml

@@ -53,8 +53,8 @@
   - If the Internal bound pressure is set to 50 kPa, the air vent will not draw gas from the connected pipe if its pressure is below 50 kPa.
 
   When the vent is in siphoning mode:
-  - If the External bound pressure is set to 101.3 kPa, the air vent will siphon gases until the atmosphere reaches 101.3 kPa.
-  - If the Internal bound pressure is set to 50 kPa, the air vent will not push gases into the pipenet if its pressure is above 50 kPa.
+  - If the External bound pressure is set to 101.3 kPa, the air vent will siphon gasses until the atmosphere reaches 101.3 kPa.
+  - If the Internal bound pressure is set to 50 kPa, the air vent will not push gasses into the pipenet if its pressure is above 50 kPa.
 
   If you're still confused about PressureBounds, here's a simple way to think about it:
   - You can think of the External bound as the upper limit for the exposed atmosphere. "I will not pressurize the exposed atmosphere past this pressure, or draw from the atmosphere below this pressure."

Resources/ServerInfo/Guidebook/Engineering/Fires.xml

@@ -7,7 +7,7 @@
     <GuideEntityEmbed Entity="FirelockGlass" Caption=""/>
   </Box>
 
-  They often make high-pressure and high-temperature gases, which can quickly spread throughout the station if firelocks or doors are opened carelessly, even if only for a moment.
+  They often make high-pressure and high-temperature gasses, which can quickly spread throughout the station if firelocks or doors are opened carelessly, even if only for a moment.
 
   If people are caught in a fire, they can quickly become incapacitated, die, and even ash, rendering them unrevivable.
 

Resources/ServerInfo/Guidebook/Engineering/MixingAndFiltering.xml

@@ -1,13 +1,13 @@
 <Document>
   # Mixing and Filtering
-  Gas mixers and filters are essential tools for manipulating the composition of gases within a [textlink="pipe network" link="PipeNetworks"].
+  Gas mixers and filters are essential tools for manipulating the composition of gasses within a [textlink="pipe network" link="PipeNetworks"].
   <Box>
     <GuideEntityEmbed Entity="GasMixer"/>
     <GuideEntityEmbed Entity="GasFilter"/>
   </Box>
 
   ## Gas Mixer
-  Gas mixers are used to combine gases in specific ratios within a [textlink="pipe network." link="PipeNetworks"]
+  Gas mixers are used to combine gasses in specific ratios within a [textlink="pipe network." link="PipeNetworks"]
   They are essential for creating controlled gas mixtures for various applications.
 
   Gas mixers have 3 connections: 2 inputs and 1 output, as shown below:
@@ -20,7 +20,7 @@
   <GuideEntityEmbed Entity="GasPipeStraight" Caption="Side"/>
 </Box>
 
-  Gas mixers will still respect the requested gas mixture even if one of the input gases is not available. For example:
+  Gas mixers will still respect the requested gas mixture even if one of the input gasses is not available. For example:
   - If the requested mixture is 22% oxygen and 78% nitrogen, but there is no available oxygen, the mixer will not work until oxygen is available.
   - If oxygen is available, but at a pressure lower than required to create the proper mixture at the requested pressure, the mixer will still create the mixture, but the output will be at a lower pressure than requested.
 
@@ -36,7 +36,7 @@
   - Mixing oxygen and plasma for plasma burning to create Tritium
 
   ## Gas Filter
-  Gas filters are used to separate gases from a mixture within a [textlink="pipe network." link="PipeNetworks"]
+  Gas filters are used to separate gasses from a mixture within a [textlink="pipe network." link="PipeNetworks"]
 
   <Box>
     <GuideEntityEmbed Entity="GasPipeStraight" Caption="Input" Rotation="90"/>
@@ -50,6 +50,6 @@
   Gas filters will become blocked and will not filter gas if either output is blocked.
 
   Gas filters can be used in a variety of applications, for example:
-  - Filtering out unwanted gases from a [textlink="pipe network" link="PipeNetworks"]
-  - Separating specific gases for storage in a station's recyclernet
+  - Filtering out unwanted gasses from a [textlink="pipe network" link="PipeNetworks"]
+  - Separating specific gasses for storage in a station's recyclernet
 </Document>

Resources/ServerInfo/Guidebook/Engineering/PortableGenerator.xml

@@ -22,7 +22,7 @@
 
   Setup is incredibly easy: wrench it down above an [color=green]LV[/color] power cable, give it some welding fuel, and start it up.
 
-  Welding fuel is the only fuel source the J.R.P.A.C.M.A.N. can use, and it can be found in welding fuel tanks across the station, commonly in maintenance areas.
+  Welding fuel is the only fuel source the J.R.P.A.C.M.A.N. can use and it can be found in welding fuel tanks across the station, commonly in maintenance areas.
 
   # The Big Ones
 
@@ -41,7 +41,7 @@
 
   The S.U.P.E.R.P.A.C.M.A.N. boasts a larger power output (up to [color=orange][protodata="PortableGeneratorSuperPacman" comp="FuelGenerator" member="MaxTargetPower" format="N0"/] W[/color]) and longer runtime at maximum output, but scales down to lower outputs less efficiently.
 
-  They connect directly to [color=yellow]MV[/color] or [color=orange]HV[/color] [textlink="power cables" link="VoltageNetworks"], and are able to switch between them for flexibility.
+  They connect directly to [color=yellow]MV[/color] or [color=orange]HV[/color] [textlink="power cables" link="VoltageNetworks"] and are able to switch between them for flexibility.
 
   The S.U.P.E.R.P.A.C.M.A.N and P.A.C.M.A.N require uranium sheets and plasma sheets as fuel, respectively.
 </Document>

Resources/ServerInfo/Guidebook/Engineering/PortableScrubber.xml

@@ -5,16 +5,16 @@
     <GuideEntityEmbed Entity="PortableScrubber"/>
   </Box>
 
-  It is invaluable for quickly scrubbing unwanted gasses from a room when regular [textlink="scrubbers" link="AirScrubber"] are working too slow, or when a [textlink="scrubber" link="AirScrubber"] is not present.
+  It is invaluable for quickly removing unwanted gasses from a room when regular [textlink="scrubbers" link="AirScrubber"] are working too slow, or when a [textlink="scrubber" link="AirScrubber"] is not present.
 
   The portable scrubber requires [textlink="power" link="Power"] through a nearby [textlink="LV cable" link="VoltageNetworks"] to function.
 
-  The portable scrubber automatically starts scrubbing all non-breathable gasses from the room when it is bolted (wrenched) to the floor.
+  The portable scrubber automatically starts removing all non-breathable gasses from the room when it is bolted (wrenched) to the floor.
 
-  It will stop scrubbing when unbolted (unwrenched) from the floor, or when its internal volume is full. The scrubber has an internal capacity of [color=orange][protodata="PortableScrubber" comp="PortableScrubber" member="Volume"/] liters[/color].
+  It will stop scrubbing when unbolted (unwrenched) from the floor or when its internal volume is full. The scrubber has an internal capacity of [color=orange][protodata="PortableScrubber" comp="PortableScrubber" member="Volume"/] liters[/color].
 
   ## Dumping Waste and Storage
-  The scrubber's internal volume can be emptied by bolting (wrenching it) onto a [textlink="connector" link="GasCanisters"].
+  The scrubber's internal volume can be emptied by anchoring (wrenching) onto a [textlink="connector" link="GasCanisters"].
 
   Stations commonly have a dedicated emptying point to quickly transfer the waste from the scrubber to the station's wastenet.
 

Resources/ServerInfo/Guidebook/Engineering/PowerStorage.xml

@@ -29,7 +29,7 @@
     </Box>
   </Box>
 
-  SMESes can store [color=orange][protodata="SMESBasic" comp="Battery" member="MaxCharge" format="N0"/] J[/color] of energy, and can output a maximum [color=orange][protodata="SMESBasic" comp="PowerNetworkBattery" member="MaxSupply" format="N0"/] W[/color] of power.
+  SMESes can store [color=orange][protodata="SMESBasic" comp="Battery" member="MaxCharge" format="N0"/] J[/color] of energy and can output a maximum [color=orange][protodata="SMESBasic" comp="PowerNetworkBattery" member="MaxSupply" format="N0"/] W[/color] of power.
 
   If the battery is full, the SMES will pass through the power it receives from the input cable to the output cable. In the event of a power deficit, the SMES will ramp up to supplement the power draw.
 
@@ -41,10 +41,10 @@
   </Box>
 
   They're primarily used in station SMES arrays to store large amounts of power for the station's power grid.
-  They help to buy engineers time to setup power at roundstart, or to provide power in the event of a power deficit for extended periods of time.
+  They help to buy engineers time to setup power at roundstart or to provide power in the event of a power deficit for extended periods of time.
 
-  Advanced SMESes can store [color=orange][protodata="SMESAdvanced" comp="Battery" member="MaxCharge" format="N0"/] J[/color] of energy, and can output a maximum [color=orange][protodata="SMESAdvanced" comp="PowerNetworkBattery" member="MaxSupply" format="N0"/] W[/color] of power.
+  Advanced SMESes can store [color=orange][protodata="SMESAdvanced" comp="Battery" member="MaxCharge" format="N0"/] J[/color] of energy and can output a maximum [color=orange][protodata="SMESAdvanced" comp="PowerNetworkBattery" member="MaxSupply" format="N0"/] W[/color] of power.
 
-  Keep in mind that these aren't a magic solution to power deficits, and they can't store infinite energy.
+  Keep in mind that these aren't a magic solution to power deficits and they can't store infinite energy.
   A station load will drain these battries quickly if there is no power source partially supporting them.
 </Document>

Resources/ServerInfo/Guidebook/Engineering/Pumps.xml

@@ -1,7 +1,7 @@
 <Document>
 # Pumps
   Pumps are the primary way of actively moving gasses through a [textlink="pipenet." link="PipeNetworks"]
-  They take gas from one side, and push it to the other.
+  They take gas from one side and push it to the other.
   There are two different types of pumps:
 
   <Box>
@@ -16,7 +16,7 @@
   - Pumps cannot move gasses into pipes with pressures or volumes exceeding their [color=#a4885c]limit[/color]. This causes them to be [color=red]blocked[/color].
 
   Pumps will show a colorful animation when they are doing work.
-  If they have no gas to pump, or they are blocked, they will show a blinking [color=red]red[/color] animation.
+  If they have no gas to pump or they are blocked, they will show a blinking [color=red]red[/color] animation.
   Pumps that are off, have no power, or are unanchored will show no animation.
 
   ## Pressure Pumps

Resources/ServerInfo/Guidebook/Engineering/RTG.xml

@@ -9,7 +9,7 @@
 
   They require no maintenance and are a reliable source of power, making them ideal for powering essential systems that need to be online at all times, like Telecoms, the AI, or the Crew Monitoring Server.
 
-  RTGs always generate [color=orange][protodata="GeneratorRTG" comp="PowerSupplier" member="MaxSupply" format="N0"/] W[/color] of power, and must be connected to an [color=orange]HV power[/color] [textlink="network" link="VoltageNetworks"] to function.
+  RTGs always generate [color=orange][protodata="GeneratorRTG" comp="PowerSupplier" member="MaxSupply" format="N0"/] W[/color] of power and must be connected to an [color=orange]HV power[/color] [textlink="network" link="VoltageNetworks"] to function.
 
   However, they're only accessible through salvage finding one on an expedition. Should they bring some in, make sure to thank them!
 

Resources/ServerInfo/Guidebook/Engineering/Radiators.xml

@@ -21,6 +21,8 @@
   If you're exchanging heat with space, you can only get as cold as space.
   To increase the efficiency of radiation, you can build radiators on lattice, which will allow the radiator to radiate more heat, compared to being directly attached to hull tile.
 
+  Gas will flow naturally through the radiator via differences in pressure, but you can use a gas pump to increase the flow rate.
+
   Increasing the flow rate of gas through the radiator will increase the rate of heat exchange.
 
   </Document>

Resources/ServerInfo/Guidebook/Engineering/Ramping.xml

@@ -12,9 +12,9 @@
   - After some seconds have passed, the generator will have ramped up to 100 kW of power, and the brownout will end. All devices are now satisfied with the power they are receiving.
 
   During a shift, this is most commonly observed when a generator runs out of fuel and suddenly stops producing power.
-  Suddenly, the grid is hit with a large deficit of power (as supply has fallen below demand), and all devices will experience a brownout until SMESes or other generators can ramp up to match the new demand.
+  Suddenly the grid is hit with a large deficit of power (as supply has fallen below demand), and all devices will experience a brownout until SMESes or other generators can ramp up to match the new demand.
 
-  This can also happen when a large power consuming device, or department, is reconnected to the grid.
+  This can also happen when a large power consuming device or department is reconnected to the grid.
   The sudden increase in power draw will cause a brownout until the generators can ramp up to match the new demand.
 
 </Document>

Resources/ServerInfo/Guidebook/Engineering/Shuttlecraft.xml

@@ -46,15 +46,15 @@
     <GuideEntityEmbed Entity="FloorTileItemWhite" Caption=""/>
   </Box>
 
-  Head out into space with steel sheets and metal rods in hand, and click on the edge of the station to place lattice.
+  Head out into space with steel sheets and metal rods in hand and click on the edge of the station to place lattice.
 
   Place a line of lattice about 3-4 tiles away from the station, then start building a platform with lattice.
 
   Keep doing this until you have a platform that is at least 3x3 in size, which is connected to the station via a single lattice line.
 
   Once you're finished constructing the base of your shuttle, you can use wirecutters to snip the connecting lattice that joins your new ship and the station.
 
-  This platform is considered a different grid from the station, and thus will not have any gravity or be held in place by a station anchor — it can move around freely.
+  This platform is considered a different grid from the station and thus will not have any gravity or be held in place by a station anchor — it can move around freely.
 
   You can expand your lattice platform further by clicking just off the edge with some rods in hand.
 

Resources/ServerInfo/Guidebook/Engineering/SignalValve.xml

@@ -5,13 +5,13 @@
     <GuideEntityEmbed Entity="SignalControlledValve"/>
   </Box>
 
-  The signal valve is similar to the manual valve. Gas can flow unrestricted in both directions, and it can be operated manually.
+  The signal valve is similar to the manual valve. Gas can flow unrestricted in both directions and it can be operated manually.
 
   The signal valve has 3 [textlink="signal" link="Networking"] inputs, which can open, close, or toggle the valve.
 
   Signal valves can be used in a variety of applications, for example:
   - Remote control of valves in hazardous areas or areas inaccessible to crew
   - Convenient control over a valve in a hard-to-reach area
-  - Automation with other [textlink="signal-enabled" link="Networking"] machines and equipment such as [textlink="air alarms" link="AirAlarms"] and remote signallers
+  - Automation with other [textlink="signal-enabled" link="Networking"] machines and equipment such as [textlink="air alarms" link="AirAlarms"] and remote signalers
 
 </Document>