|
1 | 1 | # AdvancedCustomRoles |
2 | | -This is a SCP:SL plugin for [Synapse](http://synapsesl.xyz) with which you can easily create new Roles with no coding knowledge. |
| 2 | +This is a SCP:SL plugin for [Synapse 3](http://synapsesl.xyz) with which you can easily create new Roles with no coding knowledge. |
3 | 3 |
|
4 | 4 | *** |
5 | 5 |
|
6 | 6 | ## Installation |
7 | | -1. [Install Synapse](https://docs.synapsesl.xyz/setup/setup) |
8 | | -2. Place the AdvancedCustomRoles.dll file that you can download [here](https://github.com/SynapseSL/AdvancedCustomRoles/releases) in your plugin directory |
9 | | -3. Restart/Start your server. |
| 7 | +Download the latest version of this Plugin and unzip the file inside your SL Server Files |
10 | 8 |
|
11 | 9 | *** |
12 | 10 |
|
13 | 11 | # Create Custom Roles |
14 | 12 |
|
15 | | -It is very easy to create new Roles. A Example file will be generated in `~/Synapse/configs/server-shared/customroles` that you can use as base to create a new Role. |
| 13 | +It is very easy to create new Roles. A Example file will be generated in `~/Synapse/CustomRoles` that you can use as base to create a new Role. |
16 | 14 |
|
17 | | -If you need more Examples you can see some Example Roles [here](https://github.com/SynapseSL/AdvancedCustomRoles/tree/master/Example%20Roles) |
| 15 | +You can read our docs [here](https://docs3.synapsesl.xyz/resources) for Information about some Id's you need for configuring roles |
18 | 16 |
|
19 | | -`Note: Every Role must have his own file inside the customroles folder.` |
20 | | - |
21 | | -### Inventory |
| 17 | +## Example Role |
22 | 18 | ```yml |
23 | | -inventory: |
24 | | - items: |
25 | | - # The chance that the player gets the Items |
| 19 | +[Role] |
| 20 | +name: ExampleRole |
| 21 | +#A unique id for this Role for plugins and commands to spawn this role |
| 22 | +roleId: 101 |
| 23 | +#The team wh |
| 24 | +teamId: 2 |
| 25 | +#A list of all enemies that must be defeated before the round can end |
| 26 | +enemies: |
| 27 | +- 0 |
| 28 | +#A list of all teams that this role can't damage (ff configuration) |
| 29 | +friends: |
| 30 | +- 0 |
| 31 | +#The Role which the Player will actually be set and will be used for internal server calculation |
| 32 | +role: ClassD |
| 33 | +#The Role which other Players will see. When None it uses role |
| 34 | +visibleRole: None |
| 35 | +#The Role which the Player itself will see. When None it uses role |
| 36 | +ownRole: None |
| 37 | +#The role the player will be assigned when he escapes |
| 38 | +escapeRole: 4294967295 |
| 39 | +health: 100 |
| 40 | +maxHealth: 150 |
| 41 | +artificialHealth: 0 |
| 42 | +maxArtificialHealth: 75 |
| 43 | +#The spawn locations for this Role. Use the Roompoint command in game to get the values |
| 44 | +possibleSpawns: |
| 45 | +- roomName: Shelter |
| 46 | + position: |
| 47 | + x: 0 |
| 48 | + y: 2 |
| 49 | + z: 0 |
| 50 | + rotation: |
| 51 | + x: 80 |
| 52 | + y: 180 |
| 53 | + z: 0 |
| 54 | +#The Inventories the player can get |
| 55 | +possibleInventories: |
| 56 | +- items: |
26 | 57 | - chance: 100 |
27 | | - # If the prefered weapon attachments should be used |
28 | | - usePreferences: false |
29 | | - # The Id of the Item |
30 | | - iD: 0 |
31 | | - durabillity: 0 |
| 58 | + provideFully: true |
| 59 | + iD: 1 |
| 60 | + durability: 0 |
32 | 61 | weaponAttachments: 0 |
33 | 62 | xSize: 1 |
34 | 63 | ySize: 1 |
35 | 64 | zSize: 1 |
36 | 65 | ammo: |
37 | | - ammo5: 50 |
38 | | - ammo7: 50 |
39 | | - ammo9: 50 |
| 66 | + ammo5: 0 |
| 67 | + ammo7: 0 |
| 68 | + ammo9: 10 |
40 | 69 | ammo12: 0 |
41 | 70 | ammo44: 0 |
42 | | -``` |
43 | | -
|
44 | | -### Role Information |
45 | | -```yml |
46 | | -# The Name of the Role that other plugins use |
47 | | -name: ExampleRole |
48 | | -# The ID of the Role (you can set your class with setclass {playerid} {Roleid}) |
49 | | -roleID: 25 |
50 | | -# The Team of the Role (see https://docs.synapsesl.xyz/resources#teams). You can also use your own IDs to create a own Team |
51 | | -teamID: 0 |
52 | | -# The Team IDs of the enemies that must be defeated or else the round can't end |
53 | | -enemies: |
54 | | -- 0 |
55 | | -# The Team IDs that the role can't hurt |
56 | | -friends: |
57 | | -- 0 |
58 | | -``` |
59 | | -
|
60 | | -### Display |
61 | | -```yml |
62 | | -# The skin that the role use (https://docs.synapsesl.xyz/resources#roles) |
63 | | -spawnrole: ClassD |
64 | | -# The Role the Player will become after Escaping |
65 | | -# -1 is None |
66 | | -escapeRole: -1 |
67 | | -# The amount of Health the Role spawns with |
68 | | -spawnHealth: 100 |
69 | | -# The max amount of Health the Role can have |
70 | | -maxHealth: 100 |
71 | | -# The Text that should be displayed when looking at the player of this Role |
72 | | -displayInfo: <color=green>Example</color> |
73 | | -# If the Role name should be removed. For Example Class-D, which can be usefull in combination with displaInfo |
74 | | -removeRoleName: true |
75 | | -``` |
76 | | -
|
77 | | -### SpawnMessage |
78 | | -```yml |
79 | | -# The amount of Time the Broadcast/Hint should be displayed |
| 71 | +#When enabled will a Custom Display generated that shows the Custom Role Name instead of the vanilla one |
| 72 | +customDisplay: true |
| 73 | +#When enabled the Role will display it's unit in the custom display |
| 74 | +hierarchy: false |
| 75 | +#When enabled will the unit in the Custom Display be a custom one |
| 76 | +useCustomUnitName: false |
| 77 | +#See above |
| 78 | +customUnitName: '' |
| 79 | +#A list of teams that can see the unit |
| 80 | +teamsThatCanSeeUnit: [] |
| 81 | +scale: |
| 82 | + x: 1 |
| 83 | + y: 1 |
| 84 | + z: 1 |
| 85 | +godMode: false |
| 86 | +#Additional Info that will be added to the Display |
| 87 | +displayInfo: Test |
80 | 88 | spawnMessageTime: 5 |
81 | | -# The Broadcast that should be displayed |
82 | 89 | spawnBroadcast: '' |
83 | | -# The Hint that should be displayed |
84 | | -spawnHint: '' |
85 | | -# The content of the Window that appear when spawning |
| 90 | +spawnHint: Hello |
86 | 91 | spawnWindow: '' |
87 | | -``` |
| 92 | +#The chance for each player that he will spawn as this role |
| 93 | +setPlayerAtRoundStartChance: 0 |
| 94 | +#When enabled will one Scp spawn less upon this role being spawned |
| 95 | +spawnOneScpLessOnSpawn: false |
| 96 | +# left side the Role Id and Right side the chance |
| 97 | +# this will replace the role on the left upon Respawn |
| 98 | +respawnReplace: |
| 99 | + 12: 0 |
| 100 | +maxSpawnAmount: 10 |
| 101 | +maxRespawnAmount: 10 |
| 102 | +maxAmount: 5 |
88 | 103 |
|
89 | | -## Spawn |
90 | | -```yml |
91 | | -# The locations where the role can spawn (remove it for default spawns) |
92 | | -spawns: |
93 | | -- room: EZ_Shelter |
94 | | - x: 0 |
95 | | - y: 2 |
96 | | - z: 0 |
97 | | -- room: EZ_Shelter |
98 | | - x: 2 |
99 | | - y: 2 |
100 | | - z: 0 |
101 | | -# This replace a Role at the start of the Round with the Custom Role |
102 | | -# The first value (here 0 which would be SCP-173) is the Role that is going to be replaced and the second value is the chance that the role will be replaced with the custom one |
103 | | -roundStartReplace: |
104 | | - 0: 100 |
105 | | -# The same than roundStartReplace except with a Team respawn.(Chaos / MTF Respawn) |
106 | | -respawnReplace: ::lsb::::rsb:: |
107 | | -# The max amount of this custom role that can spawn at the beginning of the round |
108 | | -maxSpawnAmount: -1 |
109 | | -# The max amount of this custom role that can respawn in one respawn |
110 | | -maxRespawnAmount: -1 |
111 | | -# The max Amount of this role that can ever exist (you can still forceclass yourself to the role) |
112 | | -maxAmount: -1 |
| 104 | +[Scp] |
| 105 | +scpAttackDamage: 200 |
| 106 | +scp106TakeIntoPocket: true |
| 107 | + |
| 108 | +[Advanced] |
| 109 | +commandToExecuteAtSpawn: |
| 110 | +- pbc %player% 5 Hello |
| 111 | +commandToExecuteAtDeSpawn: |
| 112 | +- pbc %player% %playername% you are now dead |
113 | 113 | ``` |
0 commit comments