Forage Quest

Forage Quest is a Phaser 3 proof of concept game to explore simple top down gameplay. The goal of the game is to complete simple quests by foraging the requested items from the map.

Expected input support

• Keyboard
• XBox Controller
• PS4/5 Controller
• Switch Pro Controller

Requirements

DO NOT INSTALL THESE ON YOUR OWN ACCORD. READ THE DEVELOPMENT ENVIRONMENT SETUP INSTRUCTIONS BELOW.

Windows

• WSL (Windows Subsystem for Linux)

And:

Windows and Mac

• nodejs 16+
• yarn 2+
• git

Development environment setup

Windows

From administrator powershell prompt:

• Install and run WSL (Windows Subsystem for Linux)

  wsl --install
  wsl
  

• Install git

  sudo apt update
  sudo apt upgrade
  sudo apt install git-all
  

Then:

Windows (WSL) and Mac

• Install nvm (node version manager)

  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
  source ~/.bashrc
  

• Install nodejs

  nvm install node
  

• Install yarn via corepack

  corepack enable
  corepack prepare yarn@stable --activate
  

• Install Visual Studio Code

• Create a workspace folder in your home directory

  mkdir ~/workspace
  cd ~/workspace
  

• Clone the repository

  git clone https://github.com/kylelawrence/foragequest.git
  cd foragequest
  

• Run yarn to install dependencies for the project

  yarn
  

• Open VS Code to the project directory

  code .
  

• Install VS Code Extensions

  • Prettier

• Start the project

  yarn dev
  

Learning resources

• Phaser 3
• Typescript
• Yarn
• Vite
• GitHub