Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.3 KB

README.md

File metadata and controls

40 lines (31 loc) · 1.3 KB

jsrl

JavaScript Roguelike Template - The basics to start building your own

What is this?

In this repo you will find a bare-bones roguelike with a character-based display, and tools to bundle it for the web.

Check out the online demo at: https://slashie.net/jsrl

What is this good for? the idea is you take this simple game and start adding what makes your roguelike unique!

Features

  • Player can walk around
  • Raycasting Field of View algorithm
  • Player can move between persistent levels
  • Enemies move around chasing the player
  • Player can pick up, drop and use items (including using items on a given direction)
  • Player remember visited maps
  • A simple Being class based on Races definitions, with random and follow player intents
  • A simple Item class based on Item Type definitions
  • Infrastructure for Level Generation
  • Line wrap text boxes

How to use

  • git clone [email protected]:slashman/jsrl.git
  • cd jsrl
  • rm -rf .git (Delete .git folder)
  • Create awesoem gaem

Local Development Server

  • yarn install or npm install
  • yarn start or npm start
  • Open your browser to http://localhost:1234

Building Distribution

  • yarn run build or npm run build
  • Directory dist will contain the web directory you can serve

Credits

Uses unicodetiles for IO - http://tapiov.net/unicodetiles.js/