UEScripts/ReadMe.md

# Steve's UE4 Scripts

## Summary

These scripts are to help with various tasks in [Unreal Engine 4](https://www.unrealengine.com). 
They're written on the basis of using Git / Git LFS rather than Perforce (many of UE4's own
automation tools assume P4, which can be inconvenient).

* [Setting up a project for Git / Git-LFS](./doc/GitSetup.md): including LFS locking
* [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
* [Cleaning Up](./doc/Cleanup.md): Deleting unneeded Hot Reload DLLs etc


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


If these tools are useful, please consider :heart: **[Supporting my work on Patreon!](https://www.patreon.com/stevestreeting)**
Added docs 2020-04-22 11:30:12 +01:00			`# Steve's UE4 Scripts`

Reorganised docs so easier to follow 2020-04-23 16:18:21 +01:00			`## Summary`
Added docs for ground-up repo creation script 2020-04-23 15:53:46 +01:00
Preparing new documentation structure. Move SVN stuff to legacy 2020-10-07 17:57:06 +01:00			`These scripts are to help with various tasks in [Unreal Engine 4](https://www.unrealengine.com).`
			`They're written on the basis of using Git / Git LFS rather than Perforce (many of UE4's own`
			`automation tools assume P4, which can be inconvenient).`

			`* [Setting up a project for Git / Git-LFS](./doc/GitSetup.md): including LFS locking`
			`* [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`
			`* [Cleaning Up](./doc/Cleanup.md): Deleting unneeded Hot Reload DLLs etc`
Started work on packaging script, still WIP 2020-10-02 18:27:56 +01:00

Include PsIni dependency in docs 2020-10-05 15:05:30 +01:00			`## Prerequisites`

Preparing new documentation structure. Move SVN stuff to legacy 2020-10-07 17:57:06 +01:00			`* Powershell Core 7+`
			`* Almost everything is compatible with Win10 built-in PS 5.1 but 7 is better, and platform independent`
Include PsIni dependency in docs 2020-10-05 15:05:30 +01:00			`* PsIni module installed (library for reading INI files easily)`
			* Run `Install-Module PsIni` in a Powershell console
Release documentation 2020-10-08 15:21:08 +01:00			* 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`
Include PsIni dependency in docs 2020-10-05 15:05:30 +01:00
Started work on packaging script, still WIP 2020-10-02 18:27:56 +01:00
Preparing new documentation structure. Move SVN stuff to legacy 2020-10-07 17:57:06 +01:00			`If these tools are useful, please consider :heart: [Supporting my work on Patreon!](https://www.patreon.com/stevestreeting)`
Reorganised docs so easier to follow 2020-04-23 16:18:21 +01:00