{"id":"steamautomata/harmony","name":"harmony","scope":"steamautomata","platform":"roblox","description":"Simple and bloated Roblox Framework","version":"0.0.1-rc7","latest":"0.0.1-rc7","versions":["0.0.1-rc3","0.0.1-rc4","0.0.1-rc5","0.0.1-rc6","0.0.1-rc7"],"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":{"howmanysmall/janitor":{"version":"^1.17.0","alias":"Janitor"},"elitriare/bytenet-max":{"version":"^0.1.9","alias":"bytenet-max"},"sleitnick/trove":{"version":"^1.5.0","alias":"trove"},"lm-loleris/profilestore":{"version":"^1.0.2","alias":"ProfileStore"}},"integrity":"f946b6ca0ade90cd2010b2824ebf179e7e5b9f8bcf16de61a4af1822b324649f","likes":0,"downloads":0,"install":"forest install steamautomata/harmony","url":"https://forest.dev/p/roblox/steamautomata/harmony","files":"https://api.forest.dev/ai/package/roblox/steamautomata/harmony/files","readme":"# Harmony Framework\r\n\r\n## A bloated but battery-included framework!\r\n\r\nKeep It Simple & Smart! No fancy `import(\"YourService\")` function that breaks Luau types.\r\nJust `require` it!\r\n\r\n### TODO\r\n\r\nHarmony isn't finished yet, checklist:\r\n\r\n- [x] Providers\r\n- [ ] Components\r\n- [ ] More lifecycles\r\n- [ ] Global State Management\r\n- [ ] Player State Management\r\n- [ ] Component & Service & value telemetry\r\n- [ ] Iris Integration\r\n\r\n### The goals:\r\n\r\n- Manage to work around Luau typings while keeping the code readable\r\n- Be as complete as possible\r\n- Make use of third party libraries\r\n- Diagnose bugs easily\r\n\r\n### Features:\r\n\r\n- Guarantee Luau types\r\n- Replicated Global & Player State management\r\n- Providers (Equivalent of Services and Controllers)\r\n- Components\r\n- Events (Equivalent of Lifecycles in Flamework)\r\n\r\n### Dependencies:\r\n\r\n- ByteNet\r\n- Iris\r\n- Signal\r\n- Janitor\r\n\r\n# Using Harmony\r\n\r\nThe Roblox Studio plugin is optional. It provides a quick way to create Providers & Components\r\n\r\n# Why Harmony ?\r\n\r\nBecause not Melody!\r\n\r\n# Flaws & Drawbacks\r\n\r\nAs it uses Single Script Architecture, it is not recommended to use `Actor` as it creates more Luau VMs and you will end up with two Singletons instead of one as expected.\r\n\r\nNo other drawbacks are found from using this framework yet, except that it hasn't been battle tested yet.\r\n","readmeTruncated":false}