https://github.com/sinbad/uescripts

Helper scripts for Unreal Engine
https://github.com/sinbad/uescripts

Last synced: about 1 month ago
JSON representation

Helper scripts for Unreal Engine

• Host: GitHub
• URL: https://github.com/sinbad/uescripts
• Owner: sinbad
• Created: 2020-04-21T14:45:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-28T16:35:56.000Z (7 months ago)
• Last Synced: 2024-05-29T07:44:21.767Z (7 months ago)
• Language: PowerShell
• Homepage:
• Size: 195 KB
• Stars: 122
• Watchers: 7
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        
# Steve's Unreal Scripts

## Summary

These scripts are to help with various tasks in [Unreal Engine](https://www.unrealengine.com). 

They're written on the basis of using Git / Git LFS rather than Perforce (many of Unreal's own

automation tools assume P4, which can be inconvenient).

These scripts support **UE4 and UE5** and will detect which one your project is using

* [Setting up a project for Git / Git-LFS](./doc/GitSetup.md): including LFS locking

* [Managing Git LFS Locking Tasks](https://github.com/sinbad/GitScripts): push and unlock, release locks you don't need any more

* [Packaging a Game](./doc/Package.md): building, cooking, archiving

* [Releasing a Game](./doc/Release.md): e.g. uploading to Itch, Steam

* [Rebuilding Lightmaps](./doc/RebuildLightmaps.md): build lighting on the command line easily (supporting git-lfs locking, no P4 dependency like RunUAT)

* [Getting Latest for Artists](./doc/GetLatest.md): pulls from git and builds so C++ changes are automatically updated

* [Synchronising BuiltData Files outside of Git](./doc/DataSync.md)

* [Cleaning Up](./doc/Cleanup.md): Deleting unneeded Hot Reload DLLs etc

* [Packaging a Marketplace Plugin](./doc/PluginPackage.md)

## Prerequisites

* Powershell Core 7+

  * Almost everything is compatible with Win10 built-in PS 5.1 but 7 is better, and platform independent

* PsIni module installed (library for reading INI files easily)

   * Run `Install-Module PsIni` in a Powershell console

* Itch's [`butler` tool](https://itch.io/docs/butler/) if you wish to release to Itch.io

* The [Steamworks SDK](https://partner.steamgames.com/doc/sdk) if you wish to release on Steam