@relish-studios/dill-pixel NPM

Dill Pixel

Framework for HTML game development, made by Relish Studios.

Introduction

Why make this game framework?

PIXI.js is a great rendering engine, but it is not a game engine. It is not opinionated about project structure and does not provide any common game development tools. This framework is designed to fill that gap. It is Relish's opinionated approach to game development using PIXI.js.

Core Features

Prerequisites

This framework is intended for HTML game developers. You should have a working knowledge of game development, PixiJS, and Typescript to get started.

Installation

Usage

Documentation

Available here: Docs
Documentation is very much a work in progress and is incomplete.

Migrating from the old HLF framework

If you are a Relish developer you should know HLF is changing to Dill Pixel! View the Migration Guide for more information. Looking for old info that was in the README? Look for the Legacy HLF Guide under references in the docs.

Development

How to build

Note that for most users you don't need to build this project. If all you want is to use PixiJS, then just download one of our prebuilt releases. The only time you should need to build PixiJS is if you are developing it.

If you don't already have Node.js and NPM, go install them. Then, in the folder where you have cloned the repository, install the build dependencies using npm:

npm install

For development:

npm run dev

To build the source:

npm run build

How to generate the documentation

The docs can be generated using npm:

npm run docs

The documentation uses Starlight an Astro based framework for documentation.

Testing

Want to help out?

We welcome your contributions as bug fixes, new features, or bug reports and enhancement requests. Check out the Contributors Guide to find out how you can help!

We also suggest you review the Code of Conduct to understand our policies.