Gamewall SDK

⚠️ WORK IN PROGRESS Not all documented features are fully implemented yet.

Game development kit for the Gamewall platform. Includes build tools, simulator integration, and runtime validation.

⚠️ Builds only run inside the Gamewall environment.

Getting Started

Create a new project:

npm create gamewall@latest

or:

npx gamewall create

Manual install:

npm install gamewall

Recommended scripts:

{
  "start": "gamewall serve",
  "build": "gamewall build --output-folder dist"
}

Development

Run dev mode:

npm start

• Builds and serves on localhost:31302
• Auto-connected to the Gamewall simulator
• Supports reload and hot reload
• Use browser devtools for debugging

Build

npm run build

Outputs a .gwpack file ready for submission.

Manifest

Defines how your game runs inside Gamewall.

Minimal

gameWallSpec: '2.0'

name: My Game
codename: my-game
version: '1.0.0'

screensAvailable:
  - screen

defaults:
  screen: screen
  controller: null
  scoreboard: null

playerCount:
  exact: 1

settings:
  tickRate: 64
  queueLength: 50

Extras (optional)

Sensors

sensors:
  vision: pose

→ also accepts array or object

Configurables

configurables:
  - id: example
    type: string
    default: 'value'

Types: string | number | boolean | color | file | select | multiselect | list | object

Rules:

rules:
  required: true
  min: 1
  max: 10
  minLength: 3
  maxLength: 20
  nullable: true

Legal Disclaimer

Copyright (c) 2024, Mondriaan DC Kft.

This software is intended for use to contracted partners of its respective authors. Access to this software shall not be construed as a license to use, modify, or distribute this software. License to use this software is granted only through a separate written agreement.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.