Skip to content

README.md

Latest commit

 

History

History
59 lines (37 loc) · 1.17 KB

README.md

File metadata and controls

59 lines (37 loc) · 1.17 KB
Raw

awe-cli

NPM Package

A command-line tool that enables local development of game scripts for awe.box games, allowing you to use your preferred code editor while automatically syncing changes with the awe.box platform.

Development Workflow

  1. Optionally, create a new game in awe.box website if you don't have one yet.

  2. In your local project directory, run

npx awe-cli checkout <gameId>
  1. Run
npm run start

to start the development server.

Available Commands

Development Server

npm run start

Starts the development server, automatically syncs local scripts, and opens the awe.box studio in your default browser.

Watch Mode

npm run watch

Watches for local changes and automatically pushes them to the remote game.

Manual Sync

npm run push

Manually pushes local changes to the remote game.

Authentication

npm run login    # Login to AWE platform (automatic when running other commands)
npm run logout   # Logout from AWE platform