Skip to main content

Getting started

Before you get started​

In order to make a game in Boardzilla you'll need to have:

As well, a knowledge of the following is essential to writing a game in Boardzilla:

As well, some familiarity with the following is useful:

  • React, particularly with JSX
  • esbuild which is used to compile and build your game

Installing the devtools​

The devtools provides your interface for creating, developing and submitting games.

Via homebrew tap​

brew install boardzilla/tap/boardzilla-devtools

And to upgrade:

brew update
brew upgrade boardzilla-devtools

Via go​

This requires you have go version >=1.21 installed which can be obtained from here https://go.dev/dl/.

go install github.com/boardzilla/boardzilla-devtools/cmd/bz@latest

And to upgrade:

GOPROXY=direct go install github.com/boardzilla/boardzilla-devtools/cmd/bz@latest

Via bash​

curl -sfL https://raw.githubusercontent.com/boardzilla/boardzilla-devtools/main/scripts/install | bash -s

And to upgrade re-run the same command.

Via source​

This requires you have go version >=1.21 installed which can be obtained from here https://go.dev/dl/.

git clone https://github.com/boardzilla/boardzilla-devtools
cd boardzilla-devtools
go build -o bz cmd/bz/main.go

After building you'll need to place the bz binary in your path.