This library contains the ECS used by the Mischief Game Engine.

This version of Mischief isn't meant for public use. It's just a pre-release published mostly to showcase the documentation.

Mischief has various meanings. It can be a group of rats. Or it can refer to being naughty and playful.

This Mischief, however, is an ECS Game Engine! In other words...

Mischief :: Entity -> Component c => System ()

Mischief takes great inspiration from Bevy and Flecs, and was written in 100% Haskell, taking advantage of its great ergonomics and strong type system. It is a refreshing spin on the functional and data-driven paradigms.

Package

This package contains only mischief-ecs, the ECS at the core of Mischief. Other packages, such as mischief-input, mischief-assets, mischief-render are planned, but haven't yet been developed to the same level as the ECS itself.

Design Goals

There are the main design goals of Mischief:

• Ergonomics. Mischief's main purpose is to provide a very clean, intuitive, high-level API. This is the main way we differentiate ourselves from other ECS's.
• Functional. While the core logic of Mischief is highly mutable and dynamic for the sake of performance, the high-level API is tailored to be immutable and encourage the functional programming paradigm.
• Modularity. Mischief is meant to be modular, allowing you to plug packages in and out, whether they are made by us or a third party.

Performance

Performance-wise, Mischief still has a long way to go; there are many easy performance gains that we have just been too busy to implement, as we've been mostly focusing on ergonomics, modularity, and ease-of-use. This is a pretty strong Archetype ECS however, and it is possible to bring it to about the same asymptotic performance as Bevy or Flecs, although there will probably always be a layer of indirection (or 20) that makes it a bit slower, due to the high-level, boxed, nature of Haskell.

In order to learn how to use Mischief, you can read through the official book:

1. Startup Guide
2. Coding a Dungeon Game
3. App and Plugins
4. Components
5. Relationships
6. Queries
7. Systems
8. Events and Messages