emmanuelconrardy/static-game-engine

SpaceQuest is a sample game using Vue and VuePress to build a text-based choose your own adventure game. Fork this repo and create your own Quest!

🚀👽✨ Welcome to your new game! 🚀👽✨

Description

This repo contains the elements you need to create a cool text-based game that can be deployed as a web site. Amaze your friends! Fork the repo and build out the game elements by writing a fun storyline. You don't have to keep it as SpaceQuest, it could be a walk through a spooky house, a mysterious forest, a scuba adventure, or a bike race...let your imagination guide you! Tell us what you create in the Issues tab!

History of the Project

Microsoft Azure Advocates have been creating fun text-based games to encourage students of all ages to learn about Microsoft Learn and Docs. The Azure Mystery Mansion, and the ongoing Azure Maya Mystery all fit into this prototype. Em Lazer-Walker and Jen Looper worked as primary developers on the Mystery Mansion, and Jen Looper and Chris Noring were primary developers on the Maya Mystery. This game engine is a prototype that we hope will be forked and reused by all kinds of people who want to create fun text-based games and learn about web programming as well.

Architecture

This site is a hybrid of a Vue.js Single Page Web App and a VuePress static site. Most written content is written using VuePress's markdown architecture, and the game elements are build as standard Vue.js app elements. The game is contained in the app folder. The site is deployed on Azure Static Web Apps.

Create new pages of your Mystery Adventure game by adding Markdown files in the app/game/.vuepress folder. Currently there are three narrative files (README.md, 1.md and 2.md). You can make your game trickier by renaming these files with unique words or a unique id, to that people won't be able to guess the next step by its url without solving a challenge. If you do, don't forget to change the Page url where the user clicks to get to the next page.

Create elements of the game in app/game/.vuepress/theme/utils/items.json. Here you can include items to pick up and results of picking up the items. Let your creativity guide you!

Running your site locally

To run this app, you need to fork it and make sure you have your development environment set up for Vue and VuePress development. First, ensure that you have node.js and npm or node and yarn installed.

For VuePress, install the package globally using yarn or npm:

yarn global add vuepress
or
npm install -g vuepress

Follow the instructions here to get set up. When your local system is ready, you can start running this web site for local development.

To run the site locally, use the command:

npm run dev.

Build the site locally:

npm run build.

Deploying your site

You can deploy this site to your own Static Web App: