Skip to content

TimAstier/react-roguelike

Repository files navigation

React Roguelike

A roguelike game built with React and TypeScript.

https://react-roguelike-demo.netlify.app

CircleCI All Contributors

Screenshot 2021-05-08 at 10 29 27

How to play

Go to https://react-roguelike-demo.netlify.app to start a new game.

The level editor is available here.

Built with

  • react - a JavaScript library for building user interfaces
  • typescript - a typed superset of JavaScript that compiles to plain JavaScript
  • konva.js - HTML5 2d canvas js library
  • react-konva - declarative canvas components for React
  • use-immer - a hook to use immer as a React hook to manipulate state
  • styled-components - a convenient way to style components with CSS
  • use-sound - a React Hook for Sound Effects
  • seedrandom - seeded random number generator for JavaScript
  • fontfaceobserver - a fast and simple web font loader
  • RPG Dice Roller - easy advanced dice rolling

Contributing

You are welcome to contribute to this project! See CONTRIBUTING.

Roadmap

See ROADMAP.

Installation

# Clone the repository
$ git clone https://github.com/TimAstier/react-roguelike

# Install dependencies
$ cd react-roguelike
$ yarn install

# Start the app
$ yarn dev

# Open a browser tab at http://localhost:3000/

Deployments:

Merging commits to master will auto-deploy to:
https://react-roguelike-demo.netlify.app

Manual deployment

yarn build
netlify deploy
# specify "build" as directory
netlify deploy --prod

Credits

License

This project is licensed under the MIT License.
See the LICENSE file for details.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Timothée Astier
Timothée Astier

💻 📖 🚧 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!