ShadowsOverWestgate/sow-nodebb-theme
3
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects Releases Activity
Files
908fffb0918e8cfc9b6d50708877dc822c6328ab
sow-nodebb-theme/AGENTS.md
T
archvillainette 908fffb091 Icon Changes
2026-04-23 16:29:06 +02:00

12 KiB
Raw Blame History

AGENTS.md

Project

This repository is nodebb-theme-westgate, a NodeBB theme for the Shadows Over Westgate forum.

It is forked from nodebb-theme-quickstart and should remain a small, focused NodeBB child theme rather than a full replacement for NodeBB or Harmony.

Local Environment

  • Theme repo: /home/vicky/Projects/nodebb-dev/nodebb-theme-westgate
  • Working NodeBB install: /home/vicky/Projects/nodebb-dev/forum
  • Development workflow uses Grunt hot reload from the NodeBB install.
  • This theme targets NodeBB 4.x compatibility, as declared in package.json.

Theme Direction

The visual target is black velvet silk, darkness, vampirism, decadence, and decay.

Use this palette direction:

  • Plum and near-black as the dominant base.
  • Muted gold for accents, borders, small highlights, and important affordances.
  • Red only sparingly, preferably as a subtle detail or state color.
  • Avoid bright, playful, clinical, or flat SaaS-style treatment.
  • Favor depth, restraint, texture, and rich contrast over loud ornament.

Reference prior theme work in this repo through files in the _references directory:

ref_palettes.css is the clearest reference for the intended slick gradient treatment. Use that direction for foreground elements such as panels, topic rows, buttons, borders, accents, and active states. Keep gradients rich and polished, but avoid turning the entire page into a decorative gradient background.

When adding new visuals, study the reference files first and match the existing direction before introducing new motifs.

NodeBB Theme Rules

Follow the current NodeBB theme model:

  • theme.json defines theme metadata and the base theme.
  • This project uses baseTheme: "nodebb-theme-harmony".
  • Keep this as a child theme unless the user explicitly asks for a larger rewrite.
  • theme.scss is the theme entry point and must stay imports-only.
  • Do not append substantive CSS/SCSS directly to theme.scss.
  • Do not add new root-level theme styling files.
  • Put substantive Westgate-specific style overrides under focused files in scss/.
  • Keep scss/overrides.scss focused on Bootstrap/Harmony variable overrides that must load before Bootstrap.
  • Template overrides belong under templates/ and must preserve the same relative path as the Harmony template they replace.
  • Do not copy or redefine Harmony templates unless an actual override is needed.
  • If a template does not exist here, NodeBB inherits it from the configured base theme.

NodeBB theme documentation: https://docs.nodebb.org/development/themes/

Current Files Of Interest

  • theme.json: theme metadata and baseTheme.
  • plugin.json: hooks, scripts, modules, template path, and static dirs.
  • theme.scss: NodeBB SCSS entry point.
  • scss/overrides.scss: current Westgate override layer.
  • lib/theme.js and lib/controllers.js: server-side theme hooks/controllers.
  • public/client.js: client-side theme behavior.
  • templates/: local template overrides and admin templates.

Working Practices

  • Keep edits scoped to the theme package unless the task explicitly names the NodeBB install.
  • Do not modify the working NodeBB install at /home/vicky/Projects/nodebb-dev/forum except for running build/dev commands or when explicitly asked.
  • Prefer existing NodeBB, Harmony, Bootstrap, and local theme patterns over introducing new frameworks.
  • Keep selectors maintainable and avoid broad global overrides unless they are intentional theme-wide tokens or resets.
  • Avoid unrelated formatting churn.
  • Before overriding a template, inspect the corresponding Harmony template and copy only what is necessary.
  • Preserve accessibility: readable contrast, visible focus states, usable hover/active states, and no text hidden purely for visual effect unless there is an accessible alternative.

Validation

Use the local NodeBB workflow when practical:

  • From /home/vicky/Projects/nodebb-dev/forum, run the existing Grunt hot-reload task used by the project.
  • Rebuild NodeBB assets when template or SCSS changes require it.
  • For template overrides, verify that the rendered route uses the local template rather than falling back unexpectedly.
  • For style work, check both desktop and mobile widths.
  • Playwright browser validation is available in this environment after asset rebuilds; use it for rendered route checks and desktop/mobile screenshots against http://localhost:4567.

If validation cannot be run, report what was changed and what still needs to be checked in the running forum.

Current Tasks

Complete and update as needed. Future-dated tasks and possibilities go into Future Tasks.

Statuses:

  1. marks total completion.
  2. [-] marks partial completion: not exact specification.
  3. marks incomplete.
  4. [?] marks uncertainty or exception: treat as incomplete, expand as needed, and keep in scope.

Complete the following:

  • [-] Implement curated game-icons support for category/subcategory icons: sanitize selected SVGs into mask-friendly theme assets, expose them through staticDirs, add reusable wg-icon-* CSS mask classes, and include category custom classes in the local category/subcategory templates if Harmony data supports them.
    • Phase 1: Build our icon stack.
      • Recommend icons from the game-icons pack for forum categories and their subcategories. See GAME_ICONS.md.
      • Include the .svg/.png files in the theme if possible. SVG assets are in public/game-icons/.
      • Author any necessary credits in a .md file at the root of the nodebb-theme-westgate repository. See GAME_ICONS.md.
    • [-] Phase 2: Implementation.
      • Confirm category class data is present on all required render paths: /categories, category-page subcategory rows, category-page header, and AJAX-loaded "more subcategories" rows. NodeBB stores and escapes category.class; getCategoryData/getCategoriesData include it; the category template's children block is used for AJAX-loaded subcategories.
      • Add ACP custom class output to local category templates. Root category rows and child/subcategory row wrappers now emit {./class} so classes like wg-icon-scroll-quill can control icons without hardcoding category IDs.
      • Add a minimal local templates/category.tpl override, copied from Harmony only as needed, so the category page header can expose {./class} around its buildCategoryIcon(...) output.
      • Keep templates/partials/categories/children.tpl as the single source of truth for nested child markup and collapse the duplicate child markup in templates/partials/categories/item.tpl back to the imported partial before adding icon classes.
      • Implement the wg-icon-* CSS mask classes in the existing category SCSS layer. Use public/game-icons/*.svg through the theme static path, hide/neutralize the Font Awesome <i> only for wg-icon-* classes, and render the game-icon mask via ::before using currentColor.
      • Preserve the existing ornate icon frame treatment: category ACP bgColor/color still drives the frame and glyph color because the mask uses the icon element's current color; fallback styling remains faded-gold/dark-steel.
      • Define the exact ACP custom classes to enter for each category/subcategory, based on GAME_ICONS.md, so setup can happen without theme code knowing category IDs.
      • Document setup steps for admins: where to enter the custom class, which class names map to which icons, and when to rebuild/restart NodeBB after theme changes.
      • Validate implementation scaffolding: ./nodebb build succeeds, compiled templates emit {./class}, compiled CSS contains the wg-icon-* mask rules, and /assets/plugins/nodebb-theme-westgate/game-icons/drama-masks.svg returns HTTP 200.
      • Enter the wg-icon-* values from GAME_ICONS.md into the live ACP category custom class fields. The current live data still contains legacy layout classes like col-md-3 col-6; keep them only if they are still intentionally used for layout, and append the wg-icon-* class alongside them.
        • Removed col-md-3 col-6 legacy layout classes.
      • [-] Validate actual game-icon visuals on the live website after ACP class entry: desktop and mobile /categories, one category page with subcategories, "load more subcategories" if present, and at least one category with no game-icon class to confirm Font Awesome fallback still works.
        • Icons don't fit into their containers: either too small or cropped wrong. Especially noticeable when viewing category page
        • Missing "signet ring" style ornamentation namely on category page (above topic or subcategory list)
        • Subcategory containers no longer tidy; maybe subcategory icon and container should be bigger (1.5x current size) on the categories page with text remaining the same size.
        • Some icons need to be changed. When adding new icons, add new classes for them, and deprecate unused ones:
          • INFORMATION: scroll-unfurled
            • Announcements: trumpet-flag
            • Player Guide: compass
          • COMMUNITY
            • General Discussion:beer-stein
            • Screenshots: wood-frame
            • Creations: harp
          • ROLEPLAY: duality-mask
            • Notices: stabbed-note
            • Rumors & Gossip: mute
            • Journals & Biographies: sword-altar
            • Factions & Guilds: cowled
              • Keep wax-seal for "Organization Registry" (subcategory of Factions & Guilds)
          • SUPPORT: candle-flame
            • Common Issues & Questions: key-lock
            • Feedback: envelope
            • Technical Help:round-potion
          • DEVELOPMENT: anvil
            • Tools & References: spanner
            • Programming: gears
            • General: wax-tablet
            • Lore: classical-knowledge
      • Decide whether uploaded category background images should be cleared for icon-driven categories after seeing the final ACP-configured visuals.
      • Explain any operational follow-up after ACP setup, especially asset rebuild, restart/cache behavior, and whether legacy Bootstrap layout classes should remain in category custom class fields.

Context for categories

Categories are fully capitalized. I've also included my own suggestions of what they could look like. If you have better ideas, tell me.

INFORMATION -- Find essential information about the server, updates, and how to get started. Could be a scroll.

  • Player Guide -- A tome of knowledge, a lantern, or a candle.
  • Announcements -- A bell? A town crier?
  • Patch Notes -- Updates, so maybe something like a wheel?

COMMUNITY -- Out-of-character discussion and player interaction.

  • General Discussion -- "Speakeasy tavern" vibe
  • Introductions -- Handshake or similar.
  • Screenshots -- A canvas or artpiece?
  • Creations -- A lute or other instrument

ROLEPLAY -- The stories, whispers, and unfolding lives within Westgate. Definitely use a creepy mask.

  • Notices -- Similar to announcemnts but these are "in-world", so may include things like... bounty posters?
  • Rumors & Gossip -- A whispering person?
  • Journals & Biographies -- Book or journal
  • Factions & Guilds -- Wax seal or coat of arms?

SUPPORT -- Need help? Report issues, ask questions, or provide feedback here. A helping hand or a rope?

  • Common Issues & Questions -- Not sure.
  • Technical Help -- Something broken? A wrench? Tools?
  • Bug Reports -- A bug, or something broken.
  • Feedback -- Something that implies an idea

DEVELOPMENT -- Behind-the-scenes work, tools, and development discussion. Use a gear or mechanism here.

  • Tools & References
  • General
  • Lore
  • Designs
  • Programming
  • Area Building

Future Tasks

Tasks to be considered in the future, not implemented immediately. Keep them in scope when making decisions.

  • Consider a light mode/dark mode toggle while retaining core theme, preferably without adding a Skin
  • Un-bold "topics" and "posts" and make the color lines replace the black line drived from category background color to either use the foreground color of the icon, or an ornate gilding like the icons (image 2)
  • Consider making the category names a bit smoother; it looks like it's not anti-aliased. (image 3)
  • Mobile website doesn't use the correct fonts.
  • In the process of testing widgets, I noticed that some are being given the "card" treatment (the glossy purple background element) even if there is no card container. Example here: http://localhost:4567/user/admin
    • Widgets without the card containers should display plainly.
    • Widgets can be put inside of a card container to make a card.
Reference in New Issue View Git Blame Copy Permalink