❓ KAPLAY-UI — FAQ
Frequently asked questions about the KAPLAY UI plugin.
📚 Table of Contents
🧠 General
Q: What is this plugin for?
A: KAPLAY UI provides lightweight, composable UI helpers — such as text‑based buttons and labels — built using familiar KAPLAY primitives.
It reduces boilerplate, keeps UI consistent, and helps you build menus, HUDs, overlays, and interactive UI faster.
📦 Installation
Q: How do I install KAPLAY UI?
A: Install from your project root using your preferred package manager:
npm install kaplay-ui@next
🚀 Usage
Q: How do I use the kaplay-ui plugin?
A: Import and enable the plugin when creating your KAPLAY instance:
import kaplay from "kaplay";
import kaplayUI from "kaplay-ui";
const k = kaplay({
plugins: [kaplayUI],
});
Now you can create UI components such as:
k.addTextButton("Play");
k.addLabel("Score: 0");
📄 Licensing
Q: How may I use kaplay-ui ?
A: The MIT License allows full personal and commercial use with virtually no restrictions.
🔓 **In short:** You can use, modify, distribute, and even sell projects using KAPLAY UI.