PALWORLDRUN.
SearchSaved
Navigation

CREATE · PACKAGE · VERIFY

Package a Palworld mod

Pocketpair's mod format uses a package directory and Info.json metadata with installation rules. Preserve the author, dependencies and tested game versions; validate the package and check the resulting files on a clean installation.

No Palworld Run accountOriginal documentation

Package identity

Pocketpair defines a package as a folder containing the required mod files and one Info.json manifest. Steam Workshop subscriptions normally live under the app 1623730 Workshop content directory. The game client discovers that location through Steam; a dedicated server needs explicit configuration.

Manifest fields

FieldPurpose
ModNameHuman-readable release name
PackageNameLoader identity; the uploader accepts alphanumeric characters
ThumbnailRelative preview-image filename
VersionPackage update marker; change it when publishing a changed artifact
DebugModeDevelopment option to reinstall on every launch
MinRevisionRequired game revision suffix, as specified by the official docs
AuthorOriginal author name
DependenciesPackage names needed by this release
TagsSupported Workshop classification tags
InstallRuleTypes and relative target paths to deploy

Installation destinations

These are the destinations documented by Pocketpair for its official loader. They are relative to the game installation; they are not a rule for every manual mod archive.

Rule typeDestination
UE4SSMods\NativeMods\UE4SS
LuaMods\NativeMods\UE4SS\Mods\{PackageName}
PalSchemaMods\NativeMods\UE4SS\Mods\PalSchema\mods
LogicModsPal\Content\Paks\LogicMods
PaksPal\Content\Paks\~WorkshopMods

A minimal metadata example

This original example describes a Lua package. Replace the author, targets and required revision with the actual values you have tested; the example does not establish compatibility or include the UE4SS framework.

{
  "ModName": "Run Example",
  "PackageName": "RunExample",
  "Version": "0.1.0",
  "Author": "Your author name",
  "Dependencies": [
    "UE4SS"
  ],
  "InstallRule": [
    {
      "Type": "Lua",
      "Targets": [
        "./Scripts"
      ]
    }
  ]
}

Updates and server rules

The official loader compares Version as a string and reinstalls when it changes. DebugMode requests reinstalling on every launch. If two subscribed packages share PackageName, only one may be enabled and the choice is not guaranteed. Use an identity that avoids that conflict. For a dedicated-server package, add an installation rule with IsServer set to true and verify its targets.

Validate the artifact

  • Parse Info.json and check the package identity and every relative target.
  • Confirm dependencies and preserve licenses for included material.
  • Install the package on a clean game or test server and verify the result.
  • Increment Version for changed files and publish the same artifact that passed the test.

Sources and verification

The official loader and maintainer documentation were retrieved on October 23, 2026. Examples are explanatory and have not been executed in Palworld by this project. The extended ID snapshot has no verified game-version label. Linked player data uses v1.0.3, while current official news includes v1.0.5.

KEEP BUILDING

Documentation routes

Palworld mod documentation

Find the game identifiers, installation guides and authoring references needed to use or release a mod. Follow the route for your loader and platform, then verify the installed result and keep a removal path.

Open document

Palworld Run data and API reference

Document the data actually published by Palworld Run, including schemas, stable identifiers, version metadata and limitations. Source-site API endpoints, private credentials, scanning claims and write operations cannot be carried over as if the new site operates them.

Open document

Mod author documentation

Choose the smallest change that solves the mod's purpose, identify its game records, and test on the side where it runs. Package the result with dependencies, compatibility evidence, credits and removal instructions.

Open document

Creating Mods for Palworld.

Develop a reversible change from an explicit requirement. Choose a data edit, Lua behavior or cooked content as appropriate, test a minimal example, then package only the files needed for the release.

Open document

Choose the Right Mod Format

Use a data-edit framework for supported table changes, Lua for runtime behavior, and cooked resources or Blueprint logic when the requirement needs assets or engine content. Distribution and dependencies affect the format decision.

Open document

Create Your First UE4SS Lua Mod

UE4SS Lua mods place their entry script inside a mod's Scripts directory. Begin with visible logging, consult the current hook API, and keep engine-object work on the appropriate thread before adding game behavior.

Open document