Setting up a Multiplayer Server: Difference between revisions

From Vintage Story Wiki
m
clarification
No edit summary
m (clarification)
 
(One intermediate revision by the same user not shown)
Line 16: Line 16:


<!--T:130-->
<!--T:130-->
Alternatively the game ships with a dedicated server program that you can start and leave on permanently without needing to log in yourself.
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.


Line 24: Line 24:


==== Dedicated Servers on Windows ==== <!--T:6-->
==== 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-->
* Open the game's application folder, it is <code>%appdata%/VintageStory</code> by default.
Next:
* Run <code>VintagestoryServer.exe</code>.
* Run the ''shortcut you made'' of <code>VintagestoryServer.exe</code> or the batch script.
* If Windows Firewall asks for permission, grant any necessary access
* 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).
* 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.
* You probably also want to use a custom --dataPath argument so as to not interfere with your single player game


===== Using Windows on a virtual machine =====
===== Using Windows on a virtual machine =====
Confirmedusers, editor
1,052

edits