Skip to content

Repository files navigation

SpireForge

SpireForge is a browser-based mod authoring studio for Slay the Spire mod projects.

It is built with Next.js, shadcn/ui, and Tailwind CSS, and is designed around a project-first workflow:

  • create and manage mod projects from a hub
  • open a dedicated studio per project at /studio/[slug]
  • define cards, relics, modules, sprites, and mechanics
  • browse source-backed effect patterns from BaseLib and template references
  • generate exportable STS2-oriented code and content files

Current Scope

SpireForge currently supports:

  • project library management
  • per-project persistence in localStorage
  • project metadata such as tags, favorites, pinned state, recent files, and export target history
  • a dedicated studio route per project
  • card, relic, sprite, module, and mechanic authoring
  • source-backed effect browsing from adjacent BaseLib-StS2 and ModTemplate-StS2 checkouts
  • generated file previews and bundle export

Stack

  • Next.js 16
  • React 19
  • Tailwind CSS 4
  • shadcn/ui
  • Bun for local development and CI

Getting Started

Requirements:

  • Bun
  • optional adjacent repositories for source-backed browsing:
    • ../BaseLib-StS2
    • ../ModTemplate-StS2

Install dependencies:

bun install

Run the app:

bun run dev

Build and lint:

bun run lint
bun run build

Open http://localhost:3000.

Project Structure

Key paths:

  • src/app/page.tsx Hub page for project browsing and creation
  • src/app/studio/[slug]/page.tsx Dedicated studio route for editing a single project
  • src/app/api/source-snippet/route.ts Source snippet API for BaseLib/template-backed effect browsing
  • src/lib/spireforge.ts Core state types, migrations, effect catalogs, and export generation helpers
  • export-targets/sts2-generic-mod Generic export target scaffold

Source-Backed Effects

SpireForge can surface reference snippets from local adjacent repositories:

  • BaseLib-StS2
  • ModTemplate-StS2

This lets the studio show real implementation patterns for common card and relic behavior instead of invented placeholders.

If those repositories are not present, the app still works, but the source browser will be limited.

Roadmap

  • write generated files directly into target folders from the UI
  • sprite upload and asset management
  • richer module editors for events, enemies, bosses, and encounters
  • more BaseLib-powered effect and mechanic templates
  • import/export of full project libraries

Contributing

See CONTRIBUTING.md.

License

No license has been added yet. Treat this repository as all rights reserved until a license is chosen.

About

Browser-based Slay the Spire mod authoring studio built with Next.js, shadcn/ui, Tailwind, and BaseLib-backed references.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages