From f27489c86a7e859d55ec715d817b979cf2b4a483 Mon Sep 17 00:00:00 2001 From: SPT-dev Date: Thu, 2 Mar 2023 21:10:03 -0500 Subject: [PATCH] Installation process until new one done + old dev setup removed --- .../development-environment-setup.md | 113 ------------------ docs/md/spt-aki/install.md | 63 ++++++++++ 2 files changed, 63 insertions(+), 113 deletions(-) delete mode 100644 docs/md/.old/tutorials/development-environment-setup.md diff --git a/docs/md/.old/tutorials/development-environment-setup.md b/docs/md/.old/tutorials/development-environment-setup.md deleted file mode 100644 index 842b18b..0000000 --- a/docs/md/.old/tutorials/development-environment-setup.md +++ /dev/null @@ -1,113 +0,0 @@ -![](./assets/img/headers/tutorials_settingup.png) - -## Requirements - -* [Visual Studio 2017/2019](https://visualstudio.microsoft.com/en/vs/community/) -* [Visual Studio Code](https://code.visualstudio.com/) or [VSCodium](https://vscodium.com/) -* [Git](https://git-scm.com/downloads) -* [NodeJS v12.16.3 (Installer/.msi)](https://nodejs.org/en/blog/release/v12.16.3/) -* A supported version of Escape From Tarkov -* A working internet connection - -:::warning -Make sure to follow **all the steps** below before asking help. Carefully read **everything**. -::: - -## 1. Installing dependencies - -### 1.1 Visual Studio 2019 -1. Download the Community edition of Visual Studio 2019. -2. Run the installer, and install it with the `.NET Desktop (C#)` workload. - -### 1.2 NodeJS -1. Download the NodeJS v12.16.3 **installer**. -2. Run the installer. -3. **Make sure** to select `Add to PATH`. -4. Deselect installation of chocolatey. -5. Install. - - -For rest of the requirements install with the default settings. - -## 2. Obtaining required files - -### 2.1 Preparation *(Recommended)* - -1. Create a folder and name it something like `EFT-0.12.6.8026` (preferably somewhere on your fastest drive). **This folder will be referenced to as the prep folder.** -2. Inside this folder, create a `Client` folder. -3. Find your official game client install folder (by default, `C:\Battlestate Games\EFT (live)\`) and copy all of its contents into the `Client` folder from before. -4. Remove the following unnecessary files from the `Client` folder: - - BattleEye/ - - Logs/ - - ConsistencyInfo - - EscapeFromTarkov_BE.exe - - Uninstall.exe - - UnityCrashHandler64.exe - - WinPixEventRuntime.dll - -### 2.2 Obtaining the server -Go with either steps, but take note that 2.2.1 will take a lot longer. -#### 2.2.1 With git -1. Open a PowerShell window inside the prep folder. -2. Run `git clone --depth 1 https://dev.offline-tarkov.com/sp-tarkov/Server.git` (this will take a while). -3. Verify that it has created a folder called `Server`. - -#### 2.2.2 As .zip -1. Open https://dev.offline-tarkov.com/sp-tarkov/Server in your browser. -2. Right above the file list, there should be buttons saying `HTTPS`/`SSH`, to the very right of that box will be a download icon. Click it and then download as ZIP. -3. Extract the downloaded file and move the `server` folder inside the prep folder. Rename it to `Server` (capital S). - -### 2.3 Obtaining the modules -Go with either steps. -#### 2.3.1 With git -1. Open a PowerShell window inside the prep folder. -2. Run `git clone --depth 1 https://dev.offline-tarkov.com/sp-tarkov/Modules.git`. -3. Verify that it has created a folder called `Modules`. - -#### 2.3.2 As .zip -1. Open https://dev.offline-tarkov.com/sp-tarkov/Modules in your browser. -2. Right above the file list, there should be buttons saying `HTTPS`/`SSH`, to the very right of that box will be a download icon. Click it and then download as ZIP. -3. Extract the downloaded file and move the `modules` folder inside the prep folder. Rename it to `Modules` (capital M). - -## 3. Building required files - -### 3.1 Building the server -Go with either steps. -#### 3.1.1 Through CLI -1. Open a PowerShell window inside the `Server\project\` folder (inside prep). -2. Install the project dependencies using `npm install`. -3. Build the project using `npm run build`. -4. A file called `SP-Tarkov-Server.exe` should appear. This is the built server file. - -#### 3.1.2 Through Visual Studio Code/VSCodium -1. Open the `Server\project` folder in Visual Studio Code/VSCodium. -2. Install the project dependencies using `Menu Bar => Terminal => Run Task... => npm => npm: install`. -3. Build the project using `Menu Bar => Terminal => Run Build Task...`. -4. A file called `SP-Tarkov-Server.exe` should appear. This is the built server file. - -### 3.2 Building the modules -1. Open the `Modules\Modules.sln` file with Visual Studio 2019. -2. Build the solution using `Menu Bar => Build => Rebuild Solution`. -3. Copy the contents of `Modules\Build` to your `Client` folder (from step 2.1), and OVERWRITE any files. - -### 4. Finished -You have successfully built SP-Tarkov from source. - -Run the server by running the `SP-Tarkov-Server.exe` file that should now be in your `Server\project` folder. -Play SP-Tarkov by launching the `SP-Tarkov-Launcher.exe` file that should now be in your `Client` folder. - -If you encounter an error, consult the FAQ before asking on the Guilded. - - -## Thanks -**Tutorial made by: Senko-San** - - -## Revisions - -1. added instructions for assembly-charp, slight wording change -2. changed the instruction to reflect the new build procedure -3. rewrote the tutorial to match latest changes - -## Official links -**Guilded link**: https://www.guilded.gg/senkospub diff --git a/docs/md/spt-aki/install.md b/docs/md/spt-aki/install.md index e69de29..c57f45b 100644 --- a/docs/md/spt-aki/install.md +++ b/docs/md/spt-aki/install.md @@ -0,0 +1,63 @@ +# Installing SPT-Aki + +> This guide covers the installation process for any of the releases of SP-Tarkov. + +## Requirements + +### Redistributables + +- A legal copy of the game ([link](https://www.escapefromtarkov.com/preorder-page)). +- Microsoft .NET Framework 5.0.0(64bits) ([link](https://dotnet.microsoft.com/download/dotnet/thank-you/runtime-5.0.0-windows-x64-installer)). +- Visual C++ Redistributable Packages for Visual Studio 2013 ([link](https://www.microsoft.com/en-ie/download/details.aspx?id=40784)). +- DirectX End-User Runtimes ([link](https://www.microsoft.com/en-ie/download/details.aspx?id=8109)). + +### Project files + +- SP-Tarkov modules ([link](https://mods.sp-tarkov.com/files/category-file-list/58-releases/)). +- SP-Tarkov server ([link](https://mods.sp-tarkov.com/files/category-file-list/58-releases/)). + +## Installation + +### Checking compatibility + +- Open BSG Launcher and check your game version (bottom right corner). + +![BSG Launcher](./assets/img/sp-tarkov/install_sp-tarkov/001.webp) + + + +- On the project page, check if one of SP-Tarkov's versions is compatible with your client version. + +![SP-Tarkov modules and server releases pages](./assets/img/sp-tarkov/install_sp-tarkov/002.webp) + + + +> If no version is available for your client version, wait for the project to make a new release. + +### Installing + +Download the server and module releases matching your client version. The archives are `SPTarkov-Server.zip` and `SPTarkov-Modules.zip`. + +![SP-Tarkov modules and server releases pages](./assets/img/sp-tarkov/install_sp-tarkov/003.webp) + + + +#### Server + +... + +#### Client + +... + +### Running + +...