CREATE · PACKAGE · VERIFY

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.

No Palworld Run accountOriginal documentation

Start with the job

For installing a release, begin with the user guide and follow its platform and loader requirements. For creating one, begin with the format decision and the internal-ID catalog. The author course then connects a small implementation to packaging, testing and distribution.

A traceable release

  • Identity: author, original release URL, package version and license.
  • Requirements: game revision, platform, loader, dependencies and client or server side.
  • Proof: expected behavior, observed test result, known conflicts and removal instructions.

What is published here

The game-ID references include extended and internal records as well as entries linked to the player guides. They are dated source observations, not a statement that every record can be captured, crafted or used by a normal player. The API reference describes Palworld Run endpoints and their actual account-free writing model.

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 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

Palworld Modding Kit & LogicMods

The community modding kit is a separate toolchain from Pocketpair's package uploader. Verify its prerequisites and game compatibility, then test a minimal cooked LogicMod before importing a large project.

Open document

Create a PalSchema Mod

PalSchema supports structured data edits using JSON or JSONC. Inspect the schema and current record IDs, make one targeted edit, validate it, and test the installed framework before packaging the change.

Open document

Package, Test & Publish a Mod

A release needs a portable package, a truthful compatibility statement and an actual author distribution page. Pocketpair's uploader and package specification describe the official workflow; the website must not imply it has published an archive when it has only exported metadata.

Open document

Palworld Active skills IDs

Look up an active skill by its internal identifier and localized label. Keep ordinary player skills distinct from boss, scenario and other extended records, and preserve the game snapshot that supplied the identifier.

Open document

Palworld Items IDs

Find an item's exact internal identifier before editing a recipe or data table. Similar display names and variant records can refer to different objects; the author reference needs the extended game catalog as well as player-facing items.

Open document

Palworld NPCs IDs

Search NPC identifiers separately from Pal species. Distinguish ordinary characters, merchant variants and encounter-specific records so an edit targets the intended NPC class.

Open document

Palworld Pals IDs

Use the exact internal Pal identifier rather than constructing one from a display name. Bosses, variants and scenario records expand the author catalog beyond the species visible in the player Palpedia.

Open document

Palworld Passive skills IDs

Resolve a passive's internal identifier and effect record before creating a table edit. Player-facing names, hidden effects and system records belong to different uses and need explicit classification.

Open document

Build a reproducible GitHub release

A release workflow can build and attach an archive to a GitHub release, but publishing requires the author's own external authorization. The reference's branded upload action and site tokens must not become a Palworld Run integration by renaming its instructions.

Open document

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.

Open document

Mod the game. Keep a way back.

Confirm a release's author, loader, dependencies, platform and game revision before installing it. Back up the world, add changes one at a time and retain enough information to remove the files and return to the baseline.

Open document