Palworld Modding Docs

https://pwmodding.wiki/docs/
Admin
Comprehensive documentation and guides for modding Palworld, covering Lua scripting, the Palworld...
Tokens:22,913
Snippets:317
Trust Score:5.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Default Wwise SDK Path

Source: https://pwmodding.wiki/docs/developers/palworld-modding-kit/installation

The standard installation directory for the Wwise SDK required for manual integration.

```text
C:\Program Files (x86)\Audiokinetic\Wwise 2021.1.11.7933\SDK
```

--------------------------------

### Example Change Notes

Source: https://pwmodding.wiki/docs/developers/mod-publishing/workshop/uploading

A concise format for documenting mod updates during the upload process.

```text
- Added more skin variations for Chillet.  
- Fixed Cattiva spinning in place when a custom skin is applied to it.  
- Removed unnecessary double confirmation window when applying a skin.  

```

--------------------------------

### Subscribe to Component Creation

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/hooking-functions

Initial setup to detect when the Otomo component is created using NotifyOnNewObject.

```lua
print("Hello world from Lua!")  
  
RegisterHook("/Script/Engine.PlayerController:ClientRestart", function (Context)  
    NotifyOnNewObject("/Game/Pal/Blueprint/Component/OtomoHolder/BP_OtomoPalHolderComponent.BP_OtomoPalHolderComponent_C", function (Component)  
        print("New component!")  
    end)  
end)  
```

--------------------------------

### Mod Description Installation Template

Source: https://pwmodding.wiki/docs/developers/mod-publishing/workshop/uploading

A recommended template using Steam formatting to instruct users on how to enable mods in-game.

```text
[h1]Important[/h1]  
After you subscribe to the mod, do these steps to enable the mod:  
  
1. Launch the game and wait until you get to the title screen.  
2. Go to Options > Mod Management and make sure [b]Enable Mod[/b] is set to [b]ON[/b].  
3. Make sure the checkbox next to (MOD NAME HERE) is [b]CHECKED[/b]  
4. Click the blue [b]Save[/b] button and the game will now restart.  
5. Once the game starts up again, (MOD NAME HERE) should now be enabled.  

```

--------------------------------

### Complete Lua Mod Integration

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/blueprints-with-lua

A full example of a Lua mod that initializes a ModActor, registers hooks, and waits for the PalHUDService to become available.

```lua
local _ModActor = nil  
  
local function RegisterHooks()  
    RegisterHook("/Game/Pal/Blueprint/Component/OtomoHolder/BP_OtomoPalHolderComponent.BP_OtomoPalHolderComponent_C:ActivateOtomo",   
    function (Context, SlotID)  
        print("LUA: Activating otomo: " .. SlotID:get())  
        local HolderComponent = Context:get()  
        _ModActor:PrintPalNameFromHolder(HolderComponent)  
    end)  
end  
  
RegisterCustomEvent("Lua_ModInitialized", function (ModActor)  
    if ModActor:get() ~= nil and ModActor:get():IsValid() then  
        _ModActor = ModActor:get()  
        print("Blueprint Loaded!\n")  
    end  
end)  
  
ExecuteAsync(function ()  
    local HUDService = FindFirstOf("PalHUDService")  
  
    if HUDService ~= nil and HUDService:IsValid() then  
        RegisterHooks()  
        return  
    end  
  
    NotifyOnNewObject("/Script/Pal.PalHUDService", function (Context)  
        RegisterHooks()  
    end)  
end)  
```

--------------------------------

### Performing Data Manipulation in Lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Examples of string concatenation using the .. operator and basic arithmetic operations.

```lua
-- Concatenating strings  
greeting = "Hello, " .. "world!"  
  
-- Performing mathematical operations  
sum = 2 + 2  
difference = 10 - 5  
product = 2 * 3  
quotient = 10 / 2  
```

--------------------------------

### RegisterHook with Function Parameters

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/ue4ss-functions

Demonstrates accessing function parameters in a hook, requiring the :get() method to retrieve values from RemoteUnrealParam objects.

```lua
RegisterHook("/Script/Example.SomeObject:StupidFunction", function(Context, isTrue, Id, Message)  
    print("This message is: " .. Message:get())  
    print("The bool is: " .. isTrue:get())  
    print("The id is: " .. id:get())  
)
```

--------------------------------

### Configure Info.json for Dedicated Server Support

Source: https://pwmodding.wiki/docs/developers/mod-publishing/workshop/packaging

Include an additional InstallRule object with "IsServer": true to target dedicated server directories.

```json
{
  "ModName": "My Awesome Mod",
  "PackageName": "MyAwesomeMod",
  "Thumbnail": "thumbnail.png",
  "Version": "1.0.0",
  "MinRevision": 82182,
  "Author": "palworldmodding",
  "Dependencies": null,
  "Tags": [
    "Gameplay"
  ],
  "InstallRule": [
    {
      "Type": "Paks",
      "Targets": [
        "./Paks/"
      ]
    },
    {
      "Type": "Paks",
      "IsServer": true,
      "Targets": [
        "./Paks/"
      ]
    }
  ]
}
```

--------------------------------

### Creating Tables in Lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Demonstrates initializing tables as simple arrays or key-value dictionaries.

```lua
-- This is a table  
myTable = {1, 2, 3}  
  
-- This is also a table, but with named keys  
myDictionary = {name = "John", age = 25}  
```

--------------------------------

### Import and Use Configuration in main.lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/config-files

Use the require function to load the configuration table and apply values within your mod logic.

```lua
local config = require "config"  
  
NotifyOnNewObject("/Script/Pal.PalBaseCampModel", function(base_model)  
    print("found a base model, waiting for it to finish initializing")  
    ExecuteWithDelay(10000, function()  
        base_model.AreaRange = config.area_range  
        print("changed a bases range")  
    end)  
end)  
```

--------------------------------

### Initial BuildConfiguration.xml Structure

Source: https://pwmodding.wiki/docs/developers/palworld-modding-kit/installation

The default state of the BuildConfiguration.xml file before applying custom build tool settings.

```xml
<?xml version="1.0" encoding="utf-8" ?>  
<Configuration xmlns="https://www.unrealengine.com/BuildConfiguration">  
</Configuration>  
```

--------------------------------

### Defining and calling functions in Lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Illustrates the syntax for defining a reusable function and executing it.

```lua
-- This is a function that prints a greeting message  
function sayHello()  
    print("Hello!")  
end  
  
-- This is how the function is called  
sayHello()  
```

--------------------------------

### Use Function Parameters and Return Values

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Illustrates how to pass arguments into a function and return a calculated result.

```lua
-- Declaring a function with parameters  
function add(x, y)  
    return x + y  
end  
  
-- Calling a function with arguments  
result = add(5, 10)  
```

--------------------------------

### Create a README.md file

Source: https://pwmodding.wiki/docs/developers/mod-publishing/thunderstore/packaging-your-mod

A markdown file providing documentation for the mod, which is required for the package.

```markdown
# Hello World

Hiii!!
```

--------------------------------

### Define Configuration in config.lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/config-files

Create a separate Lua file to store mod settings and return them as a table.

```lua
local _my_mod_config = {  
    -- You can add comments with default values and such  
    -- Usually some explanation of what it does etc  
    area_range = 3500.0  
}  
return _my_mod_config  
```

--------------------------------

### Store and Pass Functions

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Demonstrates assigning functions to variables and passing them as arguments to other functions.

```lua
-- Storing a function in a variable  
local myFunction = function()  
    print("Hello!")  
end  
  
-- Passing a function as an argument  
otherFunction(myFunction)  
```

--------------------------------

### Access Table Elements

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Demonstrates different syntax options for retrieving values from a table.

```lua
-- Accessing table elements  
print(myTable["name"]) -- Output: John  
print(myTable.name)     -- Output: John  
print(myTable[3])      -- Output: hello  
print(myTable.nestedTable.key) -- Output: value  
```

--------------------------------

### Callback Function Patterns

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/ue4ss-functions

Demonstrates nesting callbacks versus defining them as separate functions for better code organization.

```lua
RegisterHook("/idk/some:function", function(self)  
    --some complicated logic  
end)  

```

```lua
local function complicatedFunction(self)  
    --some complicated logic  
end  
  
RegisterHook("/idk/some:function", complicatedFunction)  

```

--------------------------------

### Defining Numeric Variables in Lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Demonstrates how to assign integer and floating-point values to variables.

```lua
-- This is a number  
age = 25  
  
-- This is also a number, but with a decimal point  
price = 9.99  
```

--------------------------------

### Execute with a While Loop

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Use a while loop to repeat code as long as a condition remains true.

```lua
-- While loop  
local x = 5  
while x > 0 do  
    print(x)  
    x = x - 1  
end
```

--------------------------------

### Using comments in Lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Shows how to use double dashes to create comments that the interpreter ignores.

```lua
-- This is a comment and will be ignored by the interpreter  
greeting = "hello"  
```

```lua
    -- Function to check pal's health  
    function checkPalHealth()  
        -- Get pal using getPal function  
        local pal = getPal("anubis")  
        -- Return pal's health  
        return pal.health  
    end  
```

--------------------------------

### Registering for object creation

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/hooking-functions

Use this to trigger logic when an object of a specific class is created. The callback receives the new object instance as a parameter.

```lua
NotifyOnNewObject(ObjectPath, Callback)  
```

--------------------------------

### Create a Lua Table

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Defines a table with various key types and nested structures.

```lua
-- Creating a table  
local myTable = {  
    ["name"] = "John",  
    ["age"] = 25,  
    [3] = "hello",  
    -- Tables can be used as values of other tables  
    ["nestedTable"] = {  
        ["key"] = "value"  
    }  
}  
```

--------------------------------

### Define and Call Functions

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Basic syntax for declaring a function using the function keyword and invoking it by name.

```lua
-- Declaring a function  
function sayHello()  
    print("Hello!")  
end  
  
-- Calling a function  
sayHello()  
```

--------------------------------

### Define Lua Data Types

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Shows how to initialize common Lua data types including numbers, strings, booleans, and tables.

```lua
-- Declaring a number variable  
local age = 25  
  
-- Declaring a string variable  
local name = "John"  
  
-- Declaring a boolean variable  
local isValid = true  
  
-- Declaring a table variable  
local myTable = {1, 2, 3}  
```

--------------------------------

### Implement Metatables

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Uses a metatable to define custom behavior for the addition operator on tables.

```lua
-- Creating a metatable  
local myMetatable = {  
    __add = function(table1, table2)  
        local newTable = {}  
        for k, v in pairs(table1) do  
            newTable[k] = v  
        end  
        for k, v in pairs(table2) do  
            newTable[k] = v  
        end  
        return newTable  
    end  
}  
  
-- Setting the metatable  
setmetatable(myTable, myMetatable)  
  
-- Using the metamethod  
local myOtherTable = {  
    ["city"] = "New York",  
    ["country"] = "USA"  
}  
local myCombinedTable = myTable + myOtherTable  
print(myCombinedTable.name)     -- Output: John  
print(myCombinedTable.city)     -- Output: New York  
```

--------------------------------

### Detect PalBaseCampModel Creation

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/more-digging

A practical implementation to detect when a PalBaseCampModel is created in the game world.

```lua
NotifyOnNewObject("/Script/Pal.PalBaseCampModel", function()  
    print("found a base")  
end)  
```

--------------------------------

### Initialize Lua mod via PalHUDService

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/blueprints-with-lua

Registers hooks using the PalHUDService to ensure performant initialization.

```lua
ExecuteAsync(function ()  
    local HUDService = FindFirstOf("PalHUDService")  
  
    if HUDService ~= nil and HUDService:IsValid() then  
        RegisterHooks()  
        return  
    end  
  
    NotifyOnNewObject("/Script/Pal.PalHUDService", function (Context)  
        RegisterHooks()  
    end)  
end)  
```

--------------------------------

### Clone the PMK Repository

Source: https://pwmodding.wiki/docs/developers/palworld-modding-kit/installation

Use this command to clone the Palworld Modding Kit repository from GitHub.

```bash
git clone https://github.com/localcc/PalworldModdingKit
```

--------------------------------

### Execute with a Repeat Until Loop

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Use a repeat-until loop to execute code at least once before checking the exit condition.

```lua
-- Repeat until  
local x = 5  
repeat  
    x = x - 1  
    print(x)  
until x == 0
```

--------------------------------

### Define the manifest.json structure

Source: https://pwmodding.wiki/docs/developers/mod-publishing/thunderstore/packaging-your-mod

The manifest file is required for Thunderstore to recognize the mod and its dependencies. Every Palworld mod must include the unreal_shimloader dependency.

```json
{
    "name": "TestMod",
    "version_number": "1.1.0",
    "author": "You",
    "website_url": "https://github.com/thunderstore-io",
    "description": "This is a description for a mod. 250 characters max",
    "dependencies": [
        "Thunderstore-unreal_shimloader-1.0.2"
    ]
}
```

```json
{
    "name": "HelloWorld",
    "version_number": "1.0.0",
    "description": "Hello palworld!",
    "website_url": "https://github.com/thunderstore-io",
    "dependencies": [
        "Thunderstore-unreal_shimloader-1.0.2"
    ]
}
```

--------------------------------

### Hook Function Execution

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/hooking-functions

Intercepting the ActivateOtomo function to log the slot ID when a pal is spawned.

```lua
print("Hello world from Lua!")  
  
RegisterHook("/Script/Engine.PlayerController:ClientRestart", function (Context)  
    NotifyOnNewObject("/Game/Pal/Blueprint/Component/OtomoHolder/BP_OtomoPalHolderComponent.BP_OtomoPalHolderComponent_C", function (Component)  
        print("New component!")  
        RegisterHook("/Game/Pal/Blueprint/Component/OtomoHolder/BP_OtomoPalHolderComponent.BP_OtomoPalHolderComponent_C:ActivateOtomo", function (self, SlotId)  
            print("Activating otomo: " .. SlotId:get())  
        end)  
    end)  
end)  
```

--------------------------------

### Declare Lua Variables

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Demonstrates the difference between local and global variable declarations. Using local is recommended to restrict scope and prevent accidental global assignments.

```lua
-- Declaring a variable  
local x = 5  
  
-- Declaring a variable without the `local` keyword  
y = 10  
```

--------------------------------

### Initial Hook Attempt

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/digging-101

An initial attempt at hooking the BroadcastChatMessage function that fails due to type mismatch.

```lua
-- I expect you'll come up with something like this  
RegisterHook("/Script/Pal.PalGameStateInGame:BroadcastChatMessage", function(self, ChatMessage)  
    print(ChatMessage:get())  
end)
```

--------------------------------

### Registering a Hook in Lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/blueprints-with-lua

Defines a function to hook into the Otomo activation event and execute custom logic.

```lua
local function RegisterHooks()  
    RegisterHook("/Game/Pal/Blueprint/Component/OtomoHolder/BP_OtomoPalHolderComponent.BP_OtomoPalHolderComponent_C:ActivateOtomo",   
    function (Context, SlotID)  
        print("LUA: Activating otomo: " .. SlotID:get())  
        local HolderComponent = Context:get()  
        _ModActor:PrintPalNameFromHolder(HolderComponent)  
    end)  
end  
```

--------------------------------

### Implement Elseif Conditional Logic

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Use elseif to evaluate multiple sequential conditions.

```lua
-- Elseif statement  
local x = 5  
if x > 10 then  
    print("x is greater than 10")  
elseif x < 0 then  
    print("x is less than 0")  
else  
    print("x is between 0 and 10")  
end`
```

--------------------------------

### Assigning a variable in Lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Demonstrates a basic statement assigning a string value to a variable.

```lua
-- This is a statement that assigns the value "hello" to the variable "greeting"  
greeting = "hello"  
```

--------------------------------

### RegisterHook for ClientRestart

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/ue4ss-functions

Hooks into the ClientRestart function to execute logic after the client restarts.

```lua
RegisterHook("/Script/Engine.PlayerController:ClientRestart", function (Context)   
    -- do something  
end)  
```

--------------------------------

### Defining Boolean Variables in Lua

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/lua-basics

Illustrates the use of true and false boolean literals.

```lua
-- This is a boolean  
isValid = true  
  
-- This is also a boolean  
isCompleted = false  
```

--------------------------------

### Update local repository via Git

Source: https://pwmodding.wiki/docs/developers/palworld-modding-kit/updating

Run these commands within the PalworldModdingKit directory to fetch and merge the latest changes from the remote repository.

```bash
git fetch  
git pull  
```

--------------------------------

### RegisterHook for ServerAcknowledgePossession

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/ue4ss-functions

Hooks into ServerAcknowledgePossession, which is suitable for both local games and dedicated servers when a client connects.

```lua
RegisterHook("/Script/Engine.PlayerController:ServerAcknowledgePossession", function(Context)  
    -- do something  
end)  
```

--------------------------------

### Timing Functions

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/ue4ss-functions

Utilities for scheduling code execution after a delay or at a recurring interval.

```lua
ExecuteWithDelay(later_in_ms, function()  
    --something  
end)  

```

```lua
LoopAsync(every_so_often, function()  
    --something  
end)  

```

--------------------------------

### Registering a function hook

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/hooking-functions

Use this to execute code after a specific function finishes. The callback can inspect or override the return value.

```lua
RegisterHook(FunctionName, Callback)  
```

--------------------------------

### FName and FText Conversion

Source: https://pwmodding.wiki/docs/developers/ue4ss-modding/lua-mods/ue4ss-functions

Converts standard strings to Unreal Engine FName/FText types and vice versa.

```lua
local fname = FName(some_fname)  
local ftext = FText(some_text)  

```

```lua
RegisterHook("/idk/some:function", function(fname_param, ftext_param)  
    local cool_string = fname_param:get():ToString()  
    local also_cool_string = ftext_param:get():ToString()  
    print(cool_string .. also_cool_string)  
end)  

```

--------------------------------

### Updated BuildConfiguration.xml for VS 2022

Source: https://pwmodding.wiki/docs/developers/palworld-modding-kit/installation

The modified configuration file specifying Visual Studio 2022 as the project generator and compiler.

```xml
<?xml version="1.0" encoding="utf-8" ?>  
<Configuration xmlns="https://www.unrealengine.com/BuildConfiguration">  
    <VCProjectFileGenerator>  
        <Version>VisualStudio2022</Version>  
    </VCProjectFileGenerator>  
    <WindowsPlatform>  
        <Compiler>VisualStudio2022</Compiler>  
        <CompilerVersion>14.38.33130</CompilerVersion>  
        <ToolchainVersion>14.38.33130</ToolchainVersion>  
    </WindowsPlatform>  
</Configuration>  
```
Tokens:
Raw