/word-hunt-online

Primary LanguageTypeScript

Word Hunt Online

A clone of Game Pigeon's WordHunt (a form of Boggle) for the GameJay Telegram bot gaming platform.

To Develop

See the GameJay README for details on the API flow.

Environment

  • Should run on the latest LTS node version (if it doesn't, please update and make a PR!)
  • Snowpack is used to bundle the site for deployment and also spin up a development server. It is included in the devDependencies
  • As of now, there's no machine-specific .env file, but there is a src/env.ts with configurable variables
    • SERVER_URL should point to the backend GameJay server you want to use, either local or remote
  • The static files that get bundled into the build, including the index.html entrypoint, are in public.
    • Assets like images are stored in public/assets

Install npm packages

npm i

Development Server

npm run dev

Deploy

Output the website's files for deployment to the _build folder.

npm run build

Engine

The whole game is basically pure Phaser. A word matching game probably doesn't need a whole engine like Phaser but it was convenient for my skill-set. Phaser has a lot of examples to use for learning.