Skip to content

README.md

Latest commit

 

History

History
45 lines (28 loc) · 1.21 KB

README.md

File metadata and controls

45 lines (28 loc) · 1.21 KB

🕋 Cube Worlds Bot 🎲

Cube Worlds Game Project source code.

See ARCHITECTURE.md for a short system overview.

Usage

Follow these steps to set up and run bot locally:

  1. Environment Variables Setup

    Create an environment variables file by copying the provided example file:

    cp .env.example .env

    Open the newly created .env file and set the environment variables.

  2. Launching the Bot

    Install the required dependencies:

    npm install && npm --prefix src/frontend install

    Start the bot and frontend in watch mode (auto-reload when code changes):

    npm run dev

List of Available Commands

  • npm run dev — Start the bot and frontend in development mode.
  • npm run lint — Lint source code.
  • npm run format — Format source code.
  • npm run typecheck — Run type checking.
  • npm run update:all — Update all dependencies.