{"id":"danieluntask/input","name":"input","scope":"danieluntask","platform":"roblox","description":"A modular input management system for Roblox, supporting keyboard, mouse, touch, and gamepad inputs with client-server integration, contexts, and actions.","version":"0.0.2","latest":"0.0.2","versions":["0.0.1","0.0.2"],"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":"da5bbc391a8cac9926a30a8b68bb00757f6b771ab380f208eb64fda4f8394d72","likes":0,"downloads":0,"install":"forest install danieluntask/input","url":"https://forest.dev/p/roblox/danieluntask/input","files":"https://api.forest.dev/ai/package/roblox/danieluntask/input/files","readme":"# InputSystem\r\n\r\n## [WALLY](\"https://wally.run/package/danieluntask/input?version=0.0.2\")\r\n\r\nA modular input management system for Roblox, designed to provide a unified way to handle player input across different devices.\r\n\r\nInputSystem separates client-side and server-side responsibilities, allowing developers to manage input contexts, actions, and bindings while supporting multiple input methods.\r\n\r\n## Features\r\n\r\n- **Multi-device support** — Handles mouse, keyboard, touch, and gamepad input.\r\n- **Context management** — Organizes input actions into independent contexts.\r\n- **Action management** — Enables, disables, and reads the state of individual actions.\r\n- **Event-driven API** — Provides signals and callbacks for responding to input events.\r\n- **Player-specific input** — Each player receives an independent input configuration.\r\n- **Resource management** — Uses an internal `Scope` system to manage connections and resources.\r\n- **Type safety** — Built with Luau strict type checking.\r\n\r\n## Documentation\r\n\r\nExplore the documentation for each module:\r\n\r\n### Main Modules\r\n\r\n| Module | Description |\r\n|---|---|\r\n| [InputClient](docs/input-client.md) | Client-side input management, including contexts, actions, bindings, and input events. |\r\n| [InputServer](docs/input-server.md) | Server-side input initialization and management for individual players. |\r\n\r\n### Input Components\r\n\r\n| Component | Description |\r\n|---|---|\r\n| [Mouse](docs/mouse.md) | Mouse input handling, including buttons, movement, position, and raycasting. |\r\n| [Touch](docs/touch.md) | Touch input handling, including taps, gestures, swipes, and touch events. |\r\n| [Keyboard](docs/keyboard.md) | Keyboard input handling and key state detection. |\r\n| [Gamepad](docs/gamepad.md) | Gamepad input handling and controller events. |\r\n\r\n## Usage\r\n\r\nInputSystem provides separate entry points for client and server environments.\r\n\r\n### Server\r\n\r\nRegister the player input template before starting the server module.\r\n\r\n```luau\r\nconst InputServer = require(path.To.InputServer)\r\n\r\nInputServer:registerPlayerInput(\r\n    game.ServerStorage.PlayerInputs\r\n)\r\n\r\nInputServer:start()\r\n```\r\n\r\n### Client\r\n\r\nStart the client module to load the local player's input contexts and actions.\r\n\r\n```luau\r\nconst InputClient = require(path.To.InputClient)\r\n\r\nInputClient:start()\r\n```\r\n\r\nOnce initialized, you can retrieve contexts and actions, read their states, and connect to their events.\r\n\r\n```luau\r\nconst jumpAction = InputClient:getActionAsync(\r\n    \"Gameplay\",\r\n    \"Jump\"\r\n)\r\n\r\nInputClient:onPress(\"Gameplay\", \"Jump\", function()\r\n    print(\"Jump pressed\")\r\nend)\r\n```\r\n\r\nFor more information, see the [InputClient documentation](docs/input-client.md) and [InputServer documentation](docs/input-server.md).","readmeTruncated":false}