Wiki: document every Slipstream interface + a curated debug-settings reference #415

New issue

Open

opened 2026-10-05 09:14:09 +00:00 by sky_line · 0 comments

sky_line commented

2026-10-05 09:14:09 +00:00

Owner

Expand the Slipstream wiki (slipstream-website/wiki/docs/, published at slipstreamviewer.org/wiki) so it documents every interface in Slipstream plus the debug settings that are actually useful.

Where it is today

12 pages, ~620 lines: index, install, verify, building, contributing, crash-reports, reporting-bugs, faq, troubleshooting, features, graphics, settings.
graphics.md covers presets, shadows, RT, upscaling/AA, reflections, terrain, FPS/VSync and HiDPI.
settings.md is a partial settings reference.
The viewer has ~233 floaters plus the preference panels, sidebars, menus and HUD-level UI. Most of them are undocumented, and so is the Slipstream-specific behaviour that differs from LL / Firestorm.

Scope

1. Every interface

One page (or section) per area, each with: what it's for, how to open it (menu path / shortcut), what every control does, and Slipstream-specific notes. Areas:

Preferences: every tab (General, Chat (incl. Chat Bar), Move & View, Sound & Media, Graphics + Advanced Graphics (every control, incl. Maximum video memory and its readout, texture memory mode, texture compression, RT, probes, upscaling), Privacy (incl. the Discord tab), Advanced (caches incl. sound cache and GPU texture cache, hover tips), Notifications, Colours, etc.
World and building: Build/Edit tools (incl. Pivot at root prim, HUD edit zoom), Object/Features/Texture/Content tabs, the LOD info panel, alignment tool, Poser, Lightbox (Look/Lens/Scene/Sky/Cam), environment/EEP editors, Area Search, mini/world map, Radar / People (incl. region enter/leave chat alerts).
Avatar and appearance: Appearance / outfits (incl. outfit folders), wearables editing, Refresh Animations, avatar render settings (jellydoll / complexity / Do Not Render), gestures and Gesture Sets.
Communication: conversations / nearby chat, IMs and groups, mouselook chat window, voice settings and voice troubleshooting (WebRTC), the Firestorm chat importer.
Inventory: inventory and inventory settings (double-click / clothing add behaviour), search and filters.
Media and audio: parcel music and media (GStreamer requirements on Linux), the built-in browser (CEF).
RLVa: what's supported, and the Slipstream-specific bits (forced logout, @setsphere).
Help / bug reporting: the in-viewer bug reporter and what it sends.

2. Useful debug settings

A curated reference (not a dump of settings.xml): name, what it does, default, live or needs restart, and when you'd use it. Grouped as:

Performance / memory: RenderMaxVideoMemoryMB, RenderVKDebugFakeVramBudgetMB, RenderVKTextureSuballoc + texture pool settings, RenderVKUITexIdleSec, SlipstreamGpuTexCache / size, SlipstreamTextureMemoryMode, SlipstreamSoundCacheSizeMB, FPS limits, and how to read the VRAM breakdown: / UI VRAM: log lines.
Rendering diagnosis: RenderVKDebugView (every value), RenderVKDebugUnresolvedTint, RenderVKLitDebugMask, RenderVKEmissivePendingGate, glow / shadow / RT toggles.
Camera / input: ClickOnAvatarKeepsCamera, the TPS camera settings, PushToTalkToggle, FSBlockClickSit, SlipstreamTurnToSelection, EnableSelectionHints.
Logging and support: log locations (native / Flatpak), useful log tags, and what to attach to a bug report.
Mark which settings are for diagnosis only (e.g. fake budgets, debug views), so users don't leave them on.

Approach

Generate a skeleton from the code: walk the floater / panel XUI (skins/default/xui/en/), menu files and settings.xml comments to list every interface, control and setting. Then write the human text per page; don't publish raw generated text.
Screenshots where they help, taken in the Slipstream skin.
Keep pages task-oriented ("how do I…") with a reference section underneath.
Add a "this page was last checked against version X" footer so drift is visible.
A CI or script check that flags settings / floaters added to the viewer with no wiki entry would keep it current.

Done when

Every preference tab and every user-facing floater / panel has a wiki entry.
A curated debug-settings reference with the groups above.
Navigation / index updated and the pages linked from the in-viewer Help where applicable.
A drift check (script or checklist) so new UI and settings get documented.

Expand the Slipstream wiki (`slipstream-website/wiki/docs/`, published at slipstreamviewer.org/wiki) so it documents **every interface in Slipstream** plus the **debug settings that are actually useful**. ## Where it is today - 12 pages, ~620 lines: index, install, verify, building, contributing, crash-reports, reporting-bugs, faq, troubleshooting, features, graphics, settings. - `graphics.md` covers presets, shadows, RT, upscaling/AA, reflections, terrain, FPS/VSync and HiDPI. - `settings.md` is a partial settings reference. - The viewer has **~233 floaters** plus the preference panels, sidebars, menus and HUD-level UI. Most of them are undocumented, and so is the Slipstream-specific behaviour that differs from LL / Firestorm. ## Scope ### 1. Every interface One page (or section) per area, each with: what it's for, how to open it (menu path / shortcut), what every control does, and Slipstream-specific notes. Areas: - **Preferences:** every tab (General, Chat (incl. Chat Bar), Move & View, Sound & Media, Graphics + **Advanced Graphics** (every control, incl. Maximum video memory and its readout, texture memory mode, texture compression, RT, probes, upscaling), Privacy (incl. the Discord tab), Advanced (caches incl. sound cache and GPU texture cache, hover tips), Notifications, Colours, etc. - **World and building:** Build/Edit tools (incl. Pivot at root prim, **HUD edit zoom**), Object/Features/Texture/Content tabs, the LOD info panel, alignment tool, Poser, Lightbox (Look/Lens/Scene/Sky/Cam), environment/EEP editors, Area Search, mini/world map, Radar / People (incl. region enter/leave chat alerts). - **Avatar and appearance:** Appearance / outfits (incl. **outfit folders**), wearables editing, **Refresh Animations**, avatar render settings (jellydoll / complexity / Do Not Render), gestures and **Gesture Sets**. - **Communication:** conversations / nearby chat, IMs and groups, **mouselook chat window**, voice settings and voice troubleshooting (WebRTC), the Firestorm chat importer. - **Inventory:** inventory and inventory settings (double-click / clothing add behaviour), search and filters. - **Media and audio:** parcel music and media (GStreamer requirements on Linux), the built-in browser (CEF). - **RLVa:** what's supported, and the Slipstream-specific bits (forced logout, @setsphere). - **Help / bug reporting:** the in-viewer bug reporter and what it sends. ### 2. Useful debug settings A curated reference (not a dump of settings.xml): name, what it does, default, live or needs restart, and when you'd use it. Grouped as: - **Performance / memory:** `RenderMaxVideoMemoryMB`, `RenderVKDebugFakeVramBudgetMB`, `RenderVKTextureSuballoc` + texture pool settings, `RenderVKUITexIdleSec`, `SlipstreamGpuTexCache` / size, `SlipstreamTextureMemoryMode`, `SlipstreamSoundCacheSizeMB`, FPS limits, and how to read the `VRAM breakdown:` / `UI VRAM:` log lines. - **Rendering diagnosis:** `RenderVKDebugView` (every value), `RenderVKDebugUnresolvedTint`, `RenderVKLitDebugMask`, `RenderVKEmissivePendingGate`, glow / shadow / RT toggles. - **Camera / input:** `ClickOnAvatarKeepsCamera`, the TPS camera settings, `PushToTalkToggle`, `FSBlockClickSit`, `SlipstreamTurnToSelection`, `EnableSelectionHints`. - **Logging and support:** log locations (native / Flatpak), useful log tags, and what to attach to a bug report. - Mark which settings are **for diagnosis only** (e.g. fake budgets, debug views), so users don't leave them on. ## Approach - Generate a skeleton from the code: walk the floater / panel XUI (`skins/default/xui/en/`), menu files and `settings.xml` comments to list every interface, control and setting. Then write the human text per page; don't publish raw generated text. - Screenshots where they help, taken in the Slipstream skin. - Keep pages task-oriented ("how do I…") with a reference section underneath. - Add a "this page was last checked against version X" footer so drift is visible. - A CI or script check that flags settings / floaters added to the viewer with no wiki entry would keep it current. ## Done when - [ ] Every preference tab and every user-facing floater / panel has a wiki entry. - [ ] A curated debug-settings reference with the groups above. - [ ] Navigation / index updated and the pages linked from the in-viewer Help where applicable. - [ ] A drift check (script or checklist) so new UI and settings get documented.

sky_line added the

label

2026-10-05 09:14:09 +00:00

sky_line referenced this issue

2026-10-05 09:15:27 +00:00

Flatpak: import settings/data from a native (tarball/.deb/AUR) Slipstream install #416

sky_line referenced this issue

2026-10-05 10:41:26 +00:00

Link the Slipstream wiki from the viewer: Help menu + visible entry point; stretch: per-window "?" opens the matching wiki page #420

sky_line referenced this issue

2026-10-05 11:03:24 +00:00

Dead graphics controls under Vulkan (Post process quality, Max. nearby lights, Sky, HDR and Emissive...): wire up or remove #423