Giter Club home page Giter Club logo

board's Introduction

Battlesnake 2019 Board

Build Status

Development

npm i
npm start

Production

npm run build

Running a game

For now you cannot just load the index page or you'll get an error. To make it do something you need to add the query parameters engine (URL of the engine API) and game (ID of the game you want to run). For example:

http://localhost:3000/?engine=http%3A%2F%2Flocalhost%3A3005&game=3bb6f305-04fd-4e16-935a-d7a240154dd6

Board parameters

  • engine - the Battlesnake engine to request frames from.
  • game - the id of the game to fetch frames for.
  • boardTheme - the theme of the board. Values dark / light. Defaults to light.
  • frameRate - the frame rate used in the board. Takes a value equal to FPS. Defaults to 20 FPS.
  • hideScoreboard - remove the scoreboard for embedding cool games. Values true false. Defaults to false.
  • hideMediaControls - remove the controls for embedding cool games. Values true/false. Defaults to false.

Keyboard Shortcuts

If you click on the board you can use:

  • arrow keys to go forwards and backwards through frames.
  • space bar to pause / un-pause the game.
  • r to reset the game to frame 0.

Handy tips

Since it is a common pattern to create a game, start it, and then view it in the browser you can do something like this:

GAME_ID=`engine-cli create -c ~/snake-config.json | cut -d'"' -f 2`
engine-cli run -g $GAME_ID
xdg-open "http://localhost:3000?engine=http%3A%2F%2Flocalhost%3A3005&game=$GAME_ID"

Linting and formatting

ESLint and Prettier are setup in this project so you may want to install compatible plugins in your editor.

board's People

Contributors

brandonb927 avatar bvanvugt avatar codeallthethingz avatar colinjfw avatar dlsteuer avatar graeme-hill avatar louisritchie avatar nbw avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.