Directories
¶
| Path | Synopsis |
|---|---|
|
Package app wires the services together.
|
Package app wires the services together. |
|
Package backup writes and restores a whole SkinLoom install as one .tar.gz (docs/design/02 F78): the SQLite database (an online snapshot, the site may keep running), the config file, the secrets and the texture files.
|
Package backup writes and restores a whole SkinLoom install as one .tar.gz (docs/design/02 F78): the SQLite database (an online snapshot, the site may keep running), the config file, the secrets and the texture files. |
|
Package cli implements the skinloom command line.
|
Package cli implements the skinloom command line. |
|
Package config loads the static (file + environment) configuration.
|
Package config loads the static (file + environment) configuration. |
|
Package contract turns responses of the game-facing APIs (CustomSkinLoader, USM, Legacy, texture files, Yggdrasil) into stable text: the status, the headers that are part of the contract, and the body with what changes from run to run (times, tokens, signatures) replaced by markers.
|
Package contract turns responses of the game-facing APIs (CustomSkinLoader, USM, Legacy, texture files, Yggdrasil) into stable text: the status, the headers that are part of the contract, and the body with what changes from run to run (times, tokens, signatures) replaced by markers. |
|
Package daemon installs SkinLoom as a background service of the operating system (docs/design/04 §9.1, 02 F76): a systemd unit on Linux, a launchd daemon on macOS, a Windows service.
|
Package daemon installs SkinLoom as a background service of the operating system (docs/design/04 §9.1, 02 F76): a systemd unit on Linux, a launchd daemon on macOS, a Windows service. |
|
Package gateway is the single public entry point.
|
Package gateway is the single public entry point. |
|
Package hook is the extension bus every module — and later every plugin — uses.
|
Package hook is the extension bus every module — and later every plugin — uses. |
|
Package httpapi is the backend's HTTP surface.
|
Package httpapi is the backend's HTTP surface. |
|
importer
|
|
|
bs
Package bs imports a Blessing Skin site (design 02 §4, §5, 04 §10): accounts with their passwords, players with their UUIDs, textures with their files, closets, reports, unread notifications, OAuth applications, settings, reworded terms and the Yggdrasil signing key.
|
Package bs imports a Blessing Skin site (design 02 §4, §5, 04 §10): accounts with their passwords, players with their UUIDs, textures with their files, closets, reports, unread notifications, OAuth applications, settings, reworded terms and the Yggdrasil signing key. |
|
Package jsrt isolates the embedded JavaScript runtime behind an engine-agnostic sandbox abstraction so plugins run in pooled, memory-capped, preemptively time-bounded ES2023 isolates without CGo.
|
Package jsrt isolates the embedded JavaScript runtime behind an engine-agnostic sandbox abstraction so plugins run in pooled, memory-capped, preemptively time-bounded ES2023 isolates without CGo. |
|
Package launcher runs and supervises the Next.js frontend as a child process, so one `skinloom up` starts the whole site on Windows, macOS and Linux.
|
Package launcher runs and supervises the Next.js frontend as a child process, so one `skinloom up` starts the whole site on Windows, macOS and Linux. |
|
modules
|
|
|
account
Package account owns users, browser sessions, one-time tokens, the first-run setup and the audit log.
|
Package account owns users, browser sessions, one-time tokens, the first-run setup and the audit log. |
|
audit
Package audit writes the audit log (audit_logs): who did what to what, from where.
|
Package audit writes the audit log (audit_logs): who did what to what, from where. |
|
captcha
Package captcha verifies that a form was filled in by a person.
|
Package captcha verifies that a form was filled in by a person. |
|
cdn
Package cdn tells a CDN to drop its copies of a player's profile and avatar when the player changes (docs/design/02 F72), so game clients behind the CDN see a new skin without waiting for delivery.profile_cache_seconds.
|
Package cdn tells a CDN to drop its copies of a player's profile and avatar when the player changes (docs/design/02 F72), so game clients behind the CDN see a new skin without waiting for delivery.profile_cache_seconds. |
|
mail
Package mail sends email: an SMTP driver, a log driver for development, MIME building and the localized templates.
|
Package mail sends email: an SMTP driver, a log driver for development, MIME building and the localized templates. |
|
notify
Package notify keeps each user's inbox: notifications sent to them, and their copies of announcements sent to many.
|
Package notify keeps each user's inbox: notifications sent to them, and their copies of announcements sent to many. |
|
oauth
Package oauth is the site's OAuth 2.0 authorization server and personal access tokens (contract docs/design/02 §2.6): applications registered by users sign people in with the authorization code flow (PKCE, refresh tokens), and the tokens they get, or personal access tokens, call the Blessing Skin compatible resource API.
|
Package oauth is the site's OAuth 2.0 authorization server and personal access tokens (contract docs/design/02 §2.6): applications registered by users sign people in with the authorization code flow (PKCE, refresh tokens), and the tokens they get, or personal access tokens, call the Blessing Skin compatible resource API. |
|
player
Package player owns players (in-game characters): names, UUIDs, the skin and cape each one wears, and the profiles game clients fetch.
|
Package player owns players (in-game characters): names, UUIDs, the skin and cape each one wears, and the profiles game clients fetch. |
|
render
Package render draws avatars (a skin's head, flat or as a cube) and previews (the skin seen from the front and the back, or a cape) for /avatar and /preview.
|
Package render draws avatars (a skin's head, flat or as a cube) and previews (the skin seen from the front and the back, or a cape) for /avatar and /preview. |
|
report
Package report handles complaints about textures.
|
Package report handles complaints about textures. |
|
score
Package score changes users' scores.
|
Package score changes users' scores. |
|
settings
Package settings holds runtime settings that admins edit: typed definitions, a database store, and an atomically swapped snapshot that changes are hot-applied from.
|
Package settings holds runtime settings that admins edit: typed definitions, a database store, and an atomically swapped snapshot that changes are hot-applied from. |
|
sitesettings
Package sitesettings assembles the definitions of every module's settings into one registry, so the server and the Blessing Skin importer check settings alike.
|
Package sitesettings assembles the definitions of every module's settings into one registry, so the server and the Blessing Skin importer check settings alike. |
|
social
Package social signs people in with accounts they have elsewhere (contract docs/design/02 F07, F08): GitHub, Microsoft and any OpenID Connect provider, set up in auth.social.providers.
|
Package social signs people in with accounts they have elsewhere (contract docs/design/02 F07, F08): GitHub, Microsoft and any OpenID Connect provider, set up in auth.social.providers. |
|
stats
Package stats computes the figures of the admin overview and the home page's totals.
|
Package stats computes the figures of the admin overview and the home page's totals. |
|
texture
Package texture owns uploaded skins and capes: the upload pipeline, the files (blobs, reference counted), the skin library and closets.
|
Package texture owns uploaded skins and capes: the upload pipeline, the files (blobs, reference counted), the skin library and closets. |
|
theme
Package theme loads theme packages and resolves the active theme for a request.
|
Package theme loads theme packages and resolves the active theme for a request. |
|
yggdrasil
Package yggdrasil implements the Yggdrasil API that authlib-injector launchers and game servers use for external login (contract docs/design/02 §2.4): launcher tokens (authserver), joining servers (sessionserver), profile lookups and texture uploads, compatible with Blessing Skin's yggdrasil-api plugin.
|
Package yggdrasil implements the Yggdrasil API that authlib-injector launchers and game servers use for external login (contract docs/design/02 §2.4): launcher tokens (authserver), joining servers (sessionserver), profile lookups and texture uploads, compatible with Blessing Skin's yggdrasil-api plugin. |
|
platform
|
|
|
buildinfo
Package buildinfo carries version metadata injected at build time via -ldflags.
|
Package buildinfo carries version metadata injected at build time via -ldflags. |
|
clip
Package clip shortens text to fit a column or a log line without cutting a UTF-8 character in half.
|
Package clip shortens text to fit a column or a log line without cutting a UTF-8 character in half. |
|
datalock
Package datalock marks a data directory as in use (ADR 0039).
|
Package datalock marks a data directory as in use (ADR 0039). |
|
db
Package db opens the database connection shared by ent and raw SQL users.
|
Package db opens the database connection shared by ent and raw SQL users. |
|
dbtest
Package dbtest opens migrated databases for tests: SQLite always, plus MySQL and PostgreSQL when SKINLOOM_TEST_MYSQL / SKINLOOM_TEST_POSTGRES name a test database (CI's integration job sets them).
|
Package dbtest opens migrated databases for tests: SQLite always, plus MySQL and PostgreSQL when SKINLOOM_TEST_MYSQL / SKINLOOM_TEST_POSTGRES name a test database (CI's integration job sets them). |
|
fsperm
Package fsperm keeps files that hold secrets private where Unix mode bits do not: on Windows a new file takes its folder's permissions, which in a data directory under C:\ or a shared folder let every local user read it (ADR 0039).
|
Package fsperm keeps files that hold secrets private where Unix mode bits do not: on Windows a new file takes its folder's permissions, which in a data directory under C:\ or a shared folder let every local user read it (ADR 0039). |
|
httpx
Package httpx holds small HTTP helpers shared by the API and the gateway.
|
Package httpx holds small HTTP helpers shared by the API and the gateway. |
|
jobs
Package jobs runs background work stored in the jobs table.
|
Package jobs runs background work stored in the jobs table. |
|
logging
Package logging builds the process logger; level and format can change at runtime.
|
Package logging builds the process logger; level and format can change at runtime. |
|
migrate
Package migrate applies the embedded versioned migrations with goose.
|
Package migrate applies the embedded versioned migrations with goose. |
|
pubsub
Package pubsub is the in-process fan-out used for change notifications (settings, themes, plugins) and the browser SSE stream.
|
Package pubsub is the in-process fan-out used for change notifications (settings, themes, plugins) and the browser SSE stream. |
|
realip
Package realip derives the real client address, scheme and host of a request.
|
Package realip derives the real client address, scheme and host of a request. |
|
registry
Package registry provides copy-on-write tables that can be swapped atomically while requests are being served.
|
Package registry provides copy-on-write tables that can be swapped atomically while requests are being served. |
|
secrets
Package secrets creates and reads the per-install secrets under <data>/secrets.
|
Package secrets creates and reads the per-install secrets under <data>/secrets. |
|
storage
Package storage keeps texture files.
|
Package storage keeps texture files. |
|
validate
Package validate holds the error types services use to reject input, so the HTTP layer can map them the same way for every module: a FieldError per bad field (422) and RateLimitError (429).
|
Package validate holds the error types services use to reject input, so the HTTP layer can map them the same way for every module: a FieldError per bad field (422) and RateLimitError (429). |
|
tools
|
|
|
benchseed
command
Command benchseed fills an empty SkinLoom database with a large site for the load tests in bench/k6 (design 04 §5.4, ADR 0038): users, a skin library of a million textures, players wearing real skin files, and the setup marker.
|
Command benchseed fills an empty SkinLoom database with a large site for the load tests in bench/k6 (design 04 §5.4, ADR 0038): users, a skin library of a million textures, players wearing real skin files, and the setup marker. |
|
migdiff
command
Command migdiff writes a new versioned migration (goose format) for one dialect by diffing ent/schema against the replayed migration directory on a dev database.
|
Command migdiff writes a new versioned migration (goose format) for one dialect by diffing ent/schema against the replayed migration directory on a dev database. |
|
plugingen
command
Command plugingen generates website/static/schema/plugin.v1.json and web/packages/plugin-sdk/src/gen/catalog.ts from the Go hook catalog, plugin permission table, UI slot registry, and built-in theme block definitions.
|
Command plugingen generates website/static/schema/plugin.v1.json and web/packages/plugin-sdk/src/gen/catalog.ts from the Go hook catalog, plugin permission table, UI slot registry, and built-in theme block definitions. |
|
protogen
command
Command protogen compiles api/proto/plugin/v1/plugin.proto into Go protobuf and gRPC stubs without requiring an external C++ protoc binary.
|
Command protogen compiles api/proto/plugin/v1/plugin.proto into Go protobuf and gRPC stubs without requiring an external C++ protoc binary. |
Click to show internal directories.
Click to hide internal directories.