Is Godot LuaAPI still being developed?

No, the repository has been archived, and the maintainer has no time for updates. Forks are encouraged, but there's no official active development or support for new features or bug fixes.

How do I expose a GDScript function to Lua in Godot?

Use the push_variant method to expose Callables as Lua functions. For example, lua.push_variant('my_function', Callable(self, '_my_function')) makes it available in Lua, as shown in the README's getting started example.

Godot LuaAPI vs godot-lua-pluginscript for modding?

Godot LuaAPI is focused on sandboxed modding APIs with strict access controls for security, while godot-lua-pluginscript is more general for Lua scripting without built-in sandboxing. Choose based on whether you need enforced security or more flexibility.

Can I use LuaJIT with Godot LuaAPI?

Yes, release builds include LuaJIT variants for performance improvements, such as 'gdextension-LuaJIT.zip'. Download these from the releases page to leverage faster Lua execution in your project.

What are the security risks with Godot LuaAPI?

The sandboxing minimizes risks by controlling access, but if not properly configured—like exposing unsafe libraries—modders might exploit exposed functions. Always limit libraries and validate inputs to enhance security.

How to handle errors when running Lua code in Godot?

Methods return LuaError objects on failure. Check for LuaError after operations like do_string or pull_variant, and use the type and message properties for error handling, as demonstrated in the README example.

Open-Awesome

godot-luaAPI

NOASSERTIONC++v2.1-beta11

A Godot addon that adds Lua API support for creating sandboxed modding environments in GDScript, C#, or GDExtension.

Visit Website GitHub

419 stars39 forks0 contributors

What is godot-luaAPI?

Godot LuaAPI is a Godot Engine addon that provides Lua scripting support for creating custom modding APIs in a sandboxed environment. It allows game developers to expose specific engine functionalities to modders while restricting access to sensitive parts, enabling secure user-generated content without compromising game integrity.

Target Audience

Godot game developers who want to add modding support to their games with controlled, sandboxed Lua scripting, particularly those building games where user-generated content is a key feature.

Value Proposition

Developers choose Godot LuaAPI for its focused sandboxing capabilities, which offer more security than native scripting alternatives, and its flexibility in supporting multiple Godot scripting languages (GDScript, C#, GDExtension) for integration.

Overview

Godot LuaAPI

Use Cases

Best For

Adding secure Lua-based modding systems to Godot games
Creating sandboxed APIs for user-generated content
Integrating Lua scripting with GDScript, C#, or GDExtension projects
Controlling modder access to specific engine features
Building games with customizable mod support without exposing core engine functionality
Developing modding tools that require error handling and coroutine management

Not Ideal For

Games that don't require modding support or user-generated content
Developers wanting to use Lua as the primary game scripting language without sandboxing constraints
Projects needing actively maintained addons with frequent updates and community support
Small-scale modding implementations where building a custom API from scratch is overkill

Pros & Cons

Pros

Secure Sandboxing

Provides a controlled environment where modders can only access explicitly exposed engine features, preventing unauthorized modifications and enhancing security for user-generated content, as emphasized in the README.

Multi-language Integration

Supports integration via GDScript, C#, or GDExtension, allowing developers to use their preferred Godot scripting language while building Lua APIs, offering flexibility across projects.

Flexible Object Handling

Allows pushing Godot Variants as globals, passing objects as userdata, and exposing Callables as Lua functions, enabling complex interactions between Lua and Godot, with examples in the README like Vector2 operations.

Customizable Libraries

Developers can select which Lua standard libraries (e.g., base, table, string) are available to modders, giving fine-grained control over the scripting environment for security and functionality.

Cons

Archived Project

The repository is archived with no active maintenance, risking compatibility issues with future Godot versions and leaving users without official support or updates, as warned in the README.

Complex Setup Process

Requires compiling from source or downloading specific builds, and separate export templates are needed for deployment, adding significant overhead compared to plug-and-play addons, noted in the 'Getting Started' section.

High Initial Effort

Building a custom modding API from scratch is more work than using native scripts or other modding solutions, as admitted in the README, making it less suitable for quick or simple implementations.

Frequently Asked Questions

Related Projects

Pixelorama

Unleash your creativity with Pixelorama, a powerful and accessible open-source pixel art multitool. Whether you want to create sprites, tiles, animations, or just express yourself in the language of pixel art, this software will realize your pixel-perfect dreams with a vast toolbox of features. Available on Windows, Linux, macOS and the Web!

Demonstration and Template Projects

Stars9,678

Forks2,264

Last commit15 days ago

Lorien

Infinite canvas drawing/whiteboarding app for Windows, Linux and macOS. Made with Godot.

Stars6,860

Forks314

Last commit1 year ago

Dialogic

💬 Create Dialogs, Visual Novels, RPGs, and manage Characters with Godot to create your Game!

Stars6,080

Forks361

Last commit1 month ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub