xenoarch guidebook entries (#13619)

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

@@ -14,4 +14,7 @@ guide-entry-science = Science
 guide-entry-anomalous-research = Anomalous Research
 guide-entry-scanners-and-vessels = Scanners and Vessels
 guide-entry-ape = A.P.E.
+guide-entry-xenoarchaeology = Xenoarchaeology
+guide-entry-artifact-reports = Artifact Reports
+guide-entry-traversal-distorter = Traversal Distorter
 guide-entry-machine-upgrading = Machine Upgrading

Resources/Prototypes/Entities/Objects/Misc/paper.yml

@@ -61,6 +61,9 @@
     - state: paper_stamp-generic
       map: ["enum.PaperVisualLayers.Stamp"]
       visible: false
+  - type: GuideHelp
+    guides:
+    - ArtifactReports
   - type: PaperVisuals
     headerImagePath: "/Textures/Interface/Paper/paper_heading_artifact_analyzer.svg.96dpi.png"
     headerMargin: 0.0, 0.0, 0.0, 16.0

Resources/Prototypes/Entities/Objects/Specific/Xenoarchaeology/item_artifacts.yml

@@ -56,6 +56,9 @@
     sprite: Objects/Specific/Xenoarchaeology/item_artifacts.rsi
     heldPrefix: ano01
   - type: Actions
+  - type: GuideHelp
+    guides:
+    - Xenoarchaeology
 
 - type: entity
   parent: BaseXenoArtifactItem

Resources/Prototypes/Entities/Objects/Specific/Xenoarchaeology/node_scanner.yml

@@ -13,3 +13,6 @@
     - type: NodeScanner
     - type: UseDelay
       delay: 3
+    - type: GuideHelp
+      guides:
+      - ArtifactReports

Resources/Prototypes/Entities/Objects/Specific/Xenoarchaeology/structure_artifacts.yml

@@ -45,6 +45,9 @@
     - type: StaticPrice
       price: 500
     - type: Actions
+    - type: GuideHelp
+      guides:
+      - Xenoarchaeology
 
 - type: entity
   parent: BaseXenoArtifact

Resources/Prototypes/Entities/Structures/Machines/Computers/computers.yml

@@ -395,6 +395,9 @@
     radius: 1.5
     energy: 1.6
     color: "#b53ca1"
+  - type: GuideHelp
+    guides:
+    - Xenoarchaeology
 
 - type: entity
   parent: BaseComputer

Resources/Prototypes/Entities/Structures/Machines/artifact_analyzer.yml

@@ -58,6 +58,9 @@
     radius: 1.5
     energy: 1.6
     color: "#b53ca1"
+  - type: GuideHelp
+    guides:
+    - Xenoarchaeology
   - type: LitOnPowered
   - type: Appearance
   - type: GenericVisualizer
@@ -107,6 +110,9 @@
   - type: Machine
     board: TraversalDistorterMachineCircuitboard
   - type: Appearance
+  - type: GuideHelp
+    guides:
+    - TraversalDistorter
   - type: GenericVisualizer
     visuals:
       enum.PowerDeviceVisuals.Powered:

Resources/Prototypes/Entities/Structures/Wallmounts/Signs/signs.yml

@@ -246,8 +246,8 @@
 - type: entity
   parent: BaseSign
   id: SignAnomaly
-  name: xenoarcheology lab sign
-  description: A sign indicating the xenoarcheology lab.
+  name: xenoarchaeology lab sign
+  description: A sign indicating the xenoarchaeology lab.
   components:
   - type: Sprite
     state: anomaly

Resources/Prototypes/Guidebook/science.yml

@@ -4,6 +4,7 @@
   text: "/Server Info/Guidebook/Science/Science.xml"
   children:
   - AnomalousResearch
+  - Xenoarchaeology
   - MachineUpgrading
 
 - type: guideEntry
@@ -24,6 +25,24 @@
   name: guide-entry-ape
   text: "/Server Info/Guidebook/Science/APE.xml"
 
+- type: guideEntry
+  id: Xenoarchaeology
+  name: guide-entry-xenoarchaeology
+  text: "/Server Info/Guidebook/Science/Xenoarchaeology.xml"
+  children:
+  - ArtifactReports
+  - TraversalDistorter
+
+- type: guideEntry
+  id: ArtifactReports
+  name: guide-entry-artifact-reports
+  text: "/Server Info/Guidebook/Science/ArtifactReports.xml"
+
+- type: guideEntry
+  id: TraversalDistorter
+  name: guide-entry-traversal-distorter
+  text: "/Server Info/Guidebook/Science/TraversalDistorter.xml"
+
 - type: guideEntry
   id: MachineUpgrading
   name: guide-entry-machine-upgrading

Resources/Server Info/Guidebook/Science/ArtifactReports.xml

@@ -0,0 +1,25 @@
+<Document>
+# Artifact Reports
+A large portion of Xenoarchaeology gameplay revolves around the interpretation of artifact reports, which are created at the [color=#a4885c]analysis console[/color] after an artifact is scanned. Reports contain the following information:
+
+- [color=#a4885c]Node ID:[/color] a unique numeric ID corresponding to this artifact's node. Useful in conjunction with a [color=#a4885c]node scanner[/color] for quickly identifying recurring nodes.
+
+- [color=#a4885c]Depth:[/color] a distance from the starting node (depth 0). This is a good shorthand for the value and danger of a node.
+
+- [color=#a4885c]Activation status:[/color] whether or not a node has been activated in the past.
+
+- [color=#a4885c]Stimulus:[/color] the stimulus for that particular node.
+
+- [color=#a4885c]Reaction:[/color] the reaction the stimulus induces. This is often vague, so caution is advised.
+
+- [color=#a4885c]Edges:[/color] the amount of nodes that are connected to the current node. Using this, you can calculate the total number of nodes as well as organize a map of their connections.
+
+- [color=#a4885c]Current value:[/color] the amount of research points an artifact is currently worth. This is an important factor in choosing when to stop research and destroy the artifact in exchange for points.
+
+Reports are a helpful tool in manipulating an artifact, especially in the later stages where you are traversing nodes that have already been activated. 
+<Box>
+<GuideEntityEmbed Entity="PaperArtifactAnalyzer"/>
+</Box>
+To help with this process, consider printing out reports, writing down details uncovered during activation, or storing them in a folder nearby. 
+
+</Document>

Resources/Server Info/Guidebook/Science/TraversalDistorter.xml

@@ -0,0 +1,18 @@
+<Document>
+# Traversal Distorter
+
+The traversal distorter is a late-game artifact machine that can aid in moving through the nodes of an artifact. 
+<Box>
+<GuideEntityEmbed Entity="MachineTraversalDistorter"/>
+</Box>
+Artifacts placed on top of a powered traversal distorter are subjected to a bias which affects which node they will move to after being activated. The bias can be set by clicking on the distorter.
+
+There are two types of biases:
+- [color=#a4885c]In:[/color] favors nodes closer to the origin. Results in a decrease of depth.
+- [color=#a4885c]Out:[/color] favors nodes farther away from the origin. Results in an increase of depth.
+
+Setting it to bias inwards allows you to return to the beginning of an artifact graph, if you've reached a dead end. 
+
+Likewise, if you find yourself stuck at low depths, setting it to bias outward will help you find new nodes. In certain circumstances, toggling between the two allows you to repeatedly activate the same node.
+
+</Document>

Resources/Server Info/Guidebook/Science/Xenoarchaeology.xml

@@ -0,0 +1,29 @@
+<Document>
+# Xenoarchaeology
+Xenoarchaeology is a science subdepartment focused on researching and experimenting on alien artifacts.
+
+## Artifacts
+<Box>
+<GuideEntityEmbed Entity="SimpleXenoArtifact" Caption=""/>
+<GuideEntityEmbed Entity="SimpleXenoArtifactItem" Caption=""/>
+</Box>
+Artifacts consist of a randomly-generated graph structure. They consist of nodes connected to each other by edges, the traversal of which is the main goal of the scientists working on them.
+
+Each node has two main components: a [color=#a4885c]stimulus[/color] and a [color=#a4885c]reaction[/color]. A stimulus is the external behavior that triggers the reaction. Some reactions are instantaneous effects while others are permanent changes. Triggering the reaction causes the artifact to move to one of the node's edges.
+
+With these basic principles, you can begin to grasp how the different nodes of an artifact are interconnected, and how one can move between them by repeatedly activating nodes. 
+
+While it might seem random to an untrained eye, a skilled scientist can learn to understand the internal structure of any artifact.
+
+## Artifact Analyzer and Analysis Console
+<Box>
+<GuideEntityEmbed Entity="MachineArtifactAnalyzer"/>
+<GuideEntityEmbed Entity="ComputerAnalysisConsole"/>
+</Box>
+The main equipment that you'll be using for Xenoarchaeology is the [color=#a4885c]artifact analyzer[/color] and the [color=#a4885c]analysis console[/color]. You can use these to create reports that contain valuable information about an artifact. 
+
+To set them up, simply link them with a multitool, set an artifact on top of the analyzer, and press the [color=#a4885c]Scan[/color] button.
+
+Using the console, you can permanently destroy and artifact in exchange for points. This is irreversible, so be sure to confirm with your department that all research on it has concluded.
+
+</Document>