0.2.2 • Published 2 years ago

@yewyewxd/react-simple-snake v0.2.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

react-simple-snake

GitHub npm npm peer dependency version npm

A simple snake game created with the React JavaScript library.

Demo

Website

A demo is available here.

Installation

To add it to your react app

  • npm install react-simple-snake

To launch the development server

  • git clone https://github.com/MaelDrapier/react-simple-snake.git
  • cd react-simple-snake
  • npm install
  • npm start

Dependencies

This project needs react to operate. Install it with npm install react

Usage

To import it in your component

import Snake from 'react-simple-snake'

export default function YourComponent() {
  return(
    <div>
      <Snake />
    </div>
  )
}

Props

All props are optional

PropTypeDefault valueDescription
percentageWidthnumber40A percentage defining the width of the game board, based on the width of the game's parent element
startSnakeSizenumber6The starting size of the snake
snakeColorstringrandomThe color of the snake
appleColorstringrandomThe color of apples

How to play

You can move the snake with the arrow keys or W / A / S / D.

High-Score

The highest score is saved locally in the browser's local storage, in a snakeHighScore field.