|
1 | 1 | # MEROptimizer |
2 | | -[](https://github.com/MathMot/MEROptimizer/releases/latest) [](https://github.com/ExMod-Team/EXILED/releases/tag/v9.5.1) [](https://store.steampowered.com/app/700330/SCP_Secret_Laboratory/) []()<br> |
| 2 | +[](https://github.com/MathMot/MEROptimizer/releases/latest) [](https://github.com/northwood-studios/LabAPI/releases/tag/1.0.2) [](https://store.steampowered.com/app/700330/SCP_Secret_Laboratory/) []()<br> |
3 | 3 |
|
4 | 4 | --- |
5 | 5 |
|
6 | | -[SCP:Secret Laboratory](https://store.steampowered.com/app/700330/SCP_Secret_Laboratory/) plugin made for optimizing [MapEditorReborn](https://github.com/Michal78900/MapEditorReborn) schematics using the [EXILED](https://github.com/ExMod-Team/EXILED) Framework. |
| 6 | +[SCP:Secret Laboratory](https://store.steampowered.com/app/700330/SCP_Secret_Laboratory/) plugin made for optimizing [MapEditorReborn](https://github.com/Michal78900/ProjectMER)(ProjectMER for now) schematics using the [LabAPI](https://github.com/northwood-studios/LabAPI) Framework. |
7 | 7 | It works by destroying primitives for the server and sending clones of the primitives to the clients while simulating their collisions. |
8 | | -It also supports a feature to dynamicly spawn primitives around players.<br> |
| 8 | +It also supports a feature to dynamicly spawn primitives around players. |
| 9 | +It got also an API to create and handle client sided primitives (ClientSidePrimitive class).<br> |
9 | 10 | You can ask me questions on discord (matmoth) |
10 | 11 | []() |
11 | 12 |
|
@@ -42,54 +43,54 @@ You can ask me questions on discord (matmoth) |
42 | 43 |
|
43 | 44 | Setup : |
44 | 45 | -- |
45 | | -- Make sure that your SCP:SL server version(14.0.2) and EXILED version (9.5.1) are corresponding. <br> |
46 | | -- [Download](https://github.com/MathMot/MEROptimizer/releases/latest) the latest version of the plugin and place the .dll in the EXILED/Plugins folder. |
| 46 | +- Make sure that your SCP:SL server version(14.1.0) corresponds <br> |
| 47 | +- [Download](https://github.com/MathMot/MEROptimizer/releases/latest) the latest version of the plugin and place your .dll in the *LabAPI\plugins\<global/port>* folder. |
47 | 48 |
|
48 | 49 | --- |
49 | 50 |
|
50 | 51 | Configuration : |
51 | 52 | -- |
52 | 53 | Default configuration : |
53 | 54 | ```yaml |
54 | | -mero: |
55 | 55 | # If the plugin is enabled or not. |
56 | | - is_enabled: true |
57 | | - # Displays plugin debug logs. |
58 | | - debug: false |
59 | | - # |
60 | | - # -------------Global Options------------- |
61 | | - # If the primitives that will be optimized are only non collidable |
62 | | - optimize_only_non_collidable: false |
63 | | - # Prvents group of primitives to be optimized (aka keeped server sided) |
64 | | - # Simply name one of its empty parents with one of the entered name here and it will be excluded. |
65 | | - exclude_objects: [] |
66 | | - # |
67 | | - # -------------Schematic cluster splitting options------------- |
68 | | - # Could be quite hard to understand, more info in the plugin readme |
69 | | - # If enabled, splits schematics into clusters of primitives to then spawn them independently per players based on their distance to the cluster |
70 | | - clusterize_schematic: true |
71 | | - # Prevents group of primitives to be used by the clusters. Useful for skyboxs, outer walls of buildings and giant primitives that requires to be seen from far awaySimply name one of its empty parents with one of the entered names here and it will be excluded. |
72 | | - exclude_unspawning_distant_objects: [] |
73 | | - # In units, the distance required for a cluster to spawn/unspawn its primitives to the corresponding player |
74 | | - spawn_distance: 50 |
75 | | - # Adds a specific spawn distance for cluster of each entered schematics, bypassing the previously entered SpawnDistance |
76 | | - custom_schematic_spawn_distance: {} |
77 | | - # Should spectating players be also affected by the cluster systemIf enabled, when a player spectates another, it will spawn all of the primitives that the spectated player currently sees, otherwise spectators will see all of the schematics at all time |
78 | | - should_spectator_be_affected_by_distance_spawning: false |
79 | | - # Should tutorials be affected by the cluster system, if disabled, every tutorials will see all of the schematics at all time (useful for moderation stuff, etc) |
80 | | - should_tutorials_be_affected_by_distance_spawning: true |
81 | | - # Minimum size of a primitive before being considered as a big one (size = (scale.x + y + z) ) |
82 | | - # Huge objects don't work with the cluster system and so they need to be excluded, prevents having to manually exclude each walls/floors of schematics |
83 | | - # Set to zero (0) to disable it, not recommended |
84 | | - minimum_size_before_being_big_primitive: 10 |
85 | | - # For each cluster, number of primitives that'll spawn per server frame (higher count means quicker spawn but potential freezes for clients)If set to zero (0), each cluster will spawn its primitives instantly, 0.5 means 1 primitive each 2 frames, etc |
86 | | - number_of_primitive_per_spawn: 0.1 |
87 | | - # |
88 | | - # -----Clusters Options----- |
89 | | - # In units, the maximum distance between a primitive and a specific cluster to be included in it, the more distance the less cluster will spawn |
90 | | - max_distance_for_primitive_cluster: 2.5 |
91 | | - # Maximum amount of primitive per cluster, if reached, a new cluster will spawn and be used. The less primitives per cluster the more clusters will spawn |
92 | | - max_primitives_per_cluster: 100 |
| 56 | +is_enabled: true |
| 57 | +# Displays plugin debug logs. |
| 58 | +debug: false |
| 59 | +# |
| 60 | +#-------------Global Options------------- |
| 61 | +# If the primitives that will be optimized are only non collidable |
| 62 | +optimize_only_non_collidable: false |
| 63 | +# Prevents group of primitives to be optimized (aka keeped server sided) |
| 64 | +# Simply name one of its empty parents with one of the entered name here and it will be excluded. |
| 65 | +exclude_objects: [] |
| 66 | +# |
| 67 | +#-------------Schematic cluster splitting options------------- |
| 68 | +# Could be quite hard to understand, more info in the plugin readme |
| 69 | +# If enabled, splits schematics into clusters of primitives to then spawn them independently per players based on their distance to the cluster |
| 70 | +clusterize_schematic: true |
| 71 | +# Prevents group of primitives to be used by the clusters. Useful for skyboxs, outer walls of buildings and giant primitives that requires to be seen from far away# Simply name one of its empty parents with one of the entered names here and it will be excluded. |
| 72 | +exclude_unspawning_distant_objects: [] |
| 73 | +# In units, the distance required for a cluster to spawn/unspawn its primitives to the corresponding player |
| 74 | +spawn_distance: 50 |
| 75 | +# Adds a specific spawn distance for cluster of each entered schematics, bypassing the previously entered SpawnDistance |
| 76 | +custom_schematic_spawn_distance: {} |
| 77 | +# Should spectating players be also affected by the cluster systemIf enabled, when a player spectates another, it will spawn all of the primitives that the spectated player currently sees, otherwise spectators will see all of the schematics at all time |
| 78 | +should_spectator_be_affected_by_distance_spawning: false |
| 79 | +# Should tutorials be affected by the cluster system, if disabled, every tutorials will see all of the schematics at all time (useful for moderation stuff, etc) |
| 80 | +should_tutorials_be_affected_by_distance_spawning: true |
| 81 | +# Minimum size of a primitive before being considered as a big one (size = (scale.x + y + z) ) |
| 82 | +# Huge objects don't work with the cluster system and so they need to be excluded, prevents having to manually exclude each walls/floors of schematics |
| 83 | +# Set to zero (0) to disable it, not recommended |
| 84 | +minimum_size_before_being_big_primitive: 10 |
| 85 | +# For each cluster, number of primitives that'll spawn per server frame (higher count means quicker spawn but potential freezes for clients)If set to zero (0), each cluster will spawn its primitives instantly, 0.5 means 1 primitive each 2 frames, etc |
| 86 | +number_of_primitive_per_spawn: 0.100000001 |
| 87 | +# |
| 88 | +#-----Clusters Options----- |
| 89 | +#In units, the maximum distance between a primitive and a specific cluster to be included in it, the more distance the less cluster will spawn |
| 90 | +max_distance_for_primitive_cluster: 2.5 |
| 91 | +# Maximum amount of primitive per cluster, if reached, a new cluster will spawn and be used. The less primitives per cluster the more clusters will spawn |
| 92 | +max_primitives_per_cluster: 100 |
| 93 | + |
93 | 94 | ``` |
94 | 95 |
|
95 | 96 | # -------------Global Options------------- |
|
0 commit comments