{"id":"sstunickss/simpleframework","name":"simpleframework","scope":"sstunickss","platform":"roblox","description":"A framework for importing modules and managing remote signals (client/server) in a Roblox game!","version":"1.1.6","latest":"1.1.6","versions":["1.1.1","1.1.2","1.1.3","1.1.5","1.1.6"],"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":"d3e4cd5f3ef0883b236a9a33a5a5fe3b3b5f7a82ac37998b3f5a2a258a96cae5","likes":0,"downloads":0,"install":"forest install sstunickss/simpleframework","url":"https://forest.dev/p/roblox/sstunickss/simpleframework","files":"https://api.forest.dev/ai/package/roblox/sstunickss/simpleframework/files","readme":"# SimpleFramework  \r\n\r\n## Importing SimpleFramework  \r\n\r\n### LocalScript\r\n```lua\r\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\r\n\r\nlocal SimpleFramework = require(ReplicatedStorage.SimpleFramework)\r\n\r\nSimpleFramework:Import({\r\n    ReplicatedStorage.Controllers\r\n})\r\n```\r\n\r\n### ServerScript\r\n```lua\r\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\r\nlocal ServerScriptService = game:GetService(\"ServerScriptService\")\r\n\r\nlocal SimpleFramework = require(ReplicatedStorage.SimpleFramework)\r\n\r\nSimpleFramework:Import({\r\n    ServerScriptService.Services\r\n})\r\n```\r\n\r\n---\r\n\r\n## Life Cycle Module Functions\r\n```lua\r\nfunction ExampleModule:Init(): ()\r\n    -- Called when the module is first imported; used for setup.\r\nend\r\n\r\nfunction ExampleModule:Start(): ()\r\n    -- Called after all modules have been initialized; used for starting processes.\r\nend\r\n\r\nfunction ExampleModule.PlayerAdded(player: Player): ()\r\n    -- Called when a player joins the game\r\nend\r\n\r\nfunction ExampleModule.PlayerRemoving(player: Player): ()\r\n    -- Called when a player leaves the game\r\nend\r\n```\r\n\r\n---\r\n\r\n## Example Usage\r\n\r\n### Service Example\r\n```lua\r\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\r\nlocal SimpleFramework = require(ReplicatedStorage.SimpleFramework)\r\n\r\nlocal Remote1 = SimpleFramework:CreateSignal(\"Remote1\", \"Reliable\")\r\n\r\nlocal Service = {}\r\n\r\nfunction Service:Init()\r\n    print(\"Server Init\")\r\nend\r\n\r\nfunction Service:Start()\r\n    print(\"Server Start\")\r\n\r\n    Remote1:Connect(function(player, var)\r\n        print(player, var)\r\n    end)\r\nend\r\n\r\nreturn Service\r\n```\r\n\r\n### Controller Example\r\n```lua\r\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\r\nlocal SimpleFramework = require(ReplicatedStorage.SimpleFramework)\r\n\r\nlocal Remote1 = SimpleFramework.Remotes.Service.Remote1 :: SimpleFramework.ClientRemote\r\n\r\nlocal Controller = {}\r\n\r\nfunction Controller:Init()\r\n    print(\"Controller Init\")\r\nend\r\n\r\nfunction Controller:Start()\r\n    print(\"Controller Start\")\r\n    Remote1:Fire('Hello')\r\nend\r\n\r\nreturn Controller\r\n```\r\n\r\n## Games made with Simple Framework\r\n[Southern Mudding](https://www.roblox.com/games/79480724066456/Southern-Mudding-OffRoading)\r\n\r\n[Riot City](https://www.roblox.com/games/113745337705295/Riot-City-Prison-Escape)","readmeTruncated":false}