Skip to content

Slay the Web is a singleplayer, deck builder, roguelike card crawl game for the web based on Slay the Spire

License

Notifications You must be signed in to change notification settings

oskarrough/slaytheweb

Repository files navigation

Slay the Web

A digital, single player deckbuilding roguelike card game for the web based on Slay The Spire,
a fantastic video game designed by MegaCrit.

Screenshot of Slay the Web

After many runs in the Spire, I got into the theory behind the game. Inspired by the STS modding community, I thought it'd be fun and a great learning experience to try and implement the core logic of the game in JavaScript for the web. And that is what Slay the Web is: a kind of stable, UI agnostic game engine with an example UI for the web.

State of the game

December 2023. The core mechanics seem to work. There is a dynamic map you can navigate with different rooms and monsters. You can fight against them using your cards and their powers.

There are many things that would make it more fun to play:

  • new cards
  • new powers
  • more monsters
  • expand the map into multiple "worlds" (or acts...)
  • better UI and animations
  • optimize UI for mobile

See the open issues. Have an idea? Please open a new issue.

Documentation

If you're interested in contributing to the game or merely curious how it works:

Or browse the code. Especially the game logic includes tons of comments (written in JSDoc).

Development

TLDR;

  1. Clone the repository
  2. Run npm install followed by npm run dev to open a local development server.

The src/game folder contains the actual game logic.
The src/ui folder is the website UI where you can actually play the game.
The src/content folder builds content for the game.

How to release a new version (aka deploy)

Every commit to the main branch automatically deploys to https://slaytheweb.cards via the Vercel service.

If you open a PR, it'll give you a preview URL as well for testing.

To update CHANGELOG.md, run bunx release-it and follow the prompts. We do not use GitHub releases.

References

A collection of related links, inspiration and ideas.

Slay the Spire modding, tools and things

Typeface

Licenced from https://mbtype.com/

Open source artwork