{"id":"metatablecat/catwork","name":"catwork","scope":"metatablecat","platform":"roblox","description":"A tiny Service/Fragment based framework","version":"0.5.0","latest":"0.5.0","versions":["0.1.0","0.4.2","0.4.3","0.4.4-hf1","0.4.4","0.5.0-rc2","0.5.0"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{},"integrity":"f8a587f6794b6c35db3f85b46cfa3bfbd66b6bc29b26bd381d0a51d12e8387bd","likes":0,"downloads":0,"install":"forest install metatablecat/catwork","url":"https://forest.dev/p/roblox/metatablecat/catwork","files":"https://api.forest.dev/ai/package/roblox/metatablecat/catwork/files","readme":"<div align=\"center\">\r\n<img src=\"res/logo.png\" alt=\"The Catwork Logo\" width=400></img>\r\n<h1>Catwork</h1>\r\nThe Cat framework for Roblox! 🐈\r\n</div>\r\n\r\n> [!NOTE]\r\n> Catwork works best in `ReplicatedFirst`, especially since you can then utilise `ReplicatedFirst` loading behaviour.\r\n> Server code can access code in ReplicatedFirst.\r\n\r\nCatwork does not natively come packaged with a runtime, although `Script` instances can safely access the `Catwork`\r\nmodule. You'll need some way of starting `ModuleScript` instances if you wish to take full advantage of the motivations\r\nbehind `Object`s though.\r\n\r\n# Installation\r\n\r\n## In Roblox:\r\n\r\nDownload the latest release and drag it into Studio, or use a tool like [Dropper](https://create.roblox.com/store/asset/13404068475/Dropper-External-file-inserter) to insert it for you.\r\n\r\n## In external editors\r\n\r\nCatwork's stable releases are published to Wally, and you can add it to your package index using the following string:\r\n\r\n```toml\r\ncatwork = \"metatablecat/catwork@0.0.0\" # add the version as neccessary, use the wally index for latest version\r\n```\r\n\r\n# Usage\r\n\r\nThis Object simply greets the player when they join:\r\n\r\n```lua\r\nlocal ReplicatedFirst = game:GetService(\"ReplicatedFirst\")\r\nlocal Catwork = require(ReplicatedFirst.Catwork)\r\n\r\nCatwork.new {\r\n  Init = function(self)\r\n    Players.PlayerAdded:Connect(function(p)\r\n      print(`Hello {p.Name}!`)\r\n    end)\r\n  end\r\n}\r\n```\r\n\r\nThis only scratches the true function of what Catwork can do, `Service` considerably increases the power of\r\nCatwork! See the documentation for more information.\r\n\r\n# License\r\n\r\nCatwork is licensed under the MIT License. 2024 metatablecatgames\r\n\r\n# Sponsor Catwork\r\n\r\nCatwork is maintainted mostly by just me, [support me and what I do!](https://github.com/sponsors/metatablecat)\r\n\r\n# Attributions\r\n\r\nLogo made by Alex. [Website](https://hofnarretje.eu/).\r\n","readmeTruncated":false}