This is the Server project for the Single Player Tarkov mod for Escape From Tarkov. It can be run locally to replicate responses to the modified Escape From Tarkov client.
For a full list of features, please see FEATURES.md.
This project has been built in Visual Studio Code (VSC) using Node.js. We recommend using NVM to manage installation and switching Node versions. If you do not wish to use NVM, you will need to install the version of Node.js listed within the .nvmrc file manually.
There are a number of VSC extensions that we recommended for this project. VSC will prompt you to install these when you open the workspace file. If you do not see the prompt, you can install them manually:
To prepare the project for development you will need to:
git clone https://dev.sp-tarkov.com/SPT/Server.git server to clone the repository.git lfs pull to download LFS files locally.project/mod.code-workspace file in Visual Studio Code (VSC).nvm use 20.11.1 in the VSC terminal.npm install in the VSC terminal.The following commands are available after the initial setup. Run them with npm run <command>.
| Command | Description |
|---|---|
check:circular |
Check for circular dependencies in the project. |
lint |
Check the project for coding standards issues using Biome. |
lint:fix |
Automatically fix coding standards issues using Biome. |
style |
Check the project for formatting issues using Biome. |
style:fix |
Automatically fix formatting issues using Biome. |
format |
Automatically fix all coding standards and formatting issues using Biome. |
test |
Run all tests. |
test:watch |
Run tests in watch mode. Tests will re-run when files are changed. |
test:coverage |
Run tests and generate a coverage report. |
test:ui |
Run tests in UI mode. This will open a browser window to view tests. |
build:release |
Build the project for release. |
build:debug |
Build the project for debugging. |
build:bleeding |
Build the project on the bleeding edge. |
build:bleedingmods |
Build the project on the bleeding edge with mods. |
run:build |
Run the project in build mode. |
run:debug |
Run the project in debug mode. |
run:profiler |
Run the project in profiler mode. |
gen:types |
Generate types for the project. |
gen:docs |
Generate documentation for the project. |
To debug the project in Visual Studio Code, you can select the Run tab and then select the Start Debugging option (or the F5 shortcut). This will start the server in debug mode, attaching a debugger to code execution, allowing you to set breakpoints and step through the code as it runs.
To debug a server mod in Visual Studio Code, you can copy the mod files into the user/mods folder and then start the server in debug mode. You should now be able to set breakpoints in the mod's Typescript files and they will be hit when the server runs the mod files.
We're really excited that you're interested in contributing! Before submitting your contribution, please consider the following:
We use Biome to enforce a consistent code style. Please run npm run format before submitting any changes. This is made easier by opening the VSC workspace and installing the recommended VSC extensions; this will ensure that your code is automatically formatted whenever you save a file.
We have a number of tests that are run automatically when you submit a pull request. You can run these tests locally by running npm run test. If you're adding a new feature or fixing a bug, please conceder adding tests to cover your changes so that we can ensure they don't break in the future.
This project is licensed under the NCSA Open Source License. See the LICENSE file for details.