How to set up and manage a server

[David Cernat]

Introduction

Simply hosting a tes3mp server is easy. Start tes3mp-server.exe and, assuming your chosen port (25565 by default) is forwarded correctly in your router, people can already find your server in the server browser and join it.

However, to run a successful server, there are various settings and commands you should know about, with more constantly being added.

Most importantly, you should know how to set yourself as an admin, how to promote people to moderators, how to kick and ban people, and how to change server script options. This guide is about that and more.

Basic server configuration

Open the file tes3mp-server-default.cfg to change the most basic parts of the server's configuration.

The file has three sections: [General], [Plugins] and [MasterServer]. A rundown of every setting in each one follows:


[General]

localAddress lets you the select the address on the local machine at which your server is reachable, but is only relevant if you have more than one networking interface. The default value of 0.0.0.0 – which lets the server listen on all available interfaces – should be fine for most situations.

port is the port on which your server listens for connections. You need to forward it to your computer's local IP in your router for your server to be accessible from the public internet.

players is the maximum number of players allowed on your server.

hostname is the public name of your server.

logLevel lets you select how much debug information should be printed to the server's console window and its accompanying log from your Documents\My Games\OpenMW folder.

password lets you protect your server with a password.


[Plugins]

home lets you set the path of the folder containing subfolders with the server data, Lua libraries and Lua scripts. In my own Windows builds, I've called the folder server, but you can call it anything and put it anywhere.

plugins lets you put in a comma-delimited list of Lua scripts that should be loaded by the server. Use this to load your own Lua scripts if you don't want to tinker with the default ones.


[MasterServer]

enabled can have a value of true or false and sets whether your server communicates with the tes3mp master server or not. If it does, your server will show up in people's server browsers.

address lets you select the address of the master server being used. The default one should work fine unless you want to run your own master server.

port is the port at which to connect to the master server.

rate is the rate at which updated information about this server should be sent to the master server.

How to make yourself an admin

The server doesn't set any player as an admin by default – so you'll have to set yourself as one manually.

Once you've connected to your server and registered an account, open up its matching player data file in server/data/player. For instance, if your account's name is James, open up server/data/player/James.json

Find the settings section inside it and then change this:

"staffRank":0

Into this:

"staffRank":2

Note that, if you set it to 1, you'll merely be a moderator.

If you're still on version 0.6, note that the setting is called "admin" instead of "staffRank".

Script configuration

To configure the default scripts that come with tes3mp, open up server/scripts/config.lua

Here you can set many different options, including:

* Whether the console is enabled or disabled by default for new players
* The default difficulty on the server
* The cell and position that players spawn in upon registering
* Where players should respawn
* The penalty for dying
* The speed at which time passes

More options will be added as time goes by.

The server's plugin list

Servers enforce a specific list of .esm and .esp files for all clients trying to join them. To change that list, edit server/data/requiredDataFiles.json

Because of how frequently this topic is asked about, you can find more details in the Frequently Asked Questions.

Server commands

There is a number of server commands that can be used ingame in the chat window. Some of them can be used by everyone, some of them require you to be at least a moderator, and some require you to be an admin. You can type in /help in the chat window to see them, but they are listed here as well for convenience.


Regular commands

/players or /list displays a window with a list of all the players on the server and their corresponding player IDs.

/me <text> sends a message displayed in the third person.

local <text> sends a message that only players in your area can read.

/anim <animation> or /a <animation> lets to play an animation applicable to your character's race and gender. Use it with an incorrect animation name to get a list of correct ones.

/speech <type> <index> or /s <type> <index> lets you play a speech file applicable to your character's race and gender. Use it with an incorrect type and/or index to get a list of correct ones.



Moderator commands

/kick <pid> lets you kick a player from the server.

/ban ip <ip> lets you ban a specific IP or IP range, without attaching the ban to a specific player.

/ban name <name> lets you ban a specific player name and all IP addresses that have been used by them. They are also prevented from logging in as that player with a new IP.

/unban ip <ip> and /unban name <name> can be used to cancel bans from the above.

/banlist ips can be used to print all banned IPs, while /banlist names can be used to print all banned names.

/ipaddresses <name> can be used to print all the IPs that have been used by a player.

/sethour <value> lets you set the current hour on the server.

/teleport <pid> or /tp <pid> lets you teleport a certain player to you. Example: /teleport 1

/teleport all or /tp all lets you teleport all players to you.

/teleportto <pid> or /tpto <pid> lets you teleport yourself to another player.

/cells displays a window with a list of all the cells loaded on the server and the number of players that have each one loaded.

/setattr <pid> <attribute> <value> lets you set a player's attribute to a certain value. Example: /setattr 3 intelligence 50

/setskill <pid> <skill> <value> lets you set a player's skill to a certain value. Example: /setskill 2 acrobatics 100


Admin commands

/addmoderator <pid> lets you turn someone into a moderator and is equivalent to giving them an admin value of 1 in their player data file.

/removemoderator <pid> lets you demote a moderator into a regular user.

/setconsole <pid> on/off/default lets you enable, disable or revert to default a player's ability to use their console. Example: /console 1 off

/setdifficulty <pid> <value>/default lets you set or revert to default the difficulty for a player.

/setbedrest <pid> <value>/default lets you set or revert to default a player's ability to rest in beds.

/setwildrest <pid> <value>/default lets you set or revert to default a player's ability to rest in the wilderness.

/setwait <pid> <value>/default lets you set or revert to default a player's ability to wait.

/runconsole <pid> <command> lets you run a certain console command on a player.

/werewolf <pid> on/off lets you enable or disable a player's werewolf state.

Resetting a server's world

You can reset the changes made to cells by deleting files in your server/data/cell folder. The filenames for interior cells always have the cell's ingame name, while the filenames for exterior cells always have the cell's exterior coordinates.

You can also reset global data by deleting server/data/world/world.json, which – depending on which data you have chosen to share across players in config.lua – can clear all journal entries, faction membership, dialogue topics and quest kill counts.

Make sure you restart the server for the reset to apply properly.


This guide will be updated as new server settings and commands get added. If you'd like to request any, feel free to do so.

[drivbycheckmate]

I'm fine with starting up my server using the tes3mp file but I can't have a password otherwise it doesn't let me on my own server. Just adressing this. Although I don't think it's a bug, it may just be my computer or simply I have the settings all weird.

[David Cernat]

drivbycheckmate, have you put in the password in your tes3mp-client-default.cfg as well?

[drivbycheckmate]

No, thanks for your time.

[wene42]

Anyway to reset bounty for players?

[David Cernat]

Edit their player data file accordingly in mp-stuff\data\player\

[wene42]

引用自 David C.：

Edit their player data file accordingly in mp-stuff\data\player\

Found it! Thank you.

[David Cernat]

I should probably mention that they need to log out before you edit the file.

[wene42]

I'm also having the same issue as Superfly(#15) any thoughts on how to fix?

[David Cernat]

What's the name of your server?

[wene42]

SO LETS GO

[wene42]

Try now

[David Cernat]

Your server is connectable for me.

[Feast for the Damned]

I have a problem with joining my own server. It says it has 999 ping (and i clearly don t have that much) and when i am trying to join it from the browser it doesn t let me conncet, but at the same time i can join other servers with no problem.

[David Cernat]

As noted in the FAQ, you can always join your own server by running tes3mp.exe

[Feast for the Damned]

Thanks for your time. But now i am haveing another problem: I start up the server and i join it but it still says i have 999 ping in tes3mp-browser.exe which is a problem for my friend who can't join. He also couln't join manually it says that the ip he wanted to join isn't correct when he typed the correct ip to the correct place. The wierd thing about this is that we could play one day ago but now (when we changed nothing) we are not abble to play.