diff --git a/README.md b/README.md index 6e331e8..06f3636 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Make sure that the location of folders and files in your project is as follows (Correct it if it's not): `//Classes/*.uc` -**There are two ways to add KF2-BuildTools to your project: +**There are two ways to add KF2-BuildTools to your project:** ## 1. As [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) Open git-bash and go to your project: `cd ` Add submodule: `git submodule add https://github.com/GenZmeY/KF2-BuildTools tools` @@ -35,23 +35,61 @@ Available commands can be found here: [USAGE.md](USAGE.md) If you have a simple mutator or game mode, then the usage is also simple: just use [the commands](USAGE.md) to compile, test and upload to the steam workshop. +![demo](example.gif) + +## The result can be found here: +**Compiled packages:** +`C:\Users\\Documents\My Games\KillingFloor2\KFGame\Unpublished\` + +**Brewed packages:** +`C:\Users\\Documents\My Games\KillingFloor2\KFGame\Published\` + +**Uploaded packages:** +your steam workshop 🙃 + # Usage (Advanced) If your project contains several mutators, *.upk files, external dependencies, or you want to customize the whole process in more detail, then this section is for you. -## Prepare -**UNDER CONSTRUCTION** +## Setup +When you run compilation for the first time or do `./tools/builder --init` `builder.cfg` appears in your project folder. +Edit it to set build/test/upload options. The config contains the necessary comments inside. -## Compilation -**UNDER CONSTRUCTION** +Edit the files in the PublicationContent folder - they are responsible for the description in the Steam Workshop. -## Brewing -**UNDER CONSTRUCTION** +## Project filesystem +If you have *.upk or localization files, they must be in a specific location. -## Testing -**UNDER CONSTRUCTION** +Change the filesystem of the project to such a form that everything works correctly: +``` +/Localization + /INT + *.int +/PublicationContent + preview.png + description.txt + tags.txt + title.txt +/SomePackageName1 + *.upk + /Classes + *.uc + *.upkg +/SomePackageName2 + *.upk + /Classes + *.uc + *.upkg +/Config + *.ini +/tools + builder +builder.cfg +``` -## Uploading to steam workshop -**UNDER CONSTRUCTION** +## Examples +[LightTIM](https://github.com/GenZmeY/KF2-LightTIM) - simplest case (one mutator) +[ServerExt](https://github.com/GenZmeY/KF2-Server-Extension) - Two mutators are compiled, there are *.upk files and localization +[UnofficialMod](https://github.com/GenZmeY/UnofficialMod) - Three mutators are compiled (one of them is a dependency), two mutators are uploaded to the steam workshop # Other [TODO List](TODO.md) diff --git a/example.gif b/example.gif new file mode 100644 index 0000000..ddb7c5d Binary files /dev/null and b/example.gif differ