Directories
¶
| Path | Synopsis |
|---|---|
|
Package api holds the generated OpenAPI document of the REST API.
|
Package api holds the generated OpenAPI document of the REST API. |
|
cmd
|
|
|
skinloom
command
Command skinloom runs the SkinLoom (云织) skin site.
|
Command skinloom runs the SkinLoom (云织) skin site. |
|
Package ent holds the generated data access layer.
|
Package ent holds the generated data access layer. |
|
internal
|
|
|
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. |
|
app
Package app wires the services together.
|
Package app wires the services together. |
|
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. |
|
backup
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. |
|
buildinfo
Package buildinfo carries version metadata injected at build time via -ldflags.
|
Package buildinfo carries version metadata injected at build time via -ldflags. |
|
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. |
|
cli
Package cli implements the skinloom command line.
|
Package cli implements the skinloom command line. |
|
config
Package config loads the static (file + environment) configuration.
|
Package config loads the static (file + environment) configuration. |
|
daemon
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. |
|
gateway
Package gateway is the single public entry point.
|
Package gateway is the single public entry point. |
|
hook
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. |
|
httpapi
Package httpapi builds the backend HTTP surface: /api/v1 (Huma, OpenAPI 3.1), the SSE change stream, health probes and theme assets.
|
Package httpapi builds the backend HTTP surface: /api/v1 (Huma, OpenAPI 3.1), the SSE change stream, health probes and theme assets. |
|
jobs
Package jobs runs background work stored in the jobs table.
|
Package jobs runs background work stored in the jobs table. |
|
launcher
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. |
|
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. |
|
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. |
|
platform/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. |
|
platform/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). |
|
platform/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. |
|
platform/migrate
Package migrate applies the embedded versioned migrations with goose.
|
Package migrate applies the embedded versioned migrations with goose. |
|
platform/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. |
|
platform/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). |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
storage
Package storage keeps texture files.
|
Package storage keeps texture files. |
|
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. |
|
tools/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. |
|
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. |
|
Package migrations embeds the versioned SQL migrations, one directory per dialect.
|
Package migrations embeds the versioned SQL migrations, one directory per dialect. |
|
Package themes embeds the built-in themes.
|
Package themes embeds the built-in themes. |
Click to show internal directories.
Click to hide internal directories.