> ## Documentation Index
> Fetch the complete documentation index at: https://catalyst.leifiyo.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Catalyst documentation

> Run, tune, back up, and inspect Minecraft servers from one desktop app.

Catalyst is a desktop control room for Minecraft servers. It creates servers, starts and stops them, streams the console, edits properties and files, installs Modrinth content, manages backups, exposes tunnels with ngrok, and reads live analytics from the bundled CatalystAnalytics plugin.

<Columns cols={2}>
  <Card title="Create your first server" icon="server" href="/docs/quickstart">
    Pick a Minecraft version, choose Paper, Purpur, Fabric, or Vanilla, assign memory, and launch.
  </Card>

  <Card title="Install Modrinth content" icon="package-plus" href="/docs/guides/modrinth-content">
    Browse compatible plugins and mods, install dependencies, and update installed projects.
  </Card>

  <Card title="Read live analytics" icon="chart-no-axes-combined" href="/docs/guides/analytics">
    Track players, TPS, memory, joins, deaths, client brands, versions, and activity over time.
  </Card>

  <Card title="Develop Catalyst" icon="code-2" href="/docs/developers/architecture">
    Understand the Electron process model, IPC bridge, renderer routes, and build workflow.
  </Card>
</Columns>

<Info>
  Catalyst stores server data in the operating system app-data directory, not inside the application install folder. Server records, worlds, backups, analytics, and managed Java runtimes stay under the user profile.
</Info>

## What Catalyst covers

<Tabs>
  <Tab title="Daily server work">
    * Create Paper, Purpur, Fabric, or Vanilla servers.
    * Accept the Minecraft EULA from the server detail page.
    * Start, stop, restart, and send console commands.
    * Edit `server.properties` without opening a text editor.
    * Open, rename, duplicate, delete, and quick-edit server files.
  </Tab>

  <Tab title="Operations">
    * Create manual backups and configure automatic backups.
    * Restore backups while the server is stopped.
    * Export and import server archives with a manifest.
    * Expose servers through ngrok TCP tunnels.
    * Use the shutdown warning to avoid closing Catalyst while servers are still running.
  </Tab>

  <Tab title="Insights">
    * Use CatalystAnalytics on Paper and Purpur servers.
    * Read online players, peak online, playtime, joins, deaths, kills, chat, commands, TPS, MSPT, and memory.
    * Compare client versions, client brands, and active hours.
    * Poll analytics while the server is running without opening the server folder.
  </Tab>
</Tabs>

## Process overview

```mermaid theme={null}
graph LR
  R[Renderer UI] --> P[Preload bridge]
  P --> M[Electron main process]
  M --> S[Server files]
  M --> J[Java runtimes]
  M --> N[Modrinth and ngrok]
  M --> B[Backup worker]
  S --> A[CatalystAnalytics data]
```

The renderer never reaches Node.js APIs directly. All app actions go through `window.context.*`, the preload bridge forwards them with IPC, and the main process performs file, Java, Modrinth, ngrok, and backup work.