📖 Docs · 💻 GitHub

Piku is a Fabric mod that brings Luau scripting to servers! You can build custom UI, cameras systems, and run client-side logic without Java, shader work or extra server load!

Usage

Piku is a client-side mod. Players are not required to use it on Piku servers by default, and is typically used to expand server functionality.

Platforms

Current Features

• Input Handling
  • listening to player's inputs (keyboard, mouse)
• UI System
  • build complex UIs using the 8+ UI components
• Camera System
  • manipulate the player's camera using a full 3-axis movement (roll included), with easings
• Cinematic Camera System
  • manipulate a decoupled camera using 3 axis movement with various movement and animation controls
• Scheduler
  • time-based events and delays
• Shared States
  • sync data between the server and the client
• Client Control
  • tinker with the client using various controls
    • hotbar visibility
    • perspective
    • inventory items
    • nbt
    • play sounds
    • view bobbing
• Debugging
  • built-in script independent logging
• Raycasting
  • client-side raycasting with powerful entity filters and customisation options
• NBT & Components
  • read & write data components of items and entities

To-do List / Roadmap

Tasks labeled here may not be worked on in chronological order.

• ✅ Input Handling
• ✅ Finish UI system (now finished for the most part)
• ✅ Error handling & debugging
  • ✅ log.info, warn, error
• ✅ Time system/scheduler
• ✅ Camera System
  • ✅ Movement/rotation + easing
  • ✅ All 3 axes of rotation
• ✅ World Interaction
  • ✅ Raycasts
  • ✅ Querying blocks/entities on the client
• ℹ️ Client Control
  • ℹ️ Lock/manipulate/animate FOV
  • ✅ Disable/Enable bobbing
  • ✅ Changeable bobbing strength
  • ✅ Querying keybinds on the client
• ℹ️ Player control
  • ℹ️ Disabling view of client or other players' limbs/armor
• ✅ Shared states
• ℹ️ Particle System (GPU based)
• ✅ Write docs