Confirmedusers, editor
1,052
edits
Setting up a Multiplayer Server: Difference between revisions
From Vintage Story Wiki
m
clarification
m (reworded to clarify double use of "the following") |
m (clarification) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 7: | Line 7: | ||
<!--T:129--> | <!--T:129--> | ||
If you want a temporary multiplayer experience it is enough to open a single player world, then click on "Open to Lan" in the escape menu. This will allow players in your local network to join. | If you want a temporary multiplayer experience it is enough to open a single player world, then click on "Open to Lan" in the escape menu. This will allow players in your local network to join. | ||
If you want to allow players outside of your local network to join, you can then also click "Open to Internet" which will attempt to set up an external connection to join your server from the internet. This is done by a technique called UPnP and has to be enabled on your internet router, which it often is by default. In short, we estimate there's about a 60% success chance that 'Open to Internet' works instantly without issues. If it doesn't you would need to set up a so called "port forwarding" on your internet router, which can be tricky and frustrating at times, unfortunately. You would need to forward TCP Port 42420 to your computer in that case. (Google 'Port forwarding' with the name or model of your internet router to find help.) | If you want to allow players outside of your local network to join, you can then also click "Open to Internet" which will attempt to set up an external connection to join your server from the internet. This is done by a technique called UPnP and has to be enabled on your internet router, which it often is by default. In short, we estimate there's about a 60% success chance that 'Open to Internet' works instantly without issues. If it doesn't you would need to set up a so-called "port forwarding" on your internet router, which can be tricky and frustrating at times, unfortunately. You would need to forward TCP Port 42420 to your computer in that case. (Google 'Port forwarding' with the name or model of your internet router to find help.) | ||
<!--T:3--> | <!--T:3--> | ||
| Line 16: | Line 16: | ||
<!--T:130--> | <!--T:130--> | ||
As an alternative, the game ships with a dedicated server program that you can start and leave on permanently without needing to log in yourself. | |||
There are several ways to get a dedicated server up and running. | There are several ways to get a dedicated server up and running. | ||
==== Paid hosts ==== <!--T:5--> | ==== Paid hosts ==== <!--T:5--> | ||
See [[List of server hosting providers]] | |||
<!--T: | ==== Dedicated Servers on Windows ==== <!--T:6--> | ||
To keep your multiplayer server's settings from interfering with your single-player settings, use a custom --dataPath argument. | |||
< | '''Shortcut method:''' | ||
# Navigate to the location where you will store the server's data, such as a new VintagestoryServer folder created in <code>C:\Users\YourUsername\AppData\Roaming</code> | |||
# Create a folder for the server's data and give it a clear name, such as VSserverData | |||
# Open that folder and copy the entire path from the address bar of File Explorer. (example: <code>C:\Users\YourUsername\AppData\Roaming\VintagestoryServer\VSserverData</code>) | |||
# Open the game's application folder, it is <code>%appdata%/VintageStory</code> by default. | |||
# Create a shortcut of <code>VintagestoryServer.exe</code>. This can usually be accomplished through the right-click menu; google instructions specific to your operating system version if needed. | |||
# Open the Properties of the new shortcut. This can usually be accomplished through the right-click menu. | |||
# Click in the Target field of the shortcut's Properties, then go to the very end of what's written there. Add one space, then <code>--dataPath=</code>, then Paste the folder path you copied earlier, in quotes. The entire contents of the Target field should now be something like this: <code>"C:\Users\YourUsername\AppData\Roaming\Vintagestory\VintagestoryServer.exe" --dataPath="C:\Users\YourUsername\AppData\Roaming\VintagestoryServer\VSserverData"</code> | |||
* Optional: you can move/copy the shortcut, to your desktop and/or your new VintagestoryServer folder | |||
* | |||
'''Batch script method''' (functionally equivalent to the shortcut method above): | |||
# To create a batch script, simply create a blank text document and rename it with the .bat file extension. | |||
# You can edit it by right clicking and selecting edit. Then just type <code>%appdata%/Vintagestory/VintagestoryServer.exe --dataPath "[PATH]"</code> replacing [PATH] with the desired path for the server's data, then save and close. | |||
Running the script will run the server with the alternate datapath, and will generate its own collection of config files there. This is functionally equivalent to the modified link. | |||
<!--T:131--> | <!--T:131--> | ||
* | Next: | ||
* | * Run the ''shortcut you made'' of <code>VintagestoryServer.exe</code> or the batch script. | ||
* You might need to forward port 42420 on your internet router if you want the server to be accessible from outside of your local network (for example, anyone who isn't on the same WiFi as you). | * If Windows Firewall asks for permission, grant any necessary access. | ||
* You might need to forward port 42420 on your internet router if you want the server to be accessible from outside of your local network (for example, anyone who isn't on the same WiFi as you). The process for this varies significantly; google instructions for your specific router model. | |||
===== Using Windows on a virtual machine ===== | |||
There are some reports that LAN connection to a Vintage Story server running inside a Windows virtual machine (VM) can be slow, even when internet (WAN) connections have normal performance. This may depend on VM solution and network drivers. If this affects you, a suggested workaround is to use the Paravirtualized network adapter (virtio-net) for network adapters. The drivers are located [https://docs.oracle.com/en/virtualization/virtualbox/6.0/user/nichardware.html here]. | |||
---- | ---- | ||
| Line 134: | Line 138: | ||
<!--T:128--> | <!--T:128--> | ||
<span style="color:#E16100">Note: ''Please note the ARM64 version is EXPERIMENTAL please report any issues to the [https://discord.com/channels/302152934249070593/1128220205181587516 discord ]''</span> | <span style="color:#E16100">Note: ''Please note the ARM64 version is EXPERIMENTAL please report any issues to the [https://discord.com/channels/302152934249070593/1128220205181587516 discord ]''. | ||
Currently (in game version 1.19.3 - 1.19.4, February 2024) no ARM64 .NET7 version of the '''Harmony''' patching library is available. Therefore coded mods which use Harmony will not work on an ARM64 server. If a beta of the Harmony library becomes available in future, server owners can try installing it for themselves.</span> | |||
<!--T:118--> | <!--T:118--> | ||
