You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Directories to search for components. Later entries override earlier ones on a per-file basis. Use this to add your own components or to include a git repo that provides extra components. See [Components]() to see how to create your own. -- TODO link
Path to base CSS file served to clients. This is a [Mustache](https://github.com/Olivine-Labs/lustache) template.
39
39
40
40
### RFG Icons
41
41
These two settings are only relevant if you use [RFG](controller/setIconRFG.md) icons.
42
42
43
43
#### `mintmousse.ZIP_MOUNT_LOCATION
44
-
**Type**: _string_
44
+
: **Type**: _string_
45
45
46
-
**Default**: `".MintMousse/"
46
+
**Default**: `".MintMousse/"
47
47
48
48
Directory used by `love.filesystem.mount()` when mounting ZIP archieves that contain RFG icons.
49
49
50
50
#### `mintmousse.FAVICON_PATH`
51
-
**Type**: _string_
51
+
: **Type**: _string_
52
52
53
-
**Default**: `"/favicon"`
53
+
**Default**: `"/favicon"`
54
54
55
55
HTTP endpoint where the favicon assets are served. This must match the "favicon path" you set when generating icons on the RFG website.
56
56
@@ -59,79 +59,79 @@ HTTP endpoint where the favicon assets are served. This must match the "favicon
59
59
## Network and Server Settings
60
60
61
61
### `mintmousse.SOCKET_BACKLOG`
62
-
**Type**: _number_
62
+
: **Type**: _number_
63
63
64
-
**Default**: `32`
64
+
**Default**: `32`
65
65
66
66
Maximum number of pending connections the OS will queue before refusing new ones.
67
67
68
68
### `mintmousse.MAX_HTTP_RECEIVE_SIZE`
69
-
**Type**: _number_
69
+
: **Type**: _number_
70
70
71
-
**Default**: `2^16` (65KB)
71
+
**Default**: `2^16` (65KB)
72
72
73
73
The maximum allowed size of an incoming HTTP request body. Larger requests are rejected and the limit is included in the response headers.
74
74
75
75
### `mintmousse.MAX_WEBSOCKET_FRAME_SIZE`
76
-
**Type**: _number_
76
+
: **Type**: _number_
77
77
78
-
**Default**: `2^19` (512KB)
78
+
**Default**: `2^19` (512KB)
79
79
80
80
Maximum size of a single WebSocket Frame (both incoming and outgoing).
81
81
82
82
### `mintmousse.MAX_WEBSOCKET_MESSAGE_SIZE`
83
-
**Type**: _number_
83
+
: **Type**: _number_
84
84
85
-
**Default**: `2^21` (2MB)
85
+
**Default**: `2^21` (2MB)
86
86
87
87
Maximum size of a complete WebSocket message (after reassembling fragmented frames).
88
88
89
89
### `mintmousseCACHE_CONTROL_HEADER`
90
-
**Type**: _string_
90
+
: **Type**: _string_
91
91
92
-
**Default**: `"no-store"`
92
+
**Default**: `"no-store"`
93
93
94
94
Value of the `Cache-Control` header sent for static assets. Change to something like `"public, max-age=3600"` for production.
95
95
96
96
### `mintmousse.MAX_PORT_ATTEMPTS`
97
-
**Type**: _number_
97
+
: **Type**: _number_
98
98
99
-
**Default**: `100`
99
+
**Default**: `100`
100
100
101
101
Maximum number of sequential port increments tried when `autoIncrement = true` is passed to [`mintmousse.start`](controller/start.md).
102
102
103
103
### `mintmousse.TIMEOUT_HTTP`
104
-
**Type**: _number_
104
+
: **Type**: _number_
105
105
106
-
**Default**: `30`
106
+
**Default**: `30`
107
107
108
108
Idle timeout for HTTP connections. A `408 Request Timeout` is sent if exceeded.
109
109
110
110
### `mintmousse.TIMEOUT_WEBSOCKET`
111
-
**Type**: _number_ (seconds)
111
+
: **Type**: _number_ (seconds)
112
112
113
-
**Default**: `60`
113
+
**Default**: `60`
114
114
115
115
Idle timeout for WebSocket connections (includes the internal heartbeat mechanism).
116
116
117
117
### `mintmousse.PING_WEBSOCKET`
118
-
**Type**: _number_ (seconds)
118
+
: **Type**: _number_ (seconds)
119
119
120
-
**Default**: `30`
120
+
**Default**: `30`
121
121
122
122
Interval between WebSocket ping frames (used for keep-alive).
123
123
124
124
### `mintmousse.COMPONENT_PARSE_TIMEOUT`
125
-
**Type**: _number_ (seconds)
125
+
: **Type**: _number_ (seconds)
126
126
127
-
**Default**: `3`
127
+
**Default**: `3`
128
128
129
129
Maximum time to wait for component type parsing. If you see a timeout warning, increase this value or use the preload script.
130
130
131
131
### `mintmousse.REPLACE_DEFAULT_ERROR_HANDLER`
132
-
**Type**: _boolean_
132
+
: **Type**: _boolean_
133
133
134
-
**Default**: `true`
134
+
**Default**: `true`
135
135
136
136
If `true`, MintMousse replaces Love’s default error handler with its own (adds better logging and cleaned-up stack traces).
137
137
@@ -140,80 +140,80 @@ If `true`, MintMousse replaces Love’s default error handler with its own (adds
140
140
## Logging Settings
141
141
142
142
### `mintmousse.LOG_ENABLED_TIMESTAMP`
143
-
**Type**: _boolean_
143
+
: **Type**: _boolean_
144
144
145
-
**Default**: `true`
145
+
**Default**: `true`
146
146
147
147
Prefix every log with a timestamp.
148
148
149
149
### `mintmousse.LOG_TIMESTAMP_FORMAT`
150
-
**Type**: _string_
150
+
: **Type**: _string_
151
151
152
-
**Default**: `"%Y-%m-%d %H:%M:%S.%f"`
152
+
**Default**: `"%Y-%m-%d %H:%M:%S.%f"`
153
153
154
154
Format passed to `os.date`. MintMousse adds the custom `%f` specifier (milliseconds, 3 digits padded). Performance is best when `%f` appears at the very end of the string.
155
155
156
156
### `mintmousse.LOG_ENABLE_STREAM_OUT`
157
-
**Type**: _boolean_
157
+
: **Type**: _boolean_
158
158
159
-
**Default**: `true`
159
+
**Default**: `true`
160
160
161
161
Enable logging to `io.stdout` / `io.stderr` (behaves like the global `print`). Automatically strips ANSI colours when the stream is redirected to a file.
162
162
163
163
### `mintmousse.LOG_ENABLE_ERROR`
164
-
**Type**: _boolean_
164
+
: **Type**: _boolean_
165
165
166
-
**Default**: `true`
166
+
**Default**: `true`
167
167
168
168
When `logger:error()` is called, also call the global `error()` function.
169
169
170
170
### `mintmousse.LOG_INCLUDE_TRACE`
171
-
**Type**: _boolean_
171
+
: **Type**: _boolean_
172
172
173
-
**Default**: `false`
173
+
**Default**: `false`
174
174
175
175
Include debug info (`function@file:line`) in all log message levels. Has a noticeable performance cost with each lookup.
176
176
177
177
### `mintmousse.LOG_WARNINGS_CAUSE_ERRORS`
178
-
**Type**: _boolean_
178
+
: **Type**: _boolean_
179
179
180
-
**Default**: `false`
180
+
**Default**: `false`
181
181
182
182
If `true`, warning logs are promoted to error logs.
183
183
184
184
### `mintmousse.LOG_WARNINGS_INCLUDE_TRACE`
185
-
**Type**: _boolean_
185
+
: **Type**: _boolean_
186
186
187
-
**Default**: `false`
187
+
**Default**: `false`
188
188
189
189
Include trace information on warning logs (does not effect other log levels).
190
190
191
191
### `mintmousse.REPLACE_FUNC_PRINT`
192
-
**Type**: _boolean_
192
+
: **Type**: _boolean_
193
193
194
-
**Default**: `true`
194
+
**Default**: `true`
195
195
196
196
Replaces the global function `print` with `logger:debug`. The original `print` is still available as `GLOBAL_print` (but it isn't considered thread-safe).
197
197
198
198
### `mintmousse.LOG_CLEAR_UP_TRACEBACK`
199
-
**Type**: _boolean_
199
+
: **Type**: _boolean_
200
200
201
-
**Default**: `true`
201
+
**Default**: `true`
202
202
203
203
Clean internal MintMousse and Love calls from the traceback shown by [`MintMousse.logUncaughtError`](logging/logUncaughtError.md). It doesn't effect the public [`MintMousse.cleanupTraceback`](logging/cleanupTraceback.md) function.
204
204
205
205
206
206
### `mintmousse.LOG_BUFFER_SIZE`
207
-
**Type**: _number_
207
+
: **Type**: _number_
208
208
209
-
**Default**: `2^20` (1MB)
209
+
**Default**: `2^20` (1MB)
210
210
211
211
Size of the stdout buffer. Increase if you see garbled/interleaved output, or call [`mintmousse.flushLogs`](logging/flushLogs.md) more often.
212
212
213
213
### `mintmousse.LOG_MAX_PENDING_LOGS_PER_FLUSH`
214
-
**Type**: _number_
214
+
: **Type**: _number_
215
215
216
-
**Default**: `512`
216
+
**Default**: `512`
217
217
218
218
Maximum number of logs the global sinks will process in a single call to [`mintmousse.flushLogs`](logging/flushLogs.md) (only runs on the main thread).
219
219
@@ -223,16 +223,16 @@ Maximum number of logs the global sinks will process in a single call to [`mintm
223
223
You probably won't need to change these unless you have very specific performance requirements.
224
224
225
225
### `mintmousse.MAX_THREAD_MESSAGES`
226
-
**Type**: _number_
226
+
: **Type**: _number_
227
227
228
-
**Default**: `100`
228
+
**Default**: `100`
229
229
230
230
Maximum commands the MintMousse thread will process in one loop iteration.
231
231
232
232
### `mintmousse.THREAD_SLEEP`
233
-
**Type**: _number_ (seconds)
233
+
: **Type**: _number_ (seconds)
234
234
235
-
**Default**: `1e-4` (0.0001s)
235
+
**Default**: `1e-4` (0.0001s)
236
236
237
237
sleep time between thread loop iterations. Increase to reduce CPU usage, decrease if the thread feels sluggish.
0 commit comments