Skip to content

Commit 36ae75f

Browse files
authored
docs: add default creation of config.json, update example JSON (#11)
1 parent ff64327 commit 36ae75f

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ and explicitly triggers an additional garbage collection if it is highly likely
4141
Place the plugin JAR into your server's `mods/` folder.
4242

4343
### Configuration
44-
The plugin is configured via a JSON configuration file at `mods/Nitrado_PerformanceSaver/config.json`. You will need to
45-
create the file and directory.
44+
The plugin is configured via a JSON configuration file at `mods/Nitrado_PerformanceSaver/config.json`. If the file does
45+
not exist, it will be automatically created with default values on first startup.
4646

4747
Below are all available configuration sections and their options.
4848

@@ -100,29 +100,18 @@ Triggers JVM garbage collection when chunk unloading indicates memory can be fre
100100
| Option | Type | Default | Description |
101101
|---------------------------------|---------|---------|--------------------------------------------------------|
102102
| `Enabled` | boolean | `true` | Enable/disable chunk-based GC triggering |
103-
| `MinChunkCount` | integer | `128` | Minimum chunk count before GC triggering is considered |
104103
| `ChunkDropRatioThreshold` | double | `0.8` | Chunk reduction ratio threshold to trigger GC |
104+
| `MinChunkCount` | integer | `128` | Minimum chunk count before GC triggering is considered |
105105
| `GarbageCollectionDelaySeconds` | integer | `300` | Minimum time between triggered GC runs |
106106
| `InitialDelaySeconds` | integer | `5` | Delay before chunk GC monitoring starts |
107107
| `CheckIntervalSeconds` | integer | `5` | How often to check chunk counts |
108-
| `InitialDelaySeconds` | integer | `5` | Delay before chunk GC monitoring starts |
109-
| `CheckIntervalSeconds` | integer | `5` | How often to check chunk counts |
110108

111109
### Full Configuration Example
112110

113111
Below is a complete `mods/Nitrado_PerformanceSaver/config.json` file with all default values:
114112

115113
```json
116114
{
117-
"Tps": {
118-
"Enabled": true,
119-
"TpsLimit": 20,
120-
"TpsLimitEmpty": 5,
121-
"OnlyWorlds": [],
122-
"InitialDelaySeconds": 30,
123-
"CheckIntervalSeconds": 5,
124-
"EmptyLimitDelaySeconds": 300
125-
},
126115
"ViewRadius": {
127116
"Enabled": true,
128117
"MinViewRadius": 2,
@@ -131,6 +120,7 @@ Below is a complete `mods/Nitrado_PerformanceSaver/config.json` file with all de
131120
"InitialDelaySeconds": 30,
132121
"CheckIntervalSeconds": 5,
133122
"RecoveryWaitTimeSeconds": 60,
123+
"RequireNotifyPermission": false,
134124
"GcMonitor": {
135125
"Enabled": true,
136126
"HeapThresholdRatio": 0.85,
@@ -147,11 +137,20 @@ Below is a complete `mods/Nitrado_PerformanceSaver/config.json` file with all de
147137
},
148138
"ChunkGarbageCollection": {
149139
"Enabled": true,
150-
"MinChunkCount": 128,
151140
"ChunkDropRatioThreshold": 0.8,
141+
"MinChunkCount": 128,
152142
"GarbageCollectionDelaySeconds": 300,
153143
"InitialDelaySeconds": 5,
154144
"CheckIntervalSeconds": 5
145+
},
146+
"Tps": {
147+
"Enabled": true,
148+
"TpsLimit": 20,
149+
"TpsLimitEmpty": 5,
150+
"OnlyWorlds": [],
151+
"InitialDelaySeconds": 30,
152+
"CheckIntervalSeconds": 5,
153+
"EmptyLimitDelaySeconds": 300
155154
}
156155
}
157156
```

0 commit comments

Comments
 (0)