Lua Modding | Palworld Modding Docs

📄️ Introduction

Lets set some ground rules so you don't complain about us wasting your time:

📄️ Lua Modding Tools

If you already know the tools, you can skip ahead, but don't blame us if we reference something and you don't know what we're talking about.

📄️ Lua Mod Structure

Now that we have our tools set up, to create a lua mod, we need to head into Mods folder of our workspace.

UE4SS comes with a built-in Lua API. Part of that is an array of useful functions that let us do cool stuff. In this section we're going to cover some of the more useful functions in the context of how they might get used in Palworld.

📄️ Intro to Hooking Functions

In this tutorial, we will be hooking the function responsible for summoning a pal from your party.

📄️ Digging 101

Alright so at this point you maybe sorta understand some of the base functions available to you in UE4SS, but I know most of you are probably stuck on how to figure out what functions to actually hook onto or call to do whatever you actually want to do.

📄️ Moar Digging

Dig it uh oh oh, dig it

📄️ Config Files

Now that you have a working base area mod, you could technically just release that as is and have people change the value in the main file. But that's lame and it's nice to provide a config file for better user experience. So here's a real brief lesson on that (which also doubles as an example on how to use separate files)

📄️ DataTables

(this section should proably be reworked with it's own follow along tut when someone gets a chance)

📄️ Lua Basics

LUA is a lightweight and easy to learn programming language. In this section, we will cover the basic structure of a LUA script, as well as the different data types available and how to manipulate them.

📄️ Using Blueprints with Lua

When writing a Lua mod, you can call a method inside a ModActor blueprint. This is useful, as your Lua mod can hook into functions that aren't exposed via Blueprints, then you can create most of your mod's functionality within Blueprints. If you haven't yet, follow the steps to make a basic Blueprint mod in the Creating A Blueprint Mod section, and then come back to this section.