Skip to content

remarkablegames/awestruck

Repository files navigation

Awestruck

Awestruck

release build

✨ Awestruck

Play the game on:

Credits

Prerequisites

nvm:

brew install nvm

Install

Clone the repository:

git clone https://github.com/remarkablegames/awestruck.git
cd awestruck

Install the dependencies:

npm install

Update the files:

  • public/app-icon.png
  • public/favicon.png

Environment Variables

Update the environment variables:

cp .env .env.local

Update the Secrets in the repository Settings.

Available Scripts

In the project directory, you can run:

npm start

Runs the game in the development mode.

Open http://localhost:5173 to view it in the browser.

The page will reload if you make edits.

You will also see any errors in the console.

npm run build

Builds the game for production to the dist folder.

It correctly bundles in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your game is ready to be deployed!

npm run bundle

Builds the game and compresses the contents into a ZIP archive in the dist folder.

Your game can be uploaded to your server, itch.io, newgrounds, etc.

Testing

The game supports a few querystring overrides for debugging/playtesting fresh runs.

  • floor: start on a specific floor from 1 to 4
  • reward: start on a specific reward from 1 to 3
  • handSize: change the opening hand size and normal turn draw size
  • deck: provide a comma-separated list of card IDs, or * to load all cards

Start at floor 4:

http://localhost:5173/?floor=4

Start at reward 1:

http://localhost:5173/?reward=1

Start with all cards:

http://localhost:5173/?deck=*&handSize=30

Start with specific cards:

http://localhost:5173/?deck=burn,thorn,focus

Notes:

  • Query overrides are applied only when creating a fresh run
  • Invalid values fall back to the default run setup
  • deck uses card IDs, not display labels

License

MIT