Documentation
ΒΆ
Overview ΒΆ
Package yggdrasil holds the embedded assets (built frontend + bundled gameskills). It lives at the module root because go:embed cannot reference paths outside the embedding file's directory.
Index ΒΆ
Constants ΒΆ
This section is empty.
Variables ΒΆ
View Source
var GameskillsFS embed.FS
GameskillsFS contains the built-in rune (gameskill) definitions, embedded from the builtin-runes/ folder (community runes live in community-runes/ and are imported, not embedded).
View Source
var WebFS embed.FS
WebFS contains the built Svelte frontend under web/dist. `all:` ensures dotfiles (e.g. service worker assets) are included.
Functions ΒΆ
This section is empty.
Types ΒΆ
This section is empty.
Directories
ΒΆ
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
docs-gen
command
Command docs-gen renders the markdown in docs/ into the static documentation site under website/docs/.
|
Command docs-gen renders the markdown in docs/ into the static documentation site under website/docs/. |
|
yggdrasil
command
Command yggdrasil is the Yggdrasil control plane: a single static binary that serves the web UI + REST/WebSocket API and drives game servers via Docker.
|
Command yggdrasil is the Yggdrasil control plane: a single static binary that serves the web UI + REST/WebSocket API and drives game servers via Docker. |
|
internal
|
|
|
backup
Package backup creates and restores server archives and ships them to storage targets (local/NFS/CIFS mount, SFTP, SMB).
|
Package backup creates and restores server archives and ships them to storage targets (local/NFS/CIFS mount, SFTP, SMB). |
|
cloudflare
Package cloudflare is a minimal client for the Cloudflare API, used to route a subdomain to a local game/app server through a *remotely-managed* Cloudflare Tunnel.
|
Package cloudflare is a minimal client for the Cloudflare API, used to route a subdomain to a local game/app server through a *remotely-managed* Cloudflare Tunnel. |
|
crypto
Package crypto provides authenticated symmetric encryption (AES-256-GCM) for secrets stored at rest: backup-target and Steam credentials.
|
Package crypto provides authenticated symmetric encryption (AES-256-GCM) for secrets stored at rest: backup-target and Steam credentials. |
|
docker
Package docker wraps the official Docker Engine SDK with the narrow set of operations Yggdrasil needs: lifecycle, log/console streaming, stats and ephemeral install containers.
|
Package docker wraps the official Docker Engine SDK with the narrow set of operations Yggdrasil needs: lifecycle, log/console streaming, stats and ephemeral install containers. |
|
llm
Package llm is a small provider-agnostic chat-completion client for Yggdrasil's advisory AI features (e.g.
|
Package llm is a small provider-agnostic chat-completion client for Yggdrasil's advisory AI features (e.g. |
|
notify
Package notify delivers event notifications to Telegram, Discord, or a generic webhook.
|
Package notify delivers event notifications to Telegram, Discord, or a generic webhook. |
|
npm
Package npm is a minimal client for the Nginx Proxy Manager (jc21) API, used to create and remove proxy hosts that route a subdomain to a game/app server's published host port.
|
Package npm is a minimal client for the Nginx Proxy Manager (jc21) API, used to create and remove proxy hosts that route a subdomain to a game/app server's published host port. |
|
query
Package query implements the read-only status protocols Yggdrasil uses to show player counts and liveness on the dashboard: Source A2S (Steam games), Minecraft Java Server List Ping, and Minecraft Bedrock unconnected ping.
|
Package query implements the read-only status protocols Yggdrasil uses to show player counts and liveness on the dashboard: Source A2S (Steam games), Minecraft Java Server List Ping, and Minecraft Bedrock unconnected ping. |
|
rbac
Package rbac implements Yggdrasil's scoped permission model: a user may be granted a set of permissions at a scope (global, a realm, a game type, or a single server).
|
Package rbac implements Yggdrasil's scoped permission model: a user may be granted a set of permissions at a scope (global, a realm, a game type, or a single server). |
|
rcon
Package rcon provides remote-console clients for the protocols Yggdrasil's gameskills use: Source RCON (Minecraft Java and Source games), Rust WebSocket RCON, and BattlEye BERcon (DayZ).
|
Package rcon provides remote-console clients for the protocols Yggdrasil's gameskills use: Source RCON (Minecraft Java and Source games), Rust WebSocket RCON, and BattlEye BERcon (DayZ). |
|
scheduler
Package scheduler renders message templates and defines the schedule action model.
|
Package scheduler renders message templates and defines the schedule action model. |
|
totp
Package totp implements RFC 6238 time-based one-time passwords (TOTP) with HMAC-SHA1, a 30-second step, and 6 digits β compatible with Google Authenticator, Authy, etc.
|
Package totp implements RFC 6238 time-based one-time passwords (TOTP) with HMAC-SHA1, a 30-second step, and 6 digits β compatible with Google Authenticator, Authy, etc. |
|
unifi
Package unifi is a minimal client for the UniFi OS local API (UDM / Cloud Key Gen2+ / UDR), used to create and remove WAN port-forward rules for game servers.
|
Package unifi is a minimal client for the UniFi OS local API (UDM / Cloud Key Gen2+ / UDR), used to create and remove WAN port-forward rules for game servers. |
|
upnp
Package upnp adds/removes router port mappings via UPnP-IGD, so game servers can be reachable from the internet without manual port forwarding.
|
Package upnp adds/removes router port mappings via UPnP-IGD, so game servers can be reachable from the internet without manual port forwarding. |
Click to show internal directories.
Click to hide internal directories.











