Description

Project based on skymp

You can build Skyrim Platform and C++ Server from RH brach of skymp submodule

Launch server

if you only want to run the server without development, then you need to use the server folder.

• in server folder rename server-settings.example.json to server-settings.json and configure your server
• copy Dawnguard.esm, Dragonborn.esm, HearthFires.esm, Skyrim.esm, Update.esm from skyrim folder to server data folder
• in server folder unzip the scripts.zip to the server/data/scripts folder

to start your server use npm run server:start in root folder in repo, or npm start in server folder

Server documentation

See documentation about server-settings skymp5-docs

But our server has a couple of its own settings link

If you need a ready to run server-settings you can use example

Server options

In our project we have new options for server server-options.json

Documentation about server-options link

Front documentation

See our documentation for front link

Installation for DEV

• install lates stable node js version
• install Papyrus lang for VS Code
• in folder .vscode rename tasks.example.json to tasks.json (replace if exists)
• in folder .vscode rename settings.example.json to settings.json (replace if exists)
• change papyrus.skyrimSpecialEdition.installPath in settings.json to absolute path for compiler folder
• in server folder rename server-settings.example.json to server-settings.json and configure your server (replace if exists)
• copy Dawnguard.esm, Dragonborn.esm, HearthFires.esm, Skyrim.esm, Update.esm from skyrim folder to server data folder
• in server folder unzip the scripts.zip to the server/data/scripts folder
• run npm install to install required dependencies

Running the server

$ npm run server:start

Running the ts script compilation

$ npm run functions:serve

Running "hot reload" for modules compilation

$ npm run modules:watch

Running modules installation

$ npm run modules:install

Running modules compilation

$ npm run modules:build

Running the papyrus script compilation

npm run compile

or combination ctrl + shit + B

Parse all esp files to find localization

npm run parse:all

Running the client compilation

npm run client:watch

Running the front compilation

npm run front:build

All commands see in package.json

Project based on skymp