Merge pull request #1282 from ultramario1998/tutorial-pai

Tutorial pAI

Resources/Locale/en-US/_Impstation/ghost/roles/ghost-role-component.ftl

@@ -65,3 +65,5 @@ ghost-role-information-apid-chef-description = A Beefolk chef, called in as back
 
 ghost-role-information-apid-name = Apid
 ghost-role-information-apid-description = A Beefolk worker, called in as backup to help a crew in need.
+
+ghost-role-information-tutorial-rules = You are a [color=#39f5ab][bold]special Tutorial pAI[/bold][/color]. This pAI is only available to those either new to the game generally, or to those in trainee roles. By taking this ghost role, you will be expected to know how your master's role works, be on hand to help them learn, and generally be welcoming and helpful. [color=red][bold]Failure to do so may result in administrator action.[/bold][/color]

Resources/Locale/en-US/_Impstation/pai/pai-system.ftl

@@ -0,0 +1,2 @@
+pai-system-role-name-tutorial = tutor personal ai
+pai-system-role-description-tutorial = Help out a newcomer to the game by jumping into this special electronic pal!

Resources/Locale/en-US/ghost/roles/ghost-role-component.ftl

@@ -19,6 +19,8 @@ ghost-role-information-rules-team-antagonist = You are a [color=red][bold]Team A
 ghost-role-information-familiar-rules = You are a [color=#6495ed][bold]Familiar[/bold][/color]. Serve the interests of your master, whatever those may be.
 
                                         You don't remember any of your previous life, and you don't remember anything you learned as a ghost.
+
+
 ghost-role-information-silicon-rules = You are a [color=#6495ed][bold]Silicon[/bold][/color]. Obey your laws. You are a Free Agent if you are not currently bound by any laws.
 
                                        You don't remember any of your previous life, and you don't remember anything you learned as a ghost.

Resources/Locale/en-US/pai/pai-system.ftl

@@ -9,6 +9,7 @@ pai-system-role-description = Be someone's electronic pal!
 pai-system-role-name-gilded = gilded personal ai
 pai-system-role-description-gilded = Be someone's fancy electronic pal!
                               (Memories *not* included.)
+
 pai-system-role-name-syndicate = Syndicate personal ai
 pai-system-role-description-syndicate = Be someone's Syndicate pal!
                                         (Memories *not* included.)

Resources/Locale/en-US/preferences/loadout-groups.ftl

@@ -3,7 +3,6 @@ loadout-group-species-restriction = This item is not available for your current
 
 # Miscellaneous
 loadout-group-trinkets = Trinkets
-loadout-group-learner = pAI Assistant
 loadout-group-glasses = Glasses
 loadout-group-backpack = Backpack
 loadout-group-instruments = Instruments

Resources/Prototypes/Loadouts/Miscellaneous/trinkets.yml

@@ -8,20 +8,6 @@
       department: Command
       time: 3600 # 1 hour
 
-- type: loadoutEffectGroup
-  id: PrestigeGold
-  effects:
-  - !type:JobRequirementLoadoutEffect
-    requirement:
-      !type:OverallPlaytimeRequirement
-
-      time: 1512000 #420 hours
-  - !type:JobRequirementLoadoutEffect
-    requirement:
-      !type:DepartmentTimeRequirement
-      department: Silicon
-      time: 36000 #10 hours
-
 # Flowers
 - type: loadout
   id: FlowerWreath

Resources/Prototypes/Loadouts/loadout_groups.yml

@@ -21,7 +21,8 @@
   - CigPackSpirits #imp
   - CigarCase
   - CigarGold
-  - GoldPersonalAI #imp
+  - GoldPersonalAI #imp >420 hours
+  - TutorialAI_Newcomer #imp <15 hours
   - FolderBlack #imp
   - FolderHamster #imp
   - FolderMime #imp
@@ -62,15 +63,6 @@
   - CardBoxBlack
   - HarmonicaInstrument #imp
 
-# For introductory roles learning more complex jobs, like an in-game personal mentor
-- type: loadoutGroup
-  id: Learner
-  name: loadout-group-learner
-  minLimit: 0
-  maxLimit: 1
-  loadouts:
-  - PersonalAI
-
 - type: loadoutGroup
   id: Glasses
   name: loadout-group-glasses

Resources/Prototypes/Loadouts/role_loadouts.yml

@@ -330,7 +330,6 @@
   - TechnicalAssistantJumpsuit
   - StationEngineerBackpack
   - SurvivalExtended
-  - Learner
   - Trinkets
   - GroupSpeciesBreathTool
   - GroupTankHarness
@@ -418,7 +417,6 @@
   - ScientistBackpack
   - Glasses
   - Survival
-  - Learner
   - Trinkets
   - GroupSpeciesBreathTool
   - GroupTankHarness
@@ -528,7 +526,6 @@
   - SecurityCadetJumpsuit
   - SecurityBackpack
   - SurvivalSecurity
-  - Learner
   - Trinkets
   - GroupSpeciesBreathToolSecurity
   - GroupTankHarness
@@ -583,7 +580,6 @@
   - Glasses
   - MedicalBackpack
   - SurvivalMedical
-  - Learner
   - Trinkets
   - GroupSpeciesBreathToolMedical
   - GroupTankHarness

Resources/Prototypes/Roles/Jobs/Engineering/technical_assistant.yml

@@ -26,7 +26,8 @@
     id: TechnicalAssistantPDA
     belt: ClothingBeltUtilityEngineering
     ears: ClothingHeadsetEngineering
+    pocket1: TutorialPersonalAI #imp
     pocket2: BookEngineersHandbook
-  #storage:
-    #back:
-    #- Stuff
+  # storage:
+  #   back:
+  #   - Stuff

Resources/Prototypes/Roles/Jobs/Medical/medical_intern.yml

@@ -23,7 +23,8 @@
     id: MedicalInternPDA
     ears: ClothingHeadsetMedical
     belt: ClothingBeltMedicalFilled
+    pocket1: TutorialPersonalAI #imp
     pocket2: BookMedicalReferenceBook
-  #storage:
-    #back:
-    #- Stuff
+  # storage:
+  #   back:
+  #   - Stuff

Resources/Prototypes/Roles/Jobs/Science/research_assistant.yml

@@ -22,7 +22,8 @@
     shoes: ClothingShoesColorWhite
     id: ResearchAssistantPDA
     ears: ClothingHeadsetScience
+    pocket1: TutorialPersonalAI #imp
     pocket2: BookScientistsGuidebook
-  #storage:
-    #back:
-    #- Stuff
+  # storage:
+  #   back:
+  #   - Stuff

Resources/Prototypes/Roles/Jobs/Security/security_officer.yml

@@ -28,6 +28,7 @@
     eyes: ClothingEyesGlassesSecurity
     ears: ClothingHeadsetSecurity
     pocket1: WeaponPistolMk58
+    pocket2: TutorialPersonalAI #imp
   storage:
     back:
     - Flash

Resources/Prototypes/_Impstation/Entities/Objects/Fun/pai.yml

@@ -0,0 +1,31 @@
+- type: entity # imp
+  parent: PersonalAI
+  id: TutorialPersonalAI
+  name: tutor personal ai device
+  description: A special personal AI device, loaded with helpful tips and tricks for newcomers to Space Station 14. Turn it on by putting it in your hand and pressing the 'E' key. # breaking kayfabe with this one, but i figure if we can do it anywhere, it's here
+  components:
+  - type: Sprite
+    sprite: _Impstation/Objects/Fun/tutorial_pai.rsi
+    layers:
+    - state: pai-base
+    - state: tutorial-pai-off-overlay
+      shader: unshaded
+      map: ["screen"]
+  - type: ToggleableGhostRole
+    roleName: pai-system-role-name-tutorial
+    roleDescription: pai-system-role-description-tutorial
+    roleRules: ghost-role-information-tutorial-rules
+  - type: IntrinsicRadioTransmitter
+    channels:
+    - Common
+  - type: ActiveRadio
+    channels:
+    - Common
+  - type: Appearance
+  - type: GenericVisualizer
+    visuals:
+      enum.ToggleableGhostRoleVisuals.Status:
+        screen:
+          Off: { state: tutorial-pai-off-overlay }
+          Searching: { state: tutorial-pai-searching-overlay }
+          On: { state: tutorial-pai-on-overlay }

Resources/Prototypes/_Impstation/Loadouts/Miscellaneous/trinkets.yml

@@ -1,3 +1,25 @@
+- type: loadoutEffectGroup
+  id: PrestigeGold
+  effects:
+  - !type:JobRequirementLoadoutEffect
+    requirement:
+      !type:OverallPlaytimeRequirement
+      time: 1512000 #420 hours
+  - !type:JobRequirementLoadoutEffect
+    requirement:
+      !type:DepartmentTimeRequirement
+      department: Silicon
+      time: 36000 #10 hours
+
+- type: loadoutEffectGroup
+  id: Tutorial #imp
+  effects:
+  - !type:JobRequirementLoadoutEffect
+    requirement:
+      !type:OverallPlaytimeRequirement
+      time: 54000 #15 hrs
+      inverted: true # don't let experienced players select these
+
 - type: loadout
   id: CigPackNewport
   storage:
@@ -25,6 +47,15 @@
     back:
     - GoldPersonalAI
 
+- type: loadout
+  id: TutorialAI_Newcomer #imp. <15 hours.
+  effects:
+  - !type:GroupLoadoutEffect
+    proto: Tutorial
+  storage:
+    back:
+    - TutorialPersonalAI
+
 - type: loadout
   id: FolderHamster
   storage:

Resources/Textures/_Impstation/Objects/Fun/tutorial_pai.rsi/meta.json

@@ -0,0 +1,35 @@
+{
+  "version": 1,
+  "license": "CC-BY-SA-3.0",
+  "copyright": "Taken from tgstation at commit https://github.com/tgstation/tgstation/commit/9ddb8cf084e292571d4e9c79745db25befbd82fe. pai-searching-overlay heavily modified. new tutorial variant by ultramario1998.",
+  "size": {
+    "x": 32,
+    "y": 32
+  },
+  "states": [
+    {
+      "name": "pai-base"
+    },
+    {
+      "name": "tutorial-pai-off-overlay"
+    },
+    {
+      "name": "tutorial-pai-on-overlay",
+      "delays": [
+        [
+          0.8,
+          0.8
+        ]
+      ]
+    },
+    {
+      "name": "tutorial-pai-searching-overlay",
+      "delays": [
+        [
+          0.8,
+          0.8
+        ]
+      ]
+    }
+  ]
+}