{"id":"zarchify/zarch","name":"zarch","scope":"zarchify","platform":"roblox","description":"A strictly typed heirarchical state machine library for roblox.","version":"0.1.4","latest":"0.1.4","versions":["0.1.0","0.1.1","0.1.2","0.1.3","0.1.4"],"license":"MIT","licenseRating":"safe","licenseCaveats":["The package archive does not include its license text; the license is declared in its manifest metadata."],"licenseVerified":false,"dependencies":{},"integrity":"ce1669223d711ff02e9b6f4b660331496ac694f74365fd4da579b823dd18b1ac","likes":0,"downloads":0,"install":"forest install zarchify/zarch","url":"https://forest.dev/p/roblox/zarchify/zarch","files":"https://api.forest.dev/ai/package/roblox/zarchify/zarch/files","readme":"# Zarch \r\n\r\n**A strictly-typed, lightweight hierarchical state machine (HSM) library for Roblox.**\r\n\r\n## Overview\r\n\r\nZarch is a minimal implementation for managing complex state-driven architectures within Roblox projects, with a massive focus on **complete Luau type-safety** and a clean API.\r\n\r\n> **Note:** This library is a direct, heavily-inspired rewrite of the fantastic [Arch library by bohraz](https://github.com/bohraz/Arch). Zarch is a rewrite of Arch with a focus on strict typing and a more minimal API.\r\n\r\n## Why Zarch?\r\n\r\n- **Strictly Typed:** The primary benefit to using Zarch over arch is the strict typing. \r\n- **Hierarchical State Management:** Zarch enables the creation of a structured system where states can be organized hierarchically, offering a clear and intuitive way to represent complex game behaviors.\r\n- **Parallel State Management:** Zarch allows for the management of multiple states simultaneously, enabling the creation of complex game mechanics that require concurrent state handling.\r\n- **Lightweight & Zero-Dependency:** minimal API with no bloat. \r\n\r\n## Installation\r\n\r\n\r\n### [Wally](https://wally.run/)\r\nAdd the following to your `wally.toml`:\r\n```toml\r\n[dependencies]\r\nzarch = \"zarchify/zarch@0.1.4\"\r\n```\r\n\r\n### [Pesde](https://pesde.dev/)\r\nAlternatively, install via pesde:\r\n```bash\r\npesde install zarchify/zarch\r\n```\r\n\r\n## Quick Start Example\r\n\r\nI reccomend you refer to the [Arch](https://github.com/bohraz/Arch) documentation for a more in depth look at how to use state machines.\r\n\r\n## Acknowledgements \r\n\r\nZarch would not exist without the foundational blueprint established by [Arch](https://github.com/bohraz/Arch). Massive credit to **bohraz** for their original design. \r\n\r\n## License\r\n\r\nZarch is licensed under the MIT License.\r\n","readmeTruncated":false}