Update README.md

SynapseSL · Mar 8, 2023 · f2246c5 · f2246c5
1 parent 2e2750a
commit f2246c5
Showing 1 changed file with 138 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -7,74 +7,159 @@ RoleID: 56
 
 RoleName : Scp056
 
-# Used Keys
+# KeyBind
 Scp056 uses the [key press](https://github.com/SynapseSL/Synapse/wiki/KeyBind-System) system of Synapse which means Scp056 can quickly change his Role by pressing a key.
 | Key | Function |
 | :-------------: | :------ |
-| Alpha1 | Change the Role to ClassD |
-| Alpha2 | Change the Role to Scientist |
-| Alpha3 | Change the Role to Guard |
-| Alpha4 | Change the Role to MTF |
-| Alpha5 | Change the Role to Chaos |
-| Alpha6 | Show's the remaining targets |
+| KeyPad0 | Displays the amount of targets left |
+| KeyPad1 | Change the Role to ClassD |
+| KeyPad2 | Change the Role to Scientist |
+| KeyPad3 | Change the Role to Guard |
+| KeyPad4 | Change the Role to NtfSergeant |
+| KeyPad5 | Change the Role to ChaosRepressor |
+| KeyPad6 | Change the Role to Scp049 |
+| KeyPad7 | Change the Role to Scp173 |
+| KeyPad8 | Change the Role to Scp096 |
+| KeyPad9 | Change the Role to Scp939 |
 
 # Command
 If the Player doesn't have installed the key press system then he can change his Role with a command
 | Command | Function |
 | :-------------: | :------ |
 | .056 | Gives a list of all 056 Command |
 | .056 targets | Gives a number of how many targets are left |
-| .056 class D | Change the Role to ClassD |
-| .056 class S | Change the Role to Scientist |
-| .056 class G | Change the Role to Guard |
-| .056 class M | Change the Role to MTF |
-| .056 class C | Change the Role to Chaos |
+| .056 class RoleName | Change the Role to the specified class |
 
 # Config
-| ConfigName | Type | Description |
-| :-------------: | :---------: | :------ |
-| scp056SpawnPoint | [MapPoint](https://github.com/SynapseSL/Synapse/wiki/Command-List#synapse-commands) | The Position where Scp056 should spawn |
-| ff | Boolean | If Scp056 can Hurt other Scp's |
-| scp056Health | Float | The Amount of Health Scp056 have |
-| items | ItemList | The Items which Scp056 gets when he spawn |
-| spawnchanche | Float | The chanche that Scp056 spawns |
-| requiredPlayers | Integer | The Amount of Players needed before Scp056 can spawn|
-| replacescp | Boolean | If set to true Scp056 will be spawned instead of an Scp |
-| replace079 | Boolean | If set to true can 056 not spawn alone with 079 |
+|         ConfigName          |          Type           | Description                                                        |
+|:---------------------------:|:-----------------------:|:-------------------------------------------------------------------|
+|     scp056Configuration     | Scp056RoleConfiguration | The basic role information for SCP-056                             |
+|        allowedRoles         |    List<RoleTypeID>     | A list of all allowed roles that 056 can swap to                   |
+|             ff              |         Boolean         | If Scp056 can Hurt other Scp's                                     |
+| enableDefaultSpawnBehaviour |         Boolean         | When true the plugin will spawn 056 when the requirements are meet |
+|         spawnChance         |          float          | The chance of 056 spawning into the round                          |
+|       requiredPlayers       |         Integer         | The required amount of players needed before 056 can spawn         |
+|        replaceScp           |        Boolean          | When true one Scp less will spawn when 056 spawns                  |
 
 Default Configuration for Scp056
-```
-[Scp056]
-{
-scp056SpawnPoint:
-  room: HCZ_Room3ar
-  x: -1.79200006
-  y: 1.33001697
-  z: -0.00400558906
+```yml
+[Scp 056]
+scp056Configuration:
+# The Role that the Player spawns as
+  role: Tutorial
+  # The Role that is Visible for other Humans at the start of the Round
+  visibleRole: FacilityGuard
+  ownRole: None
+  # The Role SCP-056 becomes when he Escapes
+  escapeRole: 0
+  health: 200
+  maxHealth: 200
+  artificialHealth: 0
+  maxArtificialHealth: 75
+  possibleSpawns:
+  - roomName: HeavyArmory
+    position:
+      x: -1.79999995
+      y: 1.35000002
+      z: 0
+    rotation:
+      x: 0
+      y: -90
+      z: 0
+  possibleInventories:
+  - items:
+    - chance: 100
+      provideFully: true
+      iD: 14
+      durability: 0
+      weaponAttachments: 0
+      xSize: 1
+      ySize: 1
+      zSize: 1
+    - chance: 100
+      provideFully: true
+      iD: 34
+      durability: 0
+      weaponAttachments: 0
+      xSize: 1
+      ySize: 1
+      zSize: 1
+    - chance: 100
+      provideFully: true
+      iD: 7
+      durability: 0
+      weaponAttachments: 0
+      xSize: 1
+      ySize: 1
+      zSize: 1
+    - chance: 100
+      provideFully: true
+      iD: 23
+      durability: 0
+      weaponAttachments: 0
+      xSize: 1
+      ySize: 1
+      zSize: 1
+    - chance: 100
+      provideFully: true
+      iD: 26
+      durability: 0
+      weaponAttachments: 0
+      xSize: 1
+      ySize: 1
+      zSize: 1
+    - chance: 100
+      provideFully: true
+      iD: 36
+      durability: 0
+      weaponAttachments: 0
+      xSize: 1
+      ySize: 1
+      zSize: 1
+    - chance: 100
+      provideFully: true
+      iD: 12
+      durability: 0
+      weaponAttachments: 0
+      xSize: 1
+      ySize: 1
+      zSize: 1
+    ammo:
+      ammo5: 0
+      ammo7: 0
+      ammo9: 60
+      ammo12: 0
+      ammo44: 0
+  scale:
+    x: 1
+    y: 1
+    z: 1
+allowedRoles:
+- ClassD
+- Scientist
+- FacilityGuard
+- ChaosConscript
+- ChaosMarauder
+- ChaosRepressor
+- ChaosRifleman
+- NtfCaptain
+- NtfPrivate
+- NtfSergeant
+- NtfSpecialist
+- Scp049
+- Scp096
+- Scp106
+- Scp173
+- Scp0492
+- Scp939
+# If Enabled Scp056 can Hurt Scps(Guns,Generator,FemurBreaker,etc.)
 ff: false
-scp056Health: 150
-items:
-- iD: 23
-  durabillity: 35
-  weaponAttachments: 0
-  xSize: 1
-  ySize: 1
-  zSize: 1
-- iD: 14
-  durabillity: 35
-  weaponAttachments: 0
-  xSize: 1
-  ySize: 1
-  zSize: 1
-- iD: 4
-  durabillity: 35
-  weaponAttachments: 0
-  xSize: 1
-  ySize: 1
-  zSize: 1
-spawnChanche: 50
+# If Disabled the entire Spawn logic will be skipped and all configs below become useless. Use this when you use another Plugin to spawn Roles
+enableDefaultSpawnBehaviour: true
+# The Chanche of which Scp056 spawns
+spawnChance: 50
+# The Amount of Players Required in order to have the Chanche that 056 can spawn
 requiredPlayers: 3
+# If Enabled a Scp will become Scp056.If Disabled a Human will become Scp056
 replaceScp: false
-replace079: true
-}
 ```