Update README

7c7de3d9650645acac1a3d90207d06dc88dac218

Cohee <18619528+Cohee1207@users.noreply.github.com>

Parents: 02cdec5a10ae886aff84896d485738213331c2ba
1 files changed, +47 -23Ignore whitespace
.github/readme.md+47 -23
@@ -317,29 +317,34 @@ Start.bat --port 8000 --listen false
317317
318318### Supported arguments
319319
320-| Option | Description | Type |
320+> \[!TIP]
321-|-------------------------|------------------------------------------------------------------------------------------------------|----------|
321+> None of the arguments are required. If you don't provide them, SillyTavern will use the settings in `config.yaml`.
322-| `--version` | Show version number | boolean |
322+
323-| `--enableIPv6` | Enables IPv6. | boolean |
323+| Option | Description | Type |
324-| `--enableIPv4` | Enables IPv4. | boolean |
324+|-------------------------|----------------------------------------------------------------------|----------|
325-| `--port` | Sets the port under which SillyTavern will run. If not provided falls back to yaml config 'port'. | number |
325+| `--version` | Show version number | boolean |
326-| `--dnsPreferIPv6` | Prefers IPv6 for dns. If not provided falls back to yaml config 'preferIPv6'. | boolean |
326+| `--dataRoot` | Root directory for data storage | string |
327-| `--autorun` | Automatically launch SillyTavern in the browser. If not provided falls back to yaml config 'autorun'.| boolean |
327+| `--port` | Sets the port under which SillyTavern will run | number |
328328| `--autorunHostnamelisten` | The autorunSillyTavern hostname,will probablylisten beston leftall onnetwork 'auto'. interfaces | string boolean |
329329| `--autorunPortOverridewhitelist` | Overrides the portEnables forwhitelist autorun. mode | string boolean |
330-| `--listen` | SillyTavern is listening on all network interfaces. If not provided falls back to yaml config 'listen'.| boolean |
330+| `--basicAuthMode` | Enables basic authentication | boolean |
331331| `--corsProxyenableIPv4` | Enables CORS proxy. If not provided falls back to yaml configIPv4 'enableCorsProxy'. protocol | boolean |
332332| `--disableCsrfenableIPv6` | DisablesEnables CSRFIPv6 protection protocol | boolean |
333333| `--ssllistenAddressIPv4` | EnablesSpecific SSL IPv4 address to listen to | boolean string |
334334| `--certPathlistenAddressIPv6` | PathSpecific toIPv6 youraddress certificateto file. listen to | string |
335335| `--keyPathdnsPreferIPv6` | Path to yourPrefers privateIPv6 keyfor file. DNS | string boolean |
336336| `--whitelistssl` | Enables whitelist mode SSL | boolean |
337337| `--dataRootcertPath` | RootPath directoryto foryour datacertificate storage file | string |
338338| `--avoidLocalhostkeyPath` | Avoids using 'localhost'Path forto autorunyour inprivate autokey mode. file | boolean string |
339339| `--basicAuthModeautorun` | EnablesAutomatically basiclaunch authentication SillyTavern in the browser | boolean |
340-| `--requestProxyEnabled` | Enables a use of proxy for outgoing requests | boolean |
340+| `--autorunHostname` | Autorun hostname | string |
341341| `--requestProxyUrlautorunPortOverride` | Request proxy| URLOverrides (HTTPthe orport SOCKSfor protocols) autorun | string |
342342| `--requestProxyBypassavoidLocalhost` | Request proxyAvoids bypassusing list'localhost' (spacefor separatedautorun listin ofauto hosts) mode | array boolean |
343+| `--corsProxy` | Enables CORS proxy | boolean |
344+| `--requestProxyEnabled` | Enables a use of proxy for outgoing requests | boolean |
345+| `--requestProxyUrl` | Request proxy URL (HTTP or SOCKS protocols) | string |
346+| `--requestProxyBypass` | Request proxy bypass list (space separated list of hosts) | array |
347+| `--disableCsrf` | Disables CSRF protection (NOT RECOMMENDED) | boolean |
343348
344349## Remote connections
345350
@@ -351,10 +356,29 @@ You may also want to configure SillyTavern user profiles with (optional) passwor
351356
352357## Performance issues?
353358
359+### General tips
360+
3543611. Disable the Blur Effect and enable Reduced Motion on the User Settings panel (UI Theme toggles category).
3553622. If using response streaming, set the streaming FPS to a lower value (10-15 FPS is recommended).
3563633. Make sure the browser is enabled to use GPU acceleration for rendering.
357364
365+### Input lag
366+
367+Performance degradation, particularly input lag, is most commonly attributed to browser extensions. Known problematic extensions include:
368+
369+* iCloud Password Manager
370+* DeepL Translation
371+* AI-based grammar correction tools
372+* Various ad-blocking extensions
373+
374+If you experience performance issues and cannot identify the cause, or suspect an issue with SillyTavern itself, please:
375+
376+1. [Record a performance profile](https://developer.chrome.com/docs/devtools/performance/reference)
377+2. Export the profile as a JSON file
378+3. Submit it to the development team for analysis
379+
380+We recommend first testing with all browser extensions and third-party SillyTavern extensions disabled to isolate the source of the performance degradation.
381+
358382## License and credits
359383
360384**This program is distributed in the hope that it will be useful,