Skip to content

Commit f2246c5

Browse files
GrafDimenzioGrafDimenzio
committed
Update README.md
1 parent 2e2750a commit f2246c5

File tree

1 file changed

+138
-53
lines changed

1 file changed

+138
-53
lines changed

‎README.md

+138-53
Original file line numberDiff line numberDiff line change
@@ -7,74 +7,159 @@ RoleID: 56
77

88
RoleName : Scp056
99

10-
# Used Keys
10+
# KeyBind
1111
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.
1212
| Key | Function |
1313
| :-------------: | :------ |
14-
| Alpha1 | Change the Role to ClassD |
15-
| Alpha2 | Change the Role to Scientist |
16-
| Alpha3 | Change the Role to Guard |
17-
| Alpha4 | Change the Role to MTF |
18-
| Alpha5 | Change the Role to Chaos |
19-
| Alpha6 | Show's the remaining targets |
14+
| KeyPad0 | Displays the amount of targets left |
15+
| KeyPad1 | Change the Role to ClassD |
16+
| KeyPad2 | Change the Role to Scientist |
17+
| KeyPad3 | Change the Role to Guard |
18+
| KeyPad4 | Change the Role to NtfSergeant |
19+
| KeyPad5 | Change the Role to ChaosRepressor |
20+
| KeyPad6 | Change the Role to Scp049 |
21+
| KeyPad7 | Change the Role to Scp173 |
22+
| KeyPad8 | Change the Role to Scp096 |
23+
| KeyPad9 | Change the Role to Scp939 |
2024

2125
# Command
2226
If the Player doesn't have installed the key press system then he can change his Role with a command
2327
| Command | Function |
2428
| :-------------: | :------ |
2529
| .056 | Gives a list of all 056 Command |
2630
| .056 targets | Gives a number of how many targets are left |
27-
| .056 class D | Change the Role to ClassD |
28-
| .056 class S | Change the Role to Scientist |
29-
| .056 class G | Change the Role to Guard |
30-
| .056 class M | Change the Role to MTF |
31-
| .056 class C | Change the Role to Chaos |
31+
| .056 class RoleName | Change the Role to the specified class |
3232

3333
# Config
34-
| ConfigName | Type | Description |
35-
| :-------------: | :---------: | :------ |
36-
| scp056SpawnPoint | [MapPoint](https://github.com/SynapseSL/Synapse/wiki/Command-List#synapse-commands) | The Position where Scp056 should spawn |
37-
| ff | Boolean | If Scp056 can Hurt other Scp's |
38-
| scp056Health | Float | The Amount of Health Scp056 have |
39-
| items | ItemList | The Items which Scp056 gets when he spawn |
40-
| spawnchanche | Float | The chanche that Scp056 spawns |
41-
| requiredPlayers | Integer | The Amount of Players needed before Scp056 can spawn|
42-
| replacescp | Boolean | If set to true Scp056 will be spawned instead of an Scp |
43-
| replace079 | Boolean | If set to true can 056 not spawn alone with 079 |
34+
| ConfigName | Type | Description |
35+
|:---------------------------:|:-----------------------:|:-------------------------------------------------------------------|
36+
| scp056Configuration | Scp056RoleConfiguration | The basic role information for SCP-056 |
37+
| allowedRoles | List<RoleTypeID> | A list of all allowed roles that 056 can swap to |
38+
| ff | Boolean | If Scp056 can Hurt other Scp's |
39+
| enableDefaultSpawnBehaviour | Boolean | When true the plugin will spawn 056 when the requirements are meet |
40+
| spawnChance | float | The chance of 056 spawning into the round |
41+
| requiredPlayers | Integer | The required amount of players needed before 056 can spawn |
42+
| replaceScp | Boolean | When true one Scp less will spawn when 056 spawns |
4443

4544
Default Configuration for Scp056
46-
```
47-
[Scp056]
48-
{
49-
scp056SpawnPoint:
50-
room: HCZ_Room3ar
51-
x: -1.79200006
52-
y: 1.33001697
53-
z: -0.00400558906
45+
```yml
46+
[Scp 056]
47+
scp056Configuration:
48+
# The Role that the Player spawns as
49+
role: Tutorial
50+
# The Role that is Visible for other Humans at the start of the Round
51+
visibleRole: FacilityGuard
52+
ownRole: None
53+
# The Role SCP-056 becomes when he Escapes
54+
escapeRole: 0
55+
health: 200
56+
maxHealth: 200
57+
artificialHealth: 0
58+
maxArtificialHealth: 75
59+
possibleSpawns:
60+
- roomName: HeavyArmory
61+
position:
62+
x: -1.79999995
63+
y: 1.35000002
64+
z: 0
65+
rotation:
66+
x: 0
67+
y: -90
68+
z: 0
69+
possibleInventories:
70+
- items:
71+
- chance: 100
72+
provideFully: true
73+
iD: 14
74+
durability: 0
75+
weaponAttachments: 0
76+
xSize: 1
77+
ySize: 1
78+
zSize: 1
79+
- chance: 100
80+
provideFully: true
81+
iD: 34
82+
durability: 0
83+
weaponAttachments: 0
84+
xSize: 1
85+
ySize: 1
86+
zSize: 1
87+
- chance: 100
88+
provideFully: true
89+
iD: 7
90+
durability: 0
91+
weaponAttachments: 0
92+
xSize: 1
93+
ySize: 1
94+
zSize: 1
95+
- chance: 100
96+
provideFully: true
97+
iD: 23
98+
durability: 0
99+
weaponAttachments: 0
100+
xSize: 1
101+
ySize: 1
102+
zSize: 1
103+
- chance: 100
104+
provideFully: true
105+
iD: 26
106+
durability: 0
107+
weaponAttachments: 0
108+
xSize: 1
109+
ySize: 1
110+
zSize: 1
111+
- chance: 100
112+
provideFully: true
113+
iD: 36
114+
durability: 0
115+
weaponAttachments: 0
116+
xSize: 1
117+
ySize: 1
118+
zSize: 1
119+
- chance: 100
120+
provideFully: true
121+
iD: 12
122+
durability: 0
123+
weaponAttachments: 0
124+
xSize: 1
125+
ySize: 1
126+
zSize: 1
127+
ammo:
128+
ammo5: 0
129+
ammo7: 0
130+
ammo9: 60
131+
ammo12: 0
132+
ammo44: 0
133+
scale:
134+
x: 1
135+
y: 1
136+
z: 1
137+
allowedRoles:
138+
- ClassD
139+
- Scientist
140+
- FacilityGuard
141+
- ChaosConscript
142+
- ChaosMarauder
143+
- ChaosRepressor
144+
- ChaosRifleman
145+
- NtfCaptain
146+
- NtfPrivate
147+
- NtfSergeant
148+
- NtfSpecialist
149+
- Scp049
150+
- Scp096
151+
- Scp106
152+
- Scp173
153+
- Scp0492
154+
- Scp939
155+
# If Enabled Scp056 can Hurt Scps(Guns,Generator,FemurBreaker,etc.)
54156
ff: false
55-
scp056Health: 150
56-
items:
57-
- iD: 23
58-
durabillity: 35
59-
weaponAttachments: 0
60-
xSize: 1
61-
ySize: 1
62-
zSize: 1
63-
- iD: 14
64-
durabillity: 35
65-
weaponAttachments: 0
66-
xSize: 1
67-
ySize: 1
68-
zSize: 1
69-
- iD: 4
70-
durabillity: 35
71-
weaponAttachments: 0
72-
xSize: 1
73-
ySize: 1
74-
zSize: 1
75-
spawnChanche: 50
157+
# 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
158+
enableDefaultSpawnBehaviour: true
159+
# The Chanche of which Scp056 spawns
160+
spawnChance: 50
161+
# The Amount of Players Required in order to have the Chanche that 056 can spawn
76162
requiredPlayers: 3
163+
# If Enabled a Scp will become Scp056.If Disabled a Human will become Scp056
77164
replaceScp: false
78-
replace079: true
79-
}
80165
```

0 commit comments

Comments
 (0)