Website/docs/md/development/setup.md

Setup

By Senko-san, 20/11/2020

Preface

This is for setting up the development environment, as well the projects themselves and build them.
This guide is by no means meant for beginners or those unfamilliar with the project.
It is hightly recommended to read the guide at least once before executing it.

Legenda

**Path**       **What**                      | **Example**
------------ | ----------------------------- | ----------------------
`%gamedir%`  | Escape From Tarkov (Live)     | `C:/games/EFT (Live)`
`%akidir%`   | Where AKI needs to be located | `C:/games/aki`
`%server%`   | server project                | `C:/projects/server`
`%launcher%` | launcher project              | `C:/projects/launcher`
`%modules%`  | modules project               | `C:/projects/modules`

Requirements

• Escape From Tarkov (Live)
• Node 12.18.2
• Visual Studio Build Tools
• VSCodium
• Git

1. Development environment

1. Node

1. Install npm package manager
2. Uncheck install chocolaty

2. Visual Studio Build Tools

• Check .NET desktop development
• Select Download all, then install

3. VSCodium

• Check Register VSCodium as an editor for supported file types
• Check Add to PATH

4. Git

1. Check only Associate .git* configuration with the default text editor
2. Use VSCodium
3. Git from the command line
4. Checkout windows-style
5. Use Windows' default console window
6. Default (fast-forward or merge)
7. Git Credential Manager
8. Check only Enable file system caching
9. Leave unchecked Enable experimental support

2. Server

1. Open VSCodium
2. Clone Repository > https://dev.offline-tarkov.com/SPT-AKI/Server.git
3. Open %server%/Server.code-workspace
4. Terminal > Run Task... > NPM > install
5. Terminal > Run Build Task...

3. Launcher

1. Open VSCodium
2. Clone Repository > https://dev.offline-tarkov.com/SPT-AKI/Launcher.git
3. Open %launcher%/Launcher.code-workspace
4. Terminal > Run Build Task...

4. Modules

1. Open VSCodium
2. Clone Repository > https://dev.offline-tarkov.com/SPT-AKI/Modules.git
3. Open %modules%/Modules.code-workspace
4. Terminal > Run Build Task...

5. Game files

1. Copy-paste %gamedir% to %akidir%
2. Copy-paste %server%/project/Server.exe and %server%/project/packages/ to %akidir%
3. Copy-paste %launcher%/project/Build/Launcher.exe and %launcher%/project/Buiild/Launcher_data/ to %akidir%
4. Copy-paste %modules%/project/Build/EscapeFromTarov_Data/ to %akidir%

Conclusion

Well done, you've succesfully setup and build the development build.
What's next? Get started with contributing or modding.