Skyrim Multiplayer Docs
  • Home
  • Running A Server
  • Server Configuration Reference
  • Server Command Line Api
  • Server Ports Usage
  • Database Drivers
  • Serverside Scripting Reference
  • Clientside Scripting Reference
  • Properties System
  • Events System
  • Skyrim Platform
  • Server Data Directory
Powered by GitBook
On this page

Was this helpful?

Server Command Line Api

PreviousServer Configuration ReferenceNextServer Ports Usage

Last updated 4 years ago

Was this helpful?

During the very first months of the current generation of skymp server's existence, we used command line API to configure our servers. These days we have in JSON format, but configuring via command-line arguments is also supported.

skymp5-server.exe --maxPlayers 108 --name "Server X" --port 7777 --ip "127.0.0.1"

Things you need to know about command-line arguments before using one:

  • Arguments passed directly to a command line implicitly override values from server-settings.json if they are set.

  • The only options that exist as command-line arguments are maxPlayers, name, port, ip. They have the same meanings as options in server-settings.json.

  • Instead of writing --maxPlayers 108 you may use -m 108. Only maxPlayers option has a short version.

a configuration file