Add guidebook entries for Eagle, Phoenix (new-frontiers-14#2218)

Co-authored-by: ErhardSteinhauer <[email protected]>

Resources/Locale/en-US/_NF/guidebook/guides.ftl

@@ -38,6 +38,7 @@ guide-entry-shipyard-ceres = Ceres
 guide-entry-shipyard-chisel = Chisel
 guide-entry-shipyard-comet = Comet
 guide-entry-shipyard-construct = Construct
+guide-entry-shipyard-eagle = Eagle
 guide-entry-shipyard-garden = Garden
 guide-entry-shipyard-gasbender = Gasbender
 guide-entry-shipyard-gourd = Gourd
@@ -55,6 +56,7 @@ guide-entry-shipyard-loader = Loader
 guide-entry-shipyard-mccargo = McCargo
 guide-entry-shipyard-mcdelivery = McDelivery
 guide-entry-shipyard-pathfinder = Pathfinder
+guide-entry-shipyard-phoenix = Phoenix
 guide-entry-shipyard-pioneer = Pioneer
 guide-entry-shipyard-placebo = Placebo
 guide-entry-shipyard-prospector = Prospector

Resources/Prototypes/_NF/Guidebook/shipyard.yml

@@ -18,6 +18,7 @@
   - ShipyardChisel
   - ShipyardComet
   - ShipyardConstruct
+  - ShipyardEagle
   - ShipyardGarden
   - ShipyardGasbender
   - ShipyardGourd
@@ -35,6 +36,7 @@
   - ShipyardMcCargo
   - ShipyardMcDelivery
   - ShipyardPathfinder
+  - ShipyardPhoenix
   - ShipyardPioneer
   - ShipyardPlacebo
   - ShipyardProspector
@@ -115,6 +117,11 @@
   name: guide-entry-shipyard-construct
   text: "/ServerInfo/_NF/Guidebook/Shipyard/Construct.xml"
 
+- type: guideEntry
+  id: ShipyardEagle
+  name: guide-entry-shipyard-eagle
+  text: "/ServerInfo/_NF/Guidebook/Shipyard/Eagle.xml"
+
 - type: guideEntry
   id: ShipyardGarden
   name: guide-entry-shipyard-garden
@@ -199,7 +206,12 @@
   id: ShipyardPathfinder
   name: guide-entry-shipyard-pathfinder
   text: "/ServerInfo/_NF/Guidebook/Shipyard/Pathfinder.xml"
-
+
+- type: guideEntry
+  id: ShipyardPhoenix
+  name: guide-entry-shipyard-phoenix
+  text: "/ServerInfo/_NF/Guidebook/Shipyard/Phoenix.xml"
+
 - type: guideEntry
   id: ShipyardPioneer
   name: guide-entry-shipyard-pioneer

Resources/Prototypes/_NF/Guidebook/shuttle_maps.yml

@@ -130,6 +130,18 @@
     state: construct
     scale: 1.2, 1.2
 
+- type: entity
+  parent: PosterBase
+  id: ShuttleMapEagle
+  name: "NM Eagle"
+  description: "Detailed map of an Eagle shuttle."
+  categories: [ HideSpawnMenu ]
+  components:
+  - type: Sprite
+    sprite: _NF/Guidebook/shuttle_maps/128x96.rsi
+    state: eagle
+    scale: 1.2, 1.2
+
 - type: entity
   parent: PosterBase
   id: ShuttleMapGarden
@@ -286,6 +298,18 @@
     state: pathfinder
     scale: 1.2, 1.2
 
+- type: entity
+  parent: PosterBase
+  id: ShuttleMapPhoenix
+  name: "NR Phoenix"
+  description: "Detailed map of a Phoenix shuttle."
+  categories: [ HideSpawnMenu ]
+  components:
+  - type: Sprite
+    sprite: _NF/Guidebook/shuttle_maps/128x96.rsi
+    state: phoenix
+    scale: 1.2, 1.2
+
 - type: entity
   parent: PosterBase
   id: ShuttleMapPioneer

Resources/Prototypes/_NF/Shipyard/eagle.yml

@@ -16,7 +16,7 @@
   category: Medium
   group: Shipyard
   shuttlePath: /Maps/_NF/Shuttles/eagle.yml
-  guidebookPage: Null
+  guidebookPage: ShipyardEagle
   class:
   - Medical
   - Engineering

Resources/Prototypes/_NF/Shipyard/phoenix.yml

@@ -1,12 +1,22 @@
+# Author Info
+# GitHub: ???
+# Discord: ???
+
+# Maintainer Info
+# GitHub: ???
+# Discord: ???
+
+# Shuttle Notes:
+#
 - type: vessel
   id: Phoenix
   name: NR Phoenix
-  description: A research and salvage vessel designed for deep space exploration
+  description: A research and salvage vessel designed for deep space exploration.
   price: 62500 # TODO - fix this value, getting tests to pass - Whatstone
   category: Medium
   group: Shipyard
   shuttlePath: /Maps/_NF/Shuttles/phoenix.yml
-  guidebookPage: Null
+  guidebookPage: ShipyardPhoenix
   class:
   - Science
   - Engineering

Resources/ServerInfo/_NF/Guidebook/Shipyard/Eagle.xml

@@ -0,0 +1,94 @@
+<Document>
+    # EAGLE-CLASS MEDICAL SHUTTLE
+    <Box>
+      <GuideEntityEmbed Entity="ComputerCrewMonitoring"/>
+      <GuideEntityEmbed Entity="RollerBed"/>
+      <GuideEntityEmbed Entity="StasisBed"/>
+	  <GuideEntityEmbed Entity="ChemMaster"/>
+    </Box>
+    <Box>
+      <GuideEntityEmbed Entity="ShuttleMapEagle" Caption=""/>
+    </Box>
+
+    [color=#a4885c]Ship Size:[/color] Medium
+
+    [color=#a4885c]Recommended Crew:[/color] 2-4
+
+    [color=#a4885c]Power Gen Type:[/color] Uranium
+
+    [color=#a4885c]Expeditions:[/color] None
+
+    [color=#a4885c]IFF Console:[/color] None
+
+    "A modern, medium-sized medical & engineering vessel. Focusing on responding to shuttle distress, Eagle bears the motto 'Recover, Restore, Repair!'."
+
+    # PREFLIGHT CHECKLIST
+
+    ## 1. Power supply
+
+    ## 1.1. Battery units
+    <Box>
+        <GuideEntityEmbed Entity="SMESBasic"/>
+        <GuideEntityEmbed Entity="SubstationWallBasic"/>
+        <GuideEntityEmbed Entity="APCBasic"/>
+    </Box>
+
+    - Check that the SMES unit is anchored to the floor.
+    - Check the substation unit.
+    - Check that the APC unit's Main Breaker is toggled on.
+    - Check the APC unit's current Load* (W).
+
+    ## 1.2. S.U.P.E.R.P.A.C.M.A.N. generator units
+    <Box>
+        <GuideEntityEmbed Entity="PortableGeneratorSuperPacman"/>
+        <GuideEntityEmbed Entity="SheetUranium"/>
+        <GuideEntityEmbed Entity="SignRadiationMed"/>
+    </Box>
+
+   - Check if the S.U.P.E.R.P.A.C.M.A.N. generator units are anchored to the floor.
+   - Check if the S.U.P.E.R.P.A.C.M.A.N. generator units have fuel. For extended flights make sure that you have enough fuel stockpiled to sustain prolonged power generation during flight.
+   - Check if the S.U.P.E.R.P.A.C.M.A.N. generator units are set to HV output.
+   - Set Target Power for 16 [bold]k[/bold]W.
+   - Start the S.U.P.E.R.P.A.C.M.A.N. generator units.
+
+  ## 2. Atmospherics
+
+     ## 2.1. Distribution Loop
+    <Box>
+        <GuideEntityEmbed Entity="OxygenCanister"/>
+        <GuideEntityEmbed Entity="NitrogenCanister"/>
+        <GuideEntityEmbed Entity="GasPort"/>
+        <GuideEntityEmbed Entity="GasMixer"/>
+    </Box>
+
+    - Check if the O2 canister and N2 canister are anchored to their connector ports.
+    - Check if the gas mixer has its mixing ratio and output pressure set correctly.
+    - Enable the gas mixer.
+
+    ## 2.2. Waste Loop
+    <Box>
+        <GuideEntityEmbed Entity="GasPressurePump"/>
+        <GuideEntityEmbed Entity="AirAlarm"/>
+    </Box>
+
+    - Check waste loop pump.
+    - Set the Air Alarm in the Engine Room to Filtering (Wide).
+
+    ## 3. Other checks
+    <Box>
+        <GuideEntityEmbed Entity="Gyroscope"/>
+        <GuideEntityEmbed Entity="GravityGeneratorMini"/>
+        <GuideEntityEmbed Entity="ShuttersRadiation"/>
+    </Box>
+
+    - Check that the gyroscope is anchored, powered, and enabled.
+    - Check that the mini gravity generator is anchored, powered, and enabled.
+    - Check that radiation shutters are closed.
+
+    ## Sidenotes
+
+    * - Eagle-class medical response ships are equipped with several APC units that can be used to appraise the ship's total power consumption (which for the unmodified ship is 15.7 kW). To keep the substation and APC fully charged, the generator target power should exceed APC's Load, but by as little as possible to achieve maximum fuel efficiency. Remember to check the APC Load and adjust the generator unit's target power after adding or removing power-consuming machines.
+
+    ** - Eagle-class ships have a slightly above average power demand. A standard P.A.C.M.A.N. generator's target power value can be set to 15-16 kW to modulate between drain and charge. As much of the powerdraw is to sustain the chemistry lab powering down those machines can dramatically reduce the ship's overall draw.
+
+</Document>

Resources/ServerInfo/_NF/Guidebook/Shipyard/Phoenix.xml

@@ -0,0 +1,105 @@
+<Document>
+    # PHOENIX-CLASS RESEARCH SHUTTLE
+    <Box>
+      <GuideEntityEmbed Entity="VariedXenoArtifactItem"/>
+      <GuideEntityEmbed Entity="MachineArtifactAnalyzer"/>
+      <GuideEntityEmbed Entity="ComputerTabletopAnalysisConsole"/>
+      <GuideEntityEmbed Entity="ExosuitFabricator"/>
+      <GuideEntityEmbed Entity="VendingMachineRobotics"/>
+    </Box>
+    <Box>
+      <GuideEntityEmbed Entity="ShuttleMapPhoenix" Caption=""/>
+    </Box>
+    [color=#a4885c]Ship Size:[/color] Medium
+
+    [color=#a4885c]Recommended Crew:[/color] 2-3
+
+    [color=#a4885c]Power Gen Type:[/color] Solar/Plasma
+
+    [color=#a4885c]Expeditions:[/color] None
+
+    [color=#a4885c]IFF Console:[/color] None
+
+    "A research and salvage vessel designed for deep space exploration."
+
+    # PREFLIGHT CHECKLIST
+
+    ## 1. Power supply
+
+    ## 1.1. Battery units
+    <Box>
+      <GuideEntityEmbed Entity="SMESBasic"/>
+      <GuideEntityEmbed Entity="SubstationBasic"/>
+      <GuideEntityEmbed Entity="APCBasic"/>
+    </Box>
+
+    - Check that the SMES unit is anchored to the floor.
+    - Check that the substation unit is anchored to the floor.
+    - Check that the APC unit's Main Breaker is toggled on.
+    - Check the APC unit's current Load* (W).
+
+    ## 1.2. P.A.C.M.A.N. generator units
+    <Box>
+      <GuideEntityEmbed Entity="PortableGeneratorPacmanShuttle"/>
+      <GuideEntityEmbed Entity="SheetPlasma"/>
+    </Box>
+
+    - Check that the P.A.C.M.A.N. generator units are anchored to the floor.
+    - Check that the P.A.C.M.A.N. generator units have fuel. For extended flights make sure that you have enough fuel stockpiled to sustain prolonged power generation during flight.
+    - Check that the P.A.C.M.A.N. generator units are set to HV output.
+    - Set Target Power for 9-12** [bold]kW[/bold].
+    - Ensure that P.A.C.M.A.N. generator units are enabled.
+
+    ## 1.3. Solar panels
+    <Box>
+      <GuideEntityEmbed Entity="ComputerSolarControl"/>
+      <GuideEntityEmbed Entity="SolarTracker"/>
+      <GuideEntityEmbed Entity="SolarPanel"/>
+    </Box>
+    - Inspect solar control computer (located at shuttle cockpit).
+    - Adjust panel angular velocity.
+    - Adjust panel angle.
+
+    ## 2. Atmospherics
+
+    ## 2.1. Distribution Loop
+    <Box>
+      <GuideEntityEmbed Entity="OxygenCanister"/>
+      <GuideEntityEmbed Entity="NitrogenCanister"/>
+      <GuideEntityEmbed Entity="GasPort"/>
+      <GuideEntityEmbed Entity="GasMixer"/>
+      <GuideEntityEmbed Entity="GasPressurePump"/>
+    </Box>
+
+    - Check that the O2 canister is anchored to connector port.
+    - Check that the N2 canister is anchored to connector port.
+    - Check that the gas mixer is set to the correct mixing ratio (21% Oxygen, 79% Nitrogen).
+    - Check that the gas mixer is set to 101kPa.
+    - Ensure that the gas mixer is enabled.
+
+    ## 2.2. Waste Loop
+    <Box>
+      <GuideEntityEmbed Entity="GasPressurePump"/>
+      <GuideEntityEmbed Entity="AirAlarm"/>
+    </Box>
+
+    - Ensure that the waste loop pump is enabled.
+    - Disable Auto Mode on any Air Alarms.
+    - Set Air Alarms to Filtering (Wide).
+
+    ## 3. Other checks
+    <Box>
+      <GuideEntityEmbed Entity="Gyroscope"/>
+      <GuideEntityEmbed Entity="GravityGeneratorMini"/>
+    </Box>
+
+    - Check that the gyroscope is anchored, powered, and enabled.
+    - Check that the mini gravity generator is anchored, powered, and enabled.
+
+    ## Sidenotes
+
+    * - Phoenix-class research ships are equipped a power monitoring console that be used to appraise the ship's total power consumption. An unmodified Phoenix-class ship requires 24.5 kW of power to remain operational.
+
+    ** - Phoenix-class research ships come equipped with additional solar panels that can provide up to 17.5 kW of power under ideal circumstances. Assuming that the solar array will provide a third of its maximum output power, recommended target power output for each P.A.C.M.A.N. generator unit is 12 kW.
+
+  </Document>

Resources/Textures/_NF/Guidebook/shuttle_maps/128x96.rsi/meta.json

@@ -1,7 +1,7 @@
 {
   "version": 1,
   "license": "CC-BY-SA-3.0",
-  "copyright": "ambition, bocadillo, brigand, bulker, ceres, chisel, comet, construct, garden, gasbender, harbormaster, investigator, kestrel, kilderkin, lantern, legman, liquidator, loader, pathfinder, pioneer, prospector, searchlight and vagabond by erhardsteinhauer (discord/github), used font from https://github.com/tgstation/tgstation/blob/master/icons/obj/signs.dmi. spirit by iNoahGuy/actualcatmoment (discord/github). apothecary, stasis by dustylens (discord/github). barge, hauler, placebo, skipper, sparrow by Mygnol (discord/github)",
+  "copyright": "ambition, bocadillo, brigand, bulker, ceres, chisel, comet, construct, garden, gasbender, harbormaster, investigator, kestrel, kilderkin, lantern, legman, liquidator, loader, pathfinder, pioneer, prospector, searchlight and vagabond by erhardsteinhauer (discord/github), used font from https://github.com/tgstation/tgstation/blob/master/icons/obj/signs.dmi. spirit by iNoahGuy/actualcatmoment (discord/github). apothecary, stasis by dustylens (discord/github). barge, eagle, hauler, phoenix, placebo, skipper, sparrow by Mygnol (discord/github)",
   "size": {
     "x": 128,
     "y": 96
@@ -40,6 +40,9 @@
     {
       "name": "construct"
     },
+    {
+      "name": "eagle"
+    },
     {
       "name": "garden"
     },
@@ -79,6 +82,9 @@
     {
       "name": "pathfinder"
     },
+    {
+      "name": "phoenix"
+    },
     {
       "name": "pioneer"
     },