lua-creation-setup

Automates Lua scripting setup and bindings for Irreden Engine creations.

8|Updated Oct 11, 2023
One-click install
npx skills add https://github.com/jakildev/IrredenEngine --skill lua-creation-setup
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: lua-creation-setup
Source: https://github.com/jakildev/IrredenEngine/tree/main/.cursor/skills/lua-creation-setup
Command: npx skills add https://github.com/jakildev/IrredenEngine --skill lua-creation-setup

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Lua scripting setup for Irreden Engine creations often requires boilerplate, bindings, and wiring that slow down project initialization. This Skill provides a ready-made scaffold to configure Lua bindings, expose components to Lua, and manage config and entry scripts.

Core Features & Use Cases

  • Scaffolds a complete Lua integration: main_lua.cpp, lua_bindings.hpp/cpp, lua_component_pack.hpp, config.lua, and main.lua.
  • Enables safe, ordered binding registration before engine initialization to ensure runtime stability.
  • Supports bulk registration of Lua-bound components via a component-pack mechanism and exposes APIs (IREntity, IRAudio, IRRender, IRText) to Lua.
  • Includes a clear Quick Start guide and CMake sync notes to keep runtime scripts up to date across builds.

Quick Start

Follow the scaffold to initialize Lua scripting for your creation, register bindings, expose components, and wire the main Lua entry before build.

Frequently Asked Questions about lua-creation-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up Lua scripting bindings for Irreden Engine creations?

To set up Lua scripting bindings for Irreden Engine creations, you can scaffold a complete integration that generates main_lua.cpp, lua_bindings.hpp/cpp, config.lua, and main.lua files. This provides a ready-made wiring structure to expose components and manage script entry points.

What is the correct order for registering Lua bindings before engine initialization?

Registering Lua bindings before IREngine::init ensures runtime stability. The setup process applies ordered binding registration to safely expose APIs like IREntity, IRAudio, IRRender, and IRText to Lua scripts prior to the engine fully initializing.

How can I bulk register Lua-bound components in Irreden Engine?

You can bulk register Lua-bound components using the lua_component_pack mechanism. This component-pack approach allows you to expose multiple components to Lua simultaneously, streamlining the registration process during your creation's initialization.

Does the Lua setup scaffold include CMake sync guidance for runtime scripts?

Yes, the Lua setup scaffold includes CMake sync notes to keep runtime scripts updated across builds. This ensures that your config.lua and main.lua files remain synchronized with your CMake build system.

What files are generated when scaffolding Lua integration for a new creation?

Scaffolding Lua integration generates main_lua.cpp, lua_bindings.hpp, lua_bindings.cpp, lua_component_pack.hpp, config.lua, and main.lua. These template files provide the necessary boilerplate to configure bindings and wire the main Lua entry point.