Skip to content

Building from Source

Jump to bottom
Michael Gerber edited this page Mar 9, 2025 · 3 revisions

Windows

TODO

Mac OS

TODO

Linux

  • Download sources from the Releases Page here on GitHub
  • Unzip somewhere (e.g. /home/username/tmp/)
  • Run the following from the base folder (or put it into a bash script):
export UE_ENGINE_PATH="/opt/unreal-engine/Engine" # or wherever your UE installation lives
export PLUGIN_PATH="/path/to/unzipped/location/PaperZD/PaperZD.uplugin" # e.g. /home/username/tmp/PaperZD/PaperZD.uplugin
export PACKAGE_PATH="/path/to/your/unreal/projects/YourCoolGame/Plugins/PaperZD" # This is where the plugin will be built, will create the directory if it doesn't exist

${UE_ENGINE_PATH}/Build/BatchFiles/RunUAT.sh BuildPlugin -plugin=${PLUGIN_PATH} -package=${PACKAGE_PATH} -Rocket -TargetPlatforms=Linux -PackageDir=${PACKAGE_PATH}
  • (Re)start UnrealEngine
  • Enable Plugin PaperZD in Plugins Menu

The Plugin needs to be rebuilt every time you update UE. Maybe Unreal will prompt you to rebuild upon launching, and you can try, but if it fails, simply run the above again.

Clone this wiki locally