Skip to content

Commit a8b6c1a

Browse files
authored
Update README.md
1 parent 0881360 commit a8b6c1a

File tree

1 file changed

+29
-11
lines changed

1 file changed

+29
-11
lines changed

README.md

+29-11
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,54 @@
11
# Slay the Web
22

3-
A digital card game for the web based on Slay The Spire, a fantastic video game designed by [MegaCrit](https://www.megacrit.com/). They say:
3+
A digital, single player deckbuilding roguelike card game for the web based on Slay The Spire,
4+
a fantastic video game designed by [MegaCrit](https://www.megacrit.com/).
45

5-
> We fused card games and roguelikes together to make the best single player deckbuilder we could. Craft a unique deck, encounter bizarre creatures, discover relics of immense power, and Slay the Spire!
66

7-
## [Play on slaytheweb.cards](https://slaytheweb.cards/)
7+
### [Play on slaytheweb.cards](https://slaytheweb.cards/)
8+
### [Chat on #slaytheweb:matrix.org](https://matrix.to/#/#slaytheweb:matrix.org)
89

910
<a href="https://slaytheweb.cards"><img src="https://i.imgur.com/m9CRCsa.png" alt="Screenshot of Slay the Web" width="640"></a>
1011

1112
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.
1213

1314
## State of the game
1415

15-
December 2023. The core mechanics seem to work. A map you can navigate with different rooms and monsters. Combat with cards and "powers". There are many things that would make it more fun to play:
16+
December 2023. The core mechanics seem to work. There is a [dynamic map](https://slaytheweb.cards/map-demo.html) you can navigate with different rooms and monsters. You can fight against them using your cards and their powers.
1617

17-
- more cards
18-
- more powers
18+
There are many things that would make it more fun to play:
19+
20+
- new cards
21+
- new powers
1922
- more monsters
20-
- expand the map into multiple "worlds" (or acts)
23+
- expand the map into multiple "worlds" (or acts...)
2124
- better UI and animations
25+
- optimize UI for mobile
2226

23-
Come chat on https://matrix.to/#/#slaytheweb:matrix.org!
27+
See the [open issues](https://github.com/oskarrough/slaytheweb/issues). Have an idea? Please [open a new issue](https://github.com/oskarrough/slaytheweb/issues/new).
2428

2529
## Documentation
2630

27-
If you're interested in contributing to the game or merely curious how it works, see [the documentation](DOCUMENTATION.md).
31+
If you're interested in contributing to the game or merely curious how it works:
32+
33+
- [The documentation](DOCUMENTATION.md)
34+
35+
Or browse the code. Especially the game logic includes tons of comments (written in JSDoc).
36+
37+
## Development
38+
39+
TLDR;
40+
41+
1. Clone the repository
42+
2. Run `npm install` followed by `npm run dev` to open a local development server.
2843

29-
TLDR; Clone the repository and run `npm install` followed by `npm run dev` to open a local development server. The `src/game` folder contains the actual game logic and the `src/ui` folder is the website UI where you can actually play the game. The `src/content` folder builds content for the game.
44+
The `src/game` folder contains the actual game logic.
45+
The `src/ui` folder is the website UI where you can actually play the game.
46+
The `src/content` folder builds content for the game.
3047

3148
## How to deploy it
3249

33-
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.
50+
The `main` branch automatically deploys to https://slaytheweb.cards, via the Vercel service.
51+
If you open a PR, it'll give you a preview URL as well for testing.
3452

3553
## References
3654

0 commit comments

Comments
 (0)