Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Docs/Reference/Index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,12 @@ Every documented source file (210 total), alphabetical by path. See the [TOC](TO
| [Quasar/Components/Pages/Chat.razor](files/Quasar/Components/Pages/Chat.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | Routable page (`/chat`) that gives admins a full-width chat and command console for managed servers. It combines a server dropdown, live recent-chat feed from the selected agent snapshot, a chat/command input that sends text through `ServerCommandType.SendChat`, command-mode autocomplete sourced from registered PluginSdk commands, quick Refresh/Save/Restart actions, and recent command-result feedback. Server-authored chat (`IsServerMessage`, SteamId 0, `Good.bot`, or `Server`) is displayed as `Server`. |
| [Quasar/Components/Pages/ConfigProfilePendingChangesDialog.razor](files/Quasar/Components/Pages/ConfigProfilePendingChangesDialog.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | Small confirmation dialog displayed by `Configs.razor` when the user tries to switch config templates while the current template has unsaved edits. Returns a `PendingChangesAction` discriminated union (Cancel, Discard, Save) to let the caller decide how to handle the pending state. |
| [Quasar/Components/Pages/ConfigProfileQuickCreateDialog.razor](files/Quasar/Components/Pages/ConfigProfileQuickCreateDialog.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | Modal dialog for quickly creating a new `QuasarConfigProfile` (config template) from the Home dashboard setup wizard. Validates that a name is provided, persists the new profile via `QuasarConfigProfileCatalog`, and returns the created `QuasarConfigProfile` to the caller on success. |
| [Quasar/Components/Pages/Configs.razor](files/Quasar/Components/Pages/Configs.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | The `/configs` page: a full editor for reusable Magnetar config templates (`QuasarConfigProfile`) that are applied to assigned dedicated servers at startup. A sidebar lists/creates/clones/deletes templates; the main column edits World settings, Plugins, Mods, and Developer dev-folders across tabbed and collapsible panels, generating only the active tab and opened panel bodies. QoL features include searchable/jump-to world options, a refreshable plugin catalog, Steam Workshop search, world-template mod merge, dead Workshop mod cleanup, unsaved-change guarding, and integration with the plugin-manifest picker dialog for registering local dev folders. (This page has no charts; the analytics charting work lives in `Analytics.razor`.) |
| [Quasar/Components/Pages/Configs.razor](files/Quasar/Components/Pages/Configs.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | The `/configs` page: a full editor for reusable Magnetar config templates (`QuasarConfigProfile`) that are applied to assigned dedicated servers at startup. A sidebar lists/creates/restores/clones/deletes templates; the main column edits World settings, Plugins, Mods, and Developer dev-folders across tabbed and collapsible panels, generating only the active tab and opened panel bodies. QoL features include searchable/jump-to world options, a refreshable plugin catalog, Steam Workshop search, world-template mod merge, all-mod clearing, crossplay-safe profile cloning, default-profile restoration, dead Workshop mod cleanup, unsaved-change guarding, and integration with the plugin-manifest picker dialog for registering local dev folders. (This page has no charts; the analytics charting work lives in `Analytics.razor`.) |
| [Quasar/Components/Pages/Configs.razor.css](files/Quasar/Components/Pages/Configs.razor.css.md) | [Quasar.Components](Modules/Quasar.Components.md) | CSS | Scoped stylesheet for `Configs.razor`. Styles the two-column page shell (sticky template sidebar + scrollable editor), the template tiles, collapsible config/world panels, option cards (with search-highlight and focus states), workshop thumbnails, and plugin description lines. |
| [Quasar/Components/Pages/ConfigsPageDialog.razor](files/Quasar/Components/Pages/ConfigsPageDialog.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | Thin full-screen dialog wrapper that hosts the `Configs` page component. Used by the Home dashboard setup wizard to surface the config-template editor as a modal overlay without navigating away from the dashboard. |
| [Quasar/Components/Pages/Discord.razor](files/Quasar/Components/Pages/Discord.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | Routable page (`/discord`) for configuring the Quasar Discord bot. Combines global bot settings (token, guild ID, enabled flag), per-server channel bindings (command, chat-relay, log, analytics, death-messages, simspeed-alert channels plus interval and feature toggles), configurable simspeed alert rules, editable death-message template text areas organised by death-type category with a copyable template-file path, and a primary `Console Logs` button that opens the dedicated Discord integration log dialog. |
| [Quasar/Components/Pages/DiscordConsoleDialog.razor](files/Quasar/Components/Pages/DiscordConsoleDialog.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | MudBlazor dialog that displays the dedicated Discord integration log (`discord.log`). It mirrors the server console log UX with a copyable file path, full-log download button, Refresh action, exception-excerpt mode, and a scrollable monospace log pane. |
| [Quasar/Components/Pages/Entities.razor](files/Quasar/Components/Pages/Entities.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | Routable page (`/entities`) providing a live entity browser for connected Space Engineers server agents. The user selects a connected agent and entity type filter, presses Refresh to fetch up to 500 entities, then can search across the result set and delete individual entities with confirmation. Requires a live Quasar.Agent connection; shows an informational alert otherwise. |
| [Quasar/Components/Pages/Entities.razor](files/Quasar/Components/Pages/Entities.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | Routable page (`/entities`) providing a live entity browser for connected Space Engineers server agents. The user selects a connected agent and entity type filter, presses Refresh to fetch up to 500 entities, then can search across the result set and delete individual entities or a multi-selected batch with confirmation. Entity rows support normal click selection, Ctrl/Meta toggle selection, and Shift range selection. Requires a live Quasar.Agent connection; shows an informational alert otherwise. |
| [Quasar/Components/Pages/Error.razor](files/Quasar/Components/Pages/Error.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | Standard ASP.NET Core error page rendered at `/Error`. Displays a generic error message and, when a request or activity ID is available, shows it for diagnostics. Advises enabling the Development environment for detailed exceptions and warns against doing so in production. |
| [Quasar/Components/Pages/FolderPickerDialog.razor](files/Quasar/Components/Pages/FolderPickerDialog.razor.md) | [Quasar.Components](Modules/Quasar.Components.md) | Blazor component | General-purpose server-side folder browser dialog. Renders a navigable directory tree with breadcrumb navigation, bookmark shortcut chips, caller-supplied shortcut chips, hidden-folder toggle, quick filtering for the current folder list, and an optional world-folder validation mode. Returns the selected absolute path on confirmation. Used from `Configs.razor` (dev-folder picker), server instance editors (world-folder picker), and world-template import flows. |
| [Quasar/Components/Pages/FolderPickerDialog.razor.css](files/Quasar/Components/Pages/FolderPickerDialog.razor.css.md) | [Quasar.Components](Modules/Quasar.Components.md) | CSS | Minimal scoped stylesheet for `FolderPickerDialog.razor`. Contains a single rule that removes the default uppercase text transform from the breadcrumb navigation buttons so directory names render in their natural casing. |
Expand Down Expand Up @@ -187,7 +187,7 @@ Every documented source file (210 total), alphabetical by path. See the [TOC](TO
| [Quasar/Services/PluginSdk/PluginLogEntry.cs](files/Quasar/Services/PluginSdk/PluginLogEntry.cs.md) | [Quasar.Services.PluginSdk](Modules/Quasar.Services.PluginSdk.md) | class | Immutable record-style class representing one structured log entry produced by a plugin through the PluginSdk `QuasarLogSink`. The sink writes compact JSON lines to the dedicated server's stdout; `PluginLogStream.TryParseSinkLine` parses those lines into this type. Field shape mirrors the sink JSON: `{ timestamp, level, plugin, thread, message, data?, exception? }`. |
| [Quasar/Services/PluginSdk/PluginLogStream.cs](files/Quasar/Services/PluginSdk/PluginLogStream.cs.md) | [Quasar.Services.PluginSdk](Modules/Quasar.Services.PluginSdk.md) | class | In-memory ring buffer of recent plugin log entries keyed by server unique name, plus a static parser for the PluginSdk `QuasarLogSink` JSON stdout format. The supervisor feeds entries parsed from each dedicated server's standard output; Blazor components subscribe to `Changed` and read entries via `GetEntries`, `GetRecent`, or `Query`. Follows the same lock-guarded, event-raising shape as other Quasar runtime services. |
| [Quasar/Services/QuasarConfigMetadata.cs](files/Quasar/Services/QuasarConfigMetadata.cs.md) | [Quasar.Services.Core](Modules/Quasar.Services.Core.md) | class | Defines the full compile-time schema for every Quasar configuration option that the UI can present and edit. It declares enums for option scope (`Root`/`Session`) and kind (Boolean, Integer, Decimal, Text, LongText, Password, KeyValueText, SelectInteger, SelectText), typed record helpers for categories and select options, and a rich `QuasarConfigOptionDefinition` type with validation and full-text search. The static `QuasarConfigMetadata` class holds two read-only lists — `Categories` (12 groupings, including Survival) and `Options` (covering Quasar root settings plus DS-visible session settings, including block type limits) — and provides reflection-based property lookup and value formatting helpers used by the config editor UI. |
| [Quasar/Services/QuasarConfigProfileCatalog.cs](files/Quasar/Services/QuasarConfigProfileCatalog.cs.md) | [Quasar.Services.Core](Modules/Quasar.Services.Core.md) | class | Manages the persistent catalog of named Quasar configuration profiles (reusable bundles of root/session settings, plugin selections, and mod lists). Profiles are stored as individual `profile.json` files under `<QuasarDir>/ConfigProfiles/<id>/`. The catalog watches the directory for external edits, debounces reload events, keeps versioned history on every save, and fires a `Changed` event when the in-memory state diverges from disk. |
| [Quasar/Services/QuasarConfigProfileCatalog.cs](files/Quasar/Services/QuasarConfigProfileCatalog.cs.md) | [Quasar.Services.Core](Modules/Quasar.Services.Core.md) | class | Manages the persistent catalog of named Quasar configuration profiles (reusable bundles of root/session settings, plugin selections, and mod lists). Profiles are stored as individual `profile.json` files under `<QuasarDir>/ConfigProfiles/<id>/`. The catalog watches the directory for external edits, debounces reload events, keeps versioned history on every save, can recreate/reset Quasar's built-in starter profiles, and fires a `Changed` event when the in-memory state diverges from disk. |
| [Quasar/Services/QuasarDevFolderCatalog.cs](files/Quasar/Services/QuasarDevFolderCatalog.cs.md) | [Quasar.Services.Core](Modules/Quasar.Services.Core.md) | class | Manages a persisted list of local developer plugin folders used during plugin development. Each entry (`QuasarDevFolderSelection`) maps a folder path and plugin manifest data file to an optional plugin-id override and debug-build flag, which defaults to `true` for new or legacy entries without an explicit value. The catalog loads from and saves to a single `dev-folders.json` file in the Quasar data directory, and fires a `Changed` event after every mutation. |
| [Quasar/Services/QuasarLoggingConfigurator.cs](files/Quasar/Services/QuasarLoggingConfigurator.cs.md) | [Quasar.Services.Core](Modules/Quasar.Services.Core.md) | class | Static configurator that wires NLog into the ASP.NET Core host at startup. It builds an NLog `LoggingConfiguration` with the main Quasar file target, a dedicated Discord integration file target, and an optional console target (activated when `QUASAR_CONSOLE_LOGGING=true`), then replaces the default Microsoft logging providers with NLog via `UseNLog()`. |
| [Quasar/Services/QuasarPluginCatalogService.cs](files/Quasar/Services/QuasarPluginCatalogService.cs.md) | [Quasar.Services.Core](Modules/Quasar.Services.Core.md) | class | Maintains the in-memory catalog of available Quasar plugins, sourced from the MagnetarHub GitHub repository (downloaded as a ZIP archive, parsed from XML manifests) and supplemented at runtime by local developer-folder entries. The catalog is cached to disk with a schema-versioned JSON file and can be refreshed on demand. It also exposes helper utilities for URL construction and plugin-id resolution. |
Expand Down
Loading
Loading