boardgame.io
State Management and Multiplayer Networking for Turn-Based Games
File Explorer
Download Latest Version (.zip)- devcontainer.json
- Dockerfile
- ci.yml
- npm-publish.yml
- dependabot.yml
- FUNDING.yml
- pull_request_template.md
- pre-commit
- pre-push
- index.js
- Client.md
- Game.md
- Lobby.md
- Server.md
- index.html
- index.html
- index.html
- index.html
- index.html
- index.html
- index.html
- example-1.c952ec6d.js
- example-2.e4675089.js
- example-3.1fa4f5db.js
- multiplayer.54b541fd.js
- phases-1.0d4500d6.js
- phases-1.490dcd4c.css
- phases-2.a59f38ac.js
- phases-2.fa21cb61.css
- stages-1.1524ef02.js
- stages-1.bcf7ab84.css
- .nojekyll
- CHANGELOG.md
- chat.md
- concepts.md
- debugging.md
- deployment.md
- events.md
- immutability.md
- index.html
- multiplayer.md
- notable_projects.md
- phases.md
- plugins.md
- random.md
- secret-state.md
- sidebar.md
- stages.md
- storage.md
- testing.md
- theme.css
- turn-order.md
- tutorial.md
- typescript.md
- undo.md
- CNAME
- favicon.png
- index.css
- index.html
- logo-optimized.svg
- logo.svg
- icon.png
- splash.png
- .gitignore
- .watchmanconfig
- App.js
- app.json
- board.js
- game.js
- logo.png
- package.json
- README.md
- rn-cli.config.js
- bishop.js
- CREDITS
- king.js
- knight.js
- pawn.js
- queen.js
- rook.js
- board.js
- chat.js
- checkerboard.js
- checkerboard.test.js
- game.js
- grid.js
- index.js
- multiplayer.js
- singleplayer.js
- token.js
- index.js
- lobby.css
- lobby.js
- routes.js
- board.js
- game.js
- index.js
- board.css
- board.js
- game.js
- index.js
- multiview.js
- board.css
- board.js
- game.js
- index.js
- multiview.js
- example-all-once.js
- example-all.js
- example-others-once.js
- example-others.js
- index.js
- simulator.css
- simulator.js
- index.js
- main.css
- advanced-ai.js
- authenticated.js
- board.css
- board.js
- bots.js
- game.js
- index.js
- multiplayer.js
- singleplayer.js
- spectator.js
- board.js
- game.js
- index.js
- app.css
- app.js
- app.test.js
- index.html
- index.js
- li-navlink.js
- routes.js
- .env
- .gitignore
- package.json
- server.js
- index.html
- index.js
- index.html
- index.js
- index.html
- index.js
- index.html
- index.js
- App.svelte
- game.js
- index.html
- index.js
- Player.svelte
- App.svelte
- game.js
- index.html
- index.js
- Player.svelte
- App.svelte
- game.js
- index.html
- index.js
- Player.svelte
- .gitignore
- install.sh
- package.json
- README.md
- cjs-test.cjs
- esm-test.mjs
- App.css
- App.jsx
- App.test.jsx
- board.css
- board.jsx
- game.js
- index.css
- index.jsx
- server-custom-plugin.ts
- tsconfig.json
- .gitignore
- .npmrc
- index.html
- package.json
- README.md
- vite.config.js
- ai.ts
- client.ts
- core.ts
- debug.ts
- internal.ts
- main.js
- master.ts
- multiplayer.ts
- plugins.ts
- react-native.ts
- react.ts
- server.ts
- testing.ts
- boardgameio.py
- tictactoebot.py
- .gitignore
- boardgameio.py
- test_boardgameio.py
- changelog.js
- clean.js
- dev-client.js
- install-examples.js
- integration.js
- proxy-dirs.js
- rollup-filesize.js
- ai.test.ts
- ai.ts
- bot.ts
- mcts-bot.ts
- random-bot.ts
- AI.svelte
- Options.svelte
- ArrowDown.svelte
- Chevron.svelte
- Info.svelte
- Item.svelte
- Log.svelte
- LogEvent.svelte
- LogMetadata.svelte
- PhaseMarker.svelte
- TurnMarker.svelte
- ClientSwitcher.svelte
- Controls.svelte
- Hotkey.svelte
- InteractiveFunction.svelte
- Main.svelte
- Move.svelte
- PlayerInfo.svelte
- Action.svelte
- MCTS.svelte
- Table.svelte
- debug.test.ts
- JSONTree.mock.svelte
- shortcuts.js
- shortcuts.test.js
- Debug.svelte
- Menu.svelte
- dummy.ts
- local.test.ts
- local.ts
- socketio.test.ts
- socketio.ts
- transport.test.ts
- transport.ts
- client.test.ts
- client.ts
- manager.ts
- react-native.js
- react-native.test.js
- react.ssr.test.tsx
- react.test.tsx
- react.tsx
- action-creators.ts
- action-types.ts
- backwards-compatibility.ts
- constants.ts
- errors.ts
- flow.test.ts
- flow.ts
- game-methods.ts
- game.test.ts
- game.ts
- initialize.ts
- logger.test.js
- logger.ts
- player-view.test.ts
- player-view.ts
- reducer.test.ts
- reducer.ts
- turn-order.test.ts
- turn-order.ts
- client.test.ts
- client.ts
- connection.test.ts
- connection.ts
- create-match-form.tsx
- login-form.tsx
- match-instance.tsx
- react.ssr.test.tsx
- react.test.tsx
- react.tsx
- filter-player-view.test.ts
- filter-player-view.ts
- master.test.ts
- master.ts
- events.test.ts
- events.ts
- random.alea.ts
- random.test.ts
- random.ts
- main.test.ts
- main.ts
- plugin-events.ts
- plugin-immer.test.ts
- plugin-immer.ts
- plugin-log.test.ts
- plugin-log.ts
- plugin-player.test.ts
- plugin-player.ts
- plugin-random.ts
- plugin-serializable.test.ts
- plugin-serializable.ts
- base.ts
- flatfile.test.ts
- flatfile.ts
- index.test.ts
- index.ts
- inmemory.test.ts
- inmemory.ts
- localstorage.test.ts
- localstorage.ts
- generic-pub-sub.ts
- in-memory-pub-sub.test.ts
- in-memory-pub-sub.ts
- socketio-simultaneous.test.ts
- socketio-smoke.test.ts
- socketio.test.ts
- socketio.ts
- api.test.ts
- api.ts
- auth.test.ts
- auth.ts
- cors.test.ts
- cors.ts
- index.test.ts
- index.ts
- util.ts
- mock-random.test.ts
- mock-random.ts
- types.ts
- .empty_module.js
- .gitignore
- .lintstagedrc
- .npmrc
- .prettierignore
- .prettierrc
- AGENTS.md
- AUTHORS
- babel.config.js
- babel.config.test.js
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- eslint.config.js
- jest-svelte-transformer.cjs
- jest.setup.js
- LICENSE
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- roadmap.md
- rollup.config.js
- subpackages.js
- tsconfig.json
# Installation Guide
1. Get the code
git clone https://github.com/boardgameio/boardgame.io
Downloads the entire project code from GitHub to your computer.
cd boardgame.io
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install boardgame.io
Downloads and installs the libraries listed in package.json.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)