tale-spinner/README.md

48 lines
1.6 KiB
Markdown
Raw Normal View History

2023-10-30 16:12:34 +00:00
# Tale-Spinner
Tale-Spinner is an interactive storytelling game built with Nuxt.js, where players take turns to craft a narrative based on a randomly selected symbol. The game supports both local and online play, allowing friends to come together and weave imaginative tales.
2023-10-30 17:04:20 +00:00
![](./screenshot.png)
2023-10-30 16:12:34 +00:00
## Features
- **Player Setup**: At the start of the game, players can set the number of participants, turns, and iterations.
- **Symbol Selection**: In each turn, a player triggers a random symbol selection, which is then used as a prompt to continue the story.
- **Story Building**: Players build upon the story iteratively, adding new elements with each symbol.
- **Category Filtering**: Players have the option to filter the symbols based on categories, customizing their gameplay experience.
- **Local Play**: Enjoy the game locally on a single device
Future Improvements:
- **Online Play**: play online with friends
- **Playful and Colorful UI**: Engaging user interface with colorful and playful elements to enhance the gaming experience.
## Getting Started
Clone the repository and install the dependencies:
2023-10-29 20:25:36 +00:00
```bash
2023-10-30 16:12:34 +00:00
git clone https://github.com/your-username/tale-spinner.git
cd tale-spinner
2023-10-29 20:25:36 +00:00
# install dependencies
$ yarn install
# serve with hot reload at localhost:3000
$ yarn dev
# build for production and launch server
$ yarn build
$ yarn start
# generate static project
$ yarn generate
```
2023-10-30 16:12:34 +00:00
## Contributing
2023-10-29 20:25:36 +00:00
2023-10-30 16:12:34 +00:00
Feel free to fork the project, open a PR, or submit issues for any suggestions, bugs, or feature requests.
2023-10-29 20:25:36 +00:00
2023-10-30 16:12:34 +00:00
For detailed explanation on how things work, check out the NuxtJS [documentation](https://nuxtjs.org).
2023-10-29 20:25:36 +00:00
2023-10-30 16:12:34 +00:00
Enjoy spinning tales!