A general-purpose multiplayer mod for Skyrim SE.
Explore Docs
·
Report Bug
·
Request Feature
·
Join Discord
You can find instructions on setting up the project locally below. To get a local copy up and running follow these simple example steps. You need ~10 GB on your hard drive and some free time.
These tools required regardless of your system:
- 64-bit NodeJS 12.x or higher + npm
- CMake 3.18.2 or higher
Before your start make sure that your system meets the conditions:
- Windows 7 or higher (Windows 10 is recommended)
- Visual Studio 2019
- .NET Framework SDK at 4.6.0 or higher (Visual Studio Installer -> .NET desktop development)
Playing on Linux isn't supported currently, but a full-featured server is.
- Ubuntu (Some other distributions may also work, but we know that Alpine doesn't)
- Clang 11 or higher (GCC is not supported)
-
Clone the repo, including submodules
git clone https://github.com/skyrim-multiplayer/skymp.git cd skymp git submodule init git submodule update
-
Make a build directory (used for project files, cache, artifacts, etc)
mkdir build
-
Generate project files with CMake (replace path with your actual Skyrim SE folder)
cd build cmake .. -DSKYRIM_DIR="C:/Program Files (x86)/Steam/steamapps/common/Skyrim Special Edition"
For users who don't have Skyrim SE installed:
cd build cmake ..
- Some tests would be skipped
- The server would require manual installation of Skyrim.esm and other master files
- Papyrus scripts that require Bethesda's compiler would not be compiled, prebuilts would be used
-
Build with CMake:
cmake --build . --config Debug
On Windows you also can open
build/skymp.sln
with Visual Studio, thenBuild -> Build Solution
.All build artifacts would be placed into
build/dist
. -
Run tests (optional):
ctest -C Debug --verbose
Some tests (ESPMTest) require Skyrim SE data files and will be skipped if you didn't specify
-DSKYRIM_DIR
.In order to avoid potential errors, make sure:
- You have installed it using Steam and it's up to date (currently last update was on Nov 20, 2019). See SteamDB for hashes and update history.
- You did not modify
Skyrim.esm
,Update.esm
,Dawnguard.esm
,HearthFires.esm
andDragonborn.esm
. (Ideally, you should have pure Vanilla version installed.)
-
Calculate test coverage (optional, Windows-only):
Install OpenCppCoverage and then:
cmake .. -DCPPCOV_PATH="C:\Program Files\OpenCppCoverage" ctest -C Debug --verbose
These commands would re-generate project files with coverage enabled and run tests. Coverage report would be in
build/__coverage
.
Use of this source code is subject to GPLv3. (See LICENSE
for more information)
Leonid Pospelov - Pospelov#3228 - pospelovlm@yandex.ru
Project Link: https://github.com/skyrim-multiplayer/skymp