DOCSEARCHbyAlgolia
Submit Docs

Druid Documentation

website·Indexed 31 days ago

https://docs.druid.gg

Documentation for Druid, a game server hosting platform featuring Smart Deployments and the druid-cli. Includes guides on using Scrolls (OCI artifacts for application deployment), the DruidUI React-like framework that compiles to WebAssembly, and API references for managing procedures, consoles, and ports.

Tokens
11.3K
Snippets
87
Records
129
Agent score
52%

What's inside Druid

  1. Overview of druid-cli

    druid-cli is an open-source tool used for process managing and process insight. It manages processes via 'scrolls', which are OCI artifacts stored in registries. While it can be run on bare metal for simple setups, using a container is recommended to ensure all process conditions are met.

  2. Overview of Druid CLI

    Druid CLI (Version 0.1.0) is a process runner designed to launch and manage various types of applications, including gameservers, databases, and webservers.

  3. Overview of DruidUI and WebAssembly Sandboxing

    DruidUI is a React-like framework that compiles to WebAssembly (WASM) to build sandboxed user interfaces. Unlike JavaScript or iframes, WASM provides complete isolation where code can only access explicitly granted functions, making it suitable for running untrusted UI code safely.

  4. Understand Druid Smart Deployments for Minecraft

    Druid Smart Deployments optimize resource usage and cost for Minecraft servers by implementing a 'Sleepmode'. When no players are connected, the server enters Sleepmode, consuming only a tiny fraction of resources and Mana. The server automatically wakes up and allows players to connect in less than a minute once a connection request is detected.

  5. Understand the Scroll OCI artifact structure

    Scrolls are OCI artifacts that define how applications are deployed on Druid. A typical Scroll directory structure includes a main manifest (scroll.yaml), execution scripts, ColdStarter packet handlers, and plugin configurations.
    scrolls/minecraft/papermc/1.21.7/
├── scroll.yaml              # Main manifest
├── start.sh                 # Scripts
├── packet_handler/
│   └── minecraft.lua        # ColdStarter handler
└── plugins/
    └── rcon.yaml            # Plugins

  6. Understand Druid Smart Deployments for Minecraft

    Druid Smart Deployments optimize resource usage and cost for Minecraft servers. When no players are connected, the server enters 'Sleepmode,' consuming only a tiny fraction of resources and Mana (the platform's currency). When a player attempts to connect, the server automatically wakes up and becomes available in less than a minute.

  7. Understand Druid Smart Deployments for Minecraft

    Druid Smart Deployments optimize resource usage and cost for Minecraft servers. When no players are connected, the server enters 'Sleepmode,' which consumes a tiny fraction of resources and Mana (the platform's currency). When a player attempts to connect, the server automatically wakes up and starts, allowing players to join in less than a minute.

  8. Understand the ColdStarter server wake-up process

    ColdStarter reduces costs (approximately 85%) by keeping the server in a sleep state when idle. When a player attempts to connect, ColdStarter intercepts the connection, triggers the server to wake (taking 10-30 seconds), and then allows the player to connect to the running server. The server continues to appear 'online' in server browsers even while sleeping.

  9. Understand Druid Smart Deployments for Minecraft

    Druid Smart Deployments optimize resource usage and cost for Minecraft servers. When no players are connected, the server enters 'Sleepmode,' consuming only a tiny fraction of resources and Mana (the platform's currency). When a player attempts to connect, the server automatically starts and becomes available in less than a minute.

  10. Understand Druid Smart Deployments for Minecraft

    Druid Smart Deployments optimize resource usage by putting Minecraft servers into 'Sleepmode' when no players are connected. In Sleepmode, the server consumes only a tiny fraction of resources and Mana. When a player attempts to connect, the server starts automatically, allowing players to join in less than a minute.

  11. Understand Druid Smart Deployments for Minecraft

    Druid Smart Deployments implement a 'pay-as-you-play' model for Minecraft servers. When no players are connected, the server enters 'Sleepmode,' consuming minimal resources and a fraction of the user's Mana. The server automatically wakes up and starts when a player attempts to connect, typically allowing players to join in less than a minute.

  12. Understand Druid Smart Deployments for Minecraft

    Druid Smart Deployments implement a resource-saving 'Sleepmode' for Minecraft servers. When no players are connected, the server enters Sleepmode, consuming only a tiny fraction of resources and Mana (currency). When a player attempts to connect, the server automatically starts and becomes available in less than a minute, ensuring users only pay for active playtime.