NevermoreEngine

<div align="center"> <h1>Nevermore</h1> <p> <a href="http://quenty.github.io/NevermoreEngine/"> <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" /> </a> <a href="https://discord.gg/mhtGUS8"> <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" /> </a> <a href="https://github.com/Quenty/NevermoreEngine/actions"> <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" /> </a> <a href="https://github.com/Quenty/NevermoreEngine/actions"> <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/tests.yml/badge.svg" alt="Tests status" /> </a> </p> <p>ModuleScript loader with reusable and easy unified server-client modules for faster game development on Roblox.</p> <a href="https://quenty.github.io/NevermoreEngine/">View docs →</a> </div> <div>&nbsp;</div> <!--moonwave-hide-before-this-line-->

Why Nevermore?

Code in Nevermore has powered over a billion play sessions on Roblox. Nevermore is used in all Studio Koi Koi games, as well as many other games on Roblox.

Install using npm

Nevermore is designed to use npm or pnpm to manage packages. You can install a package like this.

npm install @quenty/maid

Each package is designed to be synced into Roblox using rojo.

See the installation guide for more details.

Install by copy-and-paste

You can also copy and paste a lot of these libraries into module scripts and with small refactors, have them running anywhere. The closer the package gets to a full-sized gameplay feature (such as Ik), the less likely this is going to be ergonomic.

Packages

There are some packages this repository is known for containing, and have had significant cultural impact on Roblox.

• Maid - Utility object to clean up connections
• Rx - Reactive programming implementation
• Binder - Bind Roblox objects and instances
• Spring and AccelTween - Animation objects
• Signal - Signal implementation
• Promise - Promise implementation on Roblox
• Octree - Spatial data structure that helps with performance
• Blend - Declarative UI framework that makes animations and state-management easy
• DataStore - Battle-tested datastore wrapper
• Camera - Layered camera system that interops with Roblox's cameras

Many of these packages represent not just useful code, but useful patterns, or ways of thinking about programming on Roblox.

All packages

<!--package-list-generated-start-->

There are 270 packages in Nevermore.

| Package | Description | Install | docs | source | changelog | npm | | ------- | ----------- | ------- | ---- | ------ | --------- | --- | | AccelTween | AccelTween implementation for Roblox | npm i @quenty/acceltween | docs | source | changelog | npm | | AccessoryTypeUtils | Utility methods for accessory types | npm i @quenty/accessorytypeutils | docs | source | changelog | npm | | ActionManager | Holds single toggleable actions (like a tool system) | npm i @quenty/actionmanager | docs | source | changelog | npm | | AdorneeBoundingBox | Handles logic for reactive bounding box monitoring | npm i @quenty/adorneeboundingbox | docs | source | changelog | npm | | AdorneeData | Bridges attributes and serialization | npm i @quenty/adorneedata | docs | source | changelog | npm | | AdorneeUtils | AdorneeUtils - Generic adornee functions to make attaching to objects in Roblox easier. | npm i @quenty/adorneeutils | docs | source | changelog | npm | | AdorneeValue | Adorneevalue - Helper class to transform a an adornee into relative positions/information. | npm i @quenty/adorneevalue | docs | source | changelog | npm | | Aggregator | Aggregates async promise requests | npm i @quenty/aggregator | docs | source | changelog | npm | | AnimationGroup | A group of weighted tracks that can be played back with weighted probability. The closest example to this is the idle animation that looks around at a 1:10 ratio when you're standing still in default Roblox animation script. | npm i @quenty/animationgroup | docs | source | changelog | npm | | AnimationProvider | Provides animations for anything tagged with "AnimationContainer" and from a folder named "Animations" in ReplicatedStorage. | npm i @quenty/animationprovider | docs | source | changelog | npm | | Animations | Utility methods for playing back animations on Roblox | npm i @quenty/animations | docs | source | changelog | npm | | AnimationTrackUtils | Utility functions for animations | npm i @quenty/animationtrackutils | docs | source | changelog | npm | | ApplyTagToTaggedChildren | Class that while constructed apply a tag to any children of the parent it is given, assuming that class has the required tag. This lets you bridge tag systems since CollectionService is used as an interop model between many components in scripts. | `npm i @quenty/applyt