npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

roguelike-pumpkin-patch

v1.0.1

Published

A roguelike development library in JavaScript.

Downloads

94

Readme

Roguelike Pumpkin Patch

A library to help you build a cool new roguelike in JavaScript or TypeScript. Pumpkin vines can get pretty long and gnarly, but your code doesn't have to.

See below for instructions on getting or building the library! For usage instructions after that, head over to the documentation!

Current Features

  • HTML and CSS based display; you can use all the CSS features you know and love
  • A cool event manager
  • Pathfinding using A*
  • Field of View
  • Random numbers, and helpful utilities to go with them
  • and more to come!

Getting the library

You can get the library from npm by running:

npm install roguelike-pumpkin-patch

If you want to use a bundle, in the dist directory, there's both a bundled roguelike-pumpkin-patch.js, and a minified roguelike-pumpkin-patch.min.js; link to whichever version you prefer in the head of your page. You can then access the entire library via the bundled RPP object.

You can also get the above bundle from unpkg:

<script src="https://unpkg.com/roguelike-pumpkin-patch/dist/roguelike-pumpkin-patch.min.js"></script>

If you're using a build system like Webpack, you can import whatever components you need directly, i.e.

import { Display, EventManager, Random, FOV, PathFinder } from "roguelike-pumpkin-patch";

You can also use the modules directly in your browser (or when using tsc) via a similar method, i.e.

import { Display } from "./node_modules/roguelike-pumpkin-patch/lib/index.js"

or even

import Display from "./node_modules/roguelike-pumpkin-patch/lib/display/Display.js"

Building

If you want to build the library locally, these instructions are for you!

Start by cloning the repository:

git clone https://github.com/laurheth/roguelike-pumpkin-patch.git

Next, install npm packages:

npm install

Finally, build:

npm run build

History

This was partially inspired by rot.js, which is super cool and I've used for several projects. I wanted to try my hand at building a library, and did much of the work on this as part of pumpkin-related game (hence the pumpkin theme). I made it to help myself with future projects, and I hope that it will be useful for you as well!