From be509115000eb948692cf7e0089cb97fd0e30bc1 Mon Sep 17 00:00:00 2001 From: Atomos821 Date: Thu, 26 Nov 2020 10:55:27 +0100 Subject: [PATCH] Updated text and formating --- docs/md/development/dump_data.md | 5 ++-- docs/md/development/setup.md | 50 +++++++++++++++----------------- 2 files changed, 25 insertions(+), 30 deletions(-) diff --git a/docs/md/development/dump_data.md b/docs/md/development/dump_data.md index 764dbba..a9a76f8 100644 --- a/docs/md/development/dump_data.md +++ b/docs/md/development/dump_data.md @@ -1,10 +1,9 @@ # Dumping game data from Escape From Tarkov -## Preface - This guide covers everything you need to know to dump all the data you need from Escape From Tarkov. -**It is highly recommended that you read the guide at least once before executing what's written here.** +> **Note**\ +> It is highly recommended that you read the guide at least once before executing what's written here.** * For sections related to dumping server data, see: 1. [Dumper](./#development/dump_data.md#dumper) diff --git a/docs/md/development/setup.md b/docs/md/development/setup.md index 230bdaf..f6c0d2a 100644 --- a/docs/md/development/setup.md +++ b/docs/md/development/setup.md @@ -1,12 +1,9 @@ -# Setup +# Environment setup -By Senko-san, 20/11/2020 +This is for setting up the development environment, as well the projects and building them. It's not meant for beginners or those unfamilliar with the project. -## Preface - -This is for setting up the development environment, as well the projects and building 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. +> **Note**\ +> It is hightly recommended to read the guide at least once before executing it. ## Legend @@ -20,30 +17,30 @@ It is hightly recommended to read the guide at least once before executing it. ## Requirements -- Escape From Tarkov (Live) -- [Node 12.18.2](https://nodejs.org/download/release/v12.18.2/node-v12.18.2-x64.msi) -- [Visual Studio Build Tools](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16) -- [VSCodium](https://github.com/VSCodium/vscodium/releases/download/1.51.1/VSCodiumSetup-x64-1.49.1.exe) -- [Git](https://github.com/git-for-windows/git/releases/download/v2.29.2.windows.2/Git-2.29.2.2-64-bit.exe) +* Escape From Tarkov (Live) +* [Node 12.18.2](https://nodejs.org/download/release/v12.18.2/node-v12.18.2-x64.msi) +* [Visual Studio Build Tools](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16) +* [VSCodium](https://github.com/VSCodium/vscodium/releases/download/1.51.1/VSCodiumSetup-x64-1.49.1.exe) +* [Git](https://github.com/git-for-windows/git/releases/download/v2.29.2.windows.2/Git-2.29.2.2-64-bit.exe) -## 1. Development environment +## Development environment -### 1.1. Node +### Node 1. Install `npm package manager`. 2. Uncheck `install chocolaty`. -### 1.2. Visual Studio Build Tools +### Visual Studio Build Tools -- Check `.NET desktop development`. -- Select `Download all, then install`. +* Check `.NET desktop development`. +* Select `Download all, then install`. -### 1.3. VSCodium +### VSCodium -- Check `Register VSCodium as an editor for supported file types`. -- Check `Add to PATH`. +* Check `Register VSCodium as an editor for supported file types`. +* Check `Add to PATH`. -### 1.4. Git +### Git 1. Check only `Associate .git* configuration with the default text editor`. 2. Select `Use VSCodium`. @@ -55,7 +52,7 @@ It is hightly recommended to read the guide at least once before executing it. 8. Check only `Enable file system caching`. 9. Leave unchecked `Enable experimental support`. -## 2. Server +## Server 1. Open VSCodium. 2. Clone Repository > `https://dev.offline-tarkov.com/SPT-AKI/Server.git`. @@ -63,21 +60,21 @@ It is hightly recommended to read the guide at least once before executing it. 4. Terminal > Run Task... > NPM > install. 5. Terminal > Run Build Task ... . -## 3. Launcher +## 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 +## 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 +## Game files 1. Copy-paste `%gamedir%` to `%akidir%`. 2. Copy-paste `%server%/project/Server.exe` and `%server%/project/packages/` to `%akidir%`. @@ -86,5 +83,4 @@ It is hightly recommended to read the guide at least once before executing it. ## Conclusion -Well done, you've succesfully setup and build the development build. -Now you can get started with contributing to the project. +Well done, you've succesfully set up and built the development build. Now you can get started with contributing to the project.