Skip to main content

Link's-Awakening-flavoured theme for the bragi CMS, used by zelda.eelcowesemann.nl

Project description

bragi-theme-zelda

A Link's-Awakening-flavoured theme for the bragi CMS, deployed at zelda.eelcowesemann.nl.

This is a site-specific theme. The visual choices are opinionated for one Zelda fan site (primarily Link's Awakening walkthroughs with secondary Ocarina of Time coverage) and are not intended as a general-purpose Zelda theme.

Theme highlights

  • Game Boy LCD palette: 4-shade GB green light mode, 4-shade GB Pocket greyscale dark mode. Two real handheld LCDs under one roof; prefers-color-scheme determines which.
  • Pixel headings over readable body: Press Start 2P for short strings (headings, labels, UI chrome), Inter for body text, JetBrains Mono for code.
  • MAP-styled sidebar tree: Current section's siblings and children visible at a glance, styled as a pause-menu MAP panel. Walkthrough hierarchy (game, dungeon, room) navigable without hunting through a top-level nav.
  • OoT section chrome flip: Royal-blue + gold accent shift in the Ocarina of Time section via data-section="oot". Body stays GB-green for cohesion; chrome (top bar, image frames, links) signals the switch.
  • GB Pocket greyscale dark mode: A real GB Pocket palette (light grey on near-black), not a colour inversion. Different hardware era, coherent aesthetic family.
  • Seven cosplay motifs: text-box callouts (Owl / Marin / Tarin / Ulrira portraits), rupee counter, PUSH START splash, item-acquired flourish between sections, pause-menu inventory homepage, ZZZZZ 404, heart-container <hr>, inventory-row pinned posts.
  • prefers-reduced-motion respected: Any animation that moves (ZZZZZ float, item- acquired scroll, PUSH START blink) switches to a static render.

Status: v0.1.2

v0.1.2 is a PATCH release. The dev dep for the theme's own venv and CI was switched from bragi @ git+https://...@v1.26.0 to bragi-cms ^1.27 from PyPI. No runtime behaviour change for sites running with theme='zelda'.

v0.1.1 is the first PyPI-published release. It ships the same full visual system as v0.1.0 (MAP sidebar, chrome, pause-menu home, ZZZZZ 404, all four cosplay JS motifs, and subsetted woff2 fonts). Character portraits, item tiles, the heart-container, and the 404 scene art are still placeholder PNGs (Pillow-generated text-on-coloured-square). The CSS / JS / templates reference the correct sprite filenames, so a future release swaps in real art via per-file PNG replacement with no code changes.

Asset provenance

Fonts and sprites are documented row-by-row in ASSETS.md. No ROM-ripped Nintendo assets; see ASSETS.md for the full sourcing and licence detail.

Installing

The theme is installed into a downstream bragi deployment via a thin Dockerfile that builds on the published bragi images and pip installs this package. From v0.1.1 the package is published to PyPI on every GitHub Release; v0.1.0 is git-tag-only.

Delivery container

FROM ghcr.io/sgaduuw/bragi-delivery:v1.26.0

# Install from PyPI (pin to a specific version).
RUN pip install --no-cache-dir bragi-theme-zelda==0.1.2

# For development against an unreleased commit, use the git+https form instead:
# RUN pip install --no-cache-dir \
#     "git+https://github.com/sgaduuw/bragi-theme-zelda.git@v0.1.0"

Admin container

FROM ghcr.io/sgaduuw/bragi-admin:v1.26.0

# Install from PyPI (pin to a specific version).
RUN pip install --no-cache-dir bragi-theme-zelda==0.1.2

# For development against an unreleased commit, use the git+https form instead:
# RUN pip install --no-cache-dir \
#     "git+https://github.com/sgaduuw/bragi-theme-zelda.git@v0.1.0"

Both containers need the package so template lookups work from the admin preview path and from the public delivery path. Restart both after installation to pick up the plugin.

Replace the version pin with the version to deploy. v0.1.1 is the first PyPI-published release; v0.1.0 is git-tag-only. v0.1.2 is the current release.

Development

Prerequisites

Install

poetry install

Run against a bragi dev checkout (editable install)

# From this project's directory, install into bragi's venv as an editable package:
cd ../bragi && poetry run pip install -e ../bragi-theme-zelda

# Then in bragi's working tree, point the Zelda site's theme to "zelda"
# via the admin UI or CLI, and reload the delivery process to pick up template changes.

Commands

# Run the test suite
poetry run pytest

# Lint
poetry run ruff check src/ tests/

# Format-check
poetry run ruff format --check src/ tests/

# Type-check
poetry run mypy src/

License

MIT. See LICENSE. Theme code and original assets are MIT-licensed. Third-party fonts are under their respective open-source licences; see ASSETS.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bragi_theme_zelda-0.1.2.tar.gz (142.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bragi_theme_zelda-0.1.2-py3-none-any.whl (145.9 kB view details)

Uploaded Python 3

File details

Details for the file bragi_theme_zelda-0.1.2.tar.gz.

File metadata

  • Download URL: bragi_theme_zelda-0.1.2.tar.gz
  • Upload date:
  • Size: 142.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bragi_theme_zelda-0.1.2.tar.gz
Algorithm Hash digest
SHA256 55a29f2f948d9455a03adff3c7c388669215a7bb7c18759874a34a4ebcbcd48b
MD5 8f0ed61210bbf4f949697df40b19a482
BLAKE2b-256 c587aadd9687c205387ba0270a462cdc5d150a25f9ac885a8d11672fbc5d66fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for bragi_theme_zelda-0.1.2.tar.gz:

Publisher: release.yml on sgaduuw/bragi-theme-zelda

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bragi_theme_zelda-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for bragi_theme_zelda-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e03a3c0e3f7a6f01b4c0e60640813b6ff9c2e01b97a2eb3cc9e9bdb37b7cdf22
MD5 2589f824548c52203379959be344ffe7
BLAKE2b-256 1e4a8aaf5b9a7af128abf2ef755da85c52f8629b81e2192a67fa1eb541766e94

See more details on using hashes here.

Provenance

The following attestation bundles were made for bragi_theme_zelda-0.1.2-py3-none-any.whl:

Publisher: release.yml on sgaduuw/bragi-theme-zelda

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page