Abuse filter log

Abuse Filter navigation (Home | Recent filter changes | Examine past edits | Abuse log)
Jump to navigation Jump to search
Details for log entry 90

01:55, 30 August 2023: 72.73.226.67 (talk) triggered filter 0, performing the action "edit" on Multiplayer. Actions taken: Disallow, Tag; Filter description: (examine)

Changes made in edit

This article covers the complete setup process for a Necesse Dedicated server.
This article covers the complete setup process for a Necesse Dedicated server.


If you want to set up a Linux dedicated server specifically, you can follow [[Multiplayer-Linux|this guide]].
This page is for setting up a dedicated server in Microsoft Windows.  To set up a dedicated server in Linux go to [[Multiplayer-Linux|this guide]].


中文开服教程请参考：[[Multiplayer Chinese]]
中文开服教程请参考：[[Multiplayer Chinese]]
== Purchase a dedicated server ==
== Purchase a dedicated server ==
If you'd rather purchase a dedicated game server hosted by a 3rd party, some of them are:
If you'd rather purchase a dedicated game server hosted by a 3rd party, some of them are:
www.CitadelServers.com
* [https://citadelservers.com/game-servers/necesse-hosting Citadel Servers]
* [https://pingperfect.com/gameservers/necesse-game-server-hosting.php Pingperfect]
* [https://pingperfect.com/gameservers/necesse-game-server-hosting.php Pingperfect]
* Any VPS hosting service, like AWS EC2
* Any VPS hosting service, like AWS EC2
== Downloading Server Files ==
== Downloading Server Files ==


Downloading the server files can be performed in two different ways, which are:
There are several ways to download the dedicated server files.
 
'''Through Necesse's Official Website'''
 
You can download server files for both the current game version and previous game versions at https://necessegame.com/server/


'''Through Steam'''
'''Through Steam'''


To change where the dedicated server is installed, use the command force_install_dir C:\Necesse
To change where the dedicated server is installed, use the command force_install_dir C:\Necesse
That would tell SteamCMD to install the Necesse Dedicated server files to a folder called Necesse on your PC's C drive
That would tell SteamCMD to install the Necesse Dedicated server files to a folder called Necesse on your PC's C drive




<code>quit</code>
<code>quit</code>
'''Through download'''
You can also download the server files located at https://necessegame.com/server/


== Port Forwarding ==
== Port Forwarding ==


The protocol and default port for Necesse is UDP and port 14159.  You will need to open these ports on your router and server's Windows Firewall.
The protocol and default port for Necesse is UDP and port 14159.  You will need to open these ports on your router and the server's firewall.  You can also use any port of your choosing.


'''Router'''
'''Router'''


== Running the server ==
== Running the server ==
To run the server, navigate to wherever you installed the server files, if you've followed the exact steps from this guide, it would be C:\Necesse
To run the server, navigate to wherever you installed the server files, if you've followed the exact steps from this guide, it would be C:\Necesse


Leave the dedicated server program window open to keep the server running, when you want to shut down the server, type "quit" into the text box and click "Enter" or click the X at the top right of the window.
Leave the dedicated server program window open to keep the server running, when you want to shut down the server, type "quit" into the text box and click "Enter" or click the X at the top right of the window.


== How to join the server ==
== Joining the Server ==
Run the game from Steam
 
Run the game from Steam.
 
Click ''Multiplayer''.
 
Click ''Add Server''.
 
Type a name that will help you remember the server in the ''Name'' field.


Click "Multiplayer"
Type your public IPv4 address in the ''IP address'' field.  You can find that by going to https://whatismyipaddress.com/.


Click "Add Server"
Type your server port which if you've followed this guide is 14159 in the ''Port Number'' field.


Type a name that will help you remember the server in the "Name" field
Click ''Add''


Type your public IPv4 address (which can be found here: https://whatismyipaddress.com/) in the "IP address" field
Your server will now appear in the ''Multiplayer'' menu, double-click it to join or click it once then click ''Join Server''


Type your server port which if you've followed this guide is 14159 in the "Port Number" field
== Default File Locations ==


Click "Add"
The server configuration file is named ''server.cfg'' and is located at ''%appdata%\Necesse\cfg\''.


Your server will now appear in the "Multiplayer" menu, double-click it to join (or click it once then click "Join Server")
The server logs are found at ''%appdata%\Necesse\logs''.  Each server start will create a new log file with the log name being the date and time the server started.
 
The server's world save data is located at ''%appdata%\Necesse\saves\''.  Each world will have its own .zip file based on the name of the world.
 
Inside each world save file you will find the worlds configuration file named ''worldsettings.cfg''.


== Configuring the server ==
== Configuring the server ==
If you want to change the configuration of your server (after the initial setup) you will need to edit some files. They can be edited using any Text Editor program, such as Notepad (pre-installed to all Windows based PC's)


Before editing any configuration files, you should ALWAYS stop your server first.
After the initial setup and start of your server you can stop your server and then edit the configuration file to your liking using Notepad or a similar text editor.  Do not make edits while the server is running.
 
To edit the ''worldsettings.cfg'' config file navigate to the save path using the path above.
 
''Identify the world save you want to edit''  →  ''Right Click''  →  ''Extract Here''.
 
Create a backup of your original world save zip file by just renaming it something different or add additional text to the file name to identify it as your original.
 
You can now navigate to the world save folder now and edit the ''worldsettings.cfg'' file.
 
Once you are done you can recreate your world save.  ''Right-click'' the world save folder → ''Send to'' → ''Compressed (zipped) folder''.
 
== Command line Arguments ==


To navigate to the server's configuration files (and save files) type %appdata% into the Windows search bar, then double-click the "Necesse" folder
In your .bat file there are several command line arguments that can be used.  The below examples are based on using the "Start Server.bat" file included in the server download from "https://necessegame.com/server/".  Specifically version "Windows64 – v0.22.0 build 12012395".  The default command line in that file is ''start jre\bin\javaw.exe -jar Server.jar %*''


The server configuration file is named "server.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\cfg
'''-localdir'''


The world configuration file is named "worldSettings.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\YourWorldNamehere.zip
You can add ''-localdir'' like so:


The world is in a Compressed (zipped) .zip folder by default, meaning you will have to extract the files contained inside by right-clicking and selecting "Extract Here" - rename the original YourWorldNameHere.zip to something different.
''start jre\bin\javaw.exe -jar Server.jar %* -localdir''


Then you need to edit the "worldSettings.cfg" file.
This argument will relocate the default game save path from ''%appdata%\Necesse\saves\'' to whatever folder the batch file was executed from.


Then right-click the YourWorldNameHere folder, and hover over "Send to" and click "Compressed (zipped) folder"
For example, if my server is located at ''D:\necesse_server\necesse-server-0-22-0-12012395\'' but my server batch file is ran from ''D:\'' it will create all the save game data at ''D:\''.  This can sometimes be undesirable so keep this in mind.  If you would like to execute the batch file from outside the server folder a shortcut to the batch file can work to keep the save files within the server directory.


== File Locations ==
'''-world worldnamehere'''


'''By default'''
You can add ''-world worldnamehere'' like so:


The server configuration file is named "server.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\cfg
''start jre\bin\javaw.exe -jar Server.jar %* -world testworld''


The world configuration file is named "worldSettings.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\YourWorldNamehere.zip
This argument will automatically start up the world save you specify in the argument bypassing the need to manually select the save.  This is helpful if you have a want/need to automate the startup of your server. It CAN be used to initially setup a new world with default settings which you can then edit after creation.


The save data is the .zip named according to the world name, and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\
'''-nogui'''


The server logs are found at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\logs
You can add ''-nogui'' like so:


''start jre\bin\javaw.exe -jar Server.jar %* -nogui''


'''Customizations'''
This argument is used to remove the GUI interface and run the server from a command prompt window instead.  Keep in mind that if you like to see the real time server stats provided via the GUI interface, they are not visible via -nogui.  You will have to run game commands for that info.


Forcing configs to the game directory can be done with the -localdir parameter in bat file
If you happen to run -nogui AND -world at the same time, your server will be started windowless and in the background.  Server commands will need to be ran from in game or some other external program.  The server can still be viewed and terminated from within Windows Task Manager under the name ''OpenJDK Platform binary''.

Action parameters

VariableValue
Name of the user account (user_name)
'72.73.226.67'
Groups (including implicit) the user is in (user_groups)
[ 0 => '*' ]
Whether or not a user is editing through the mobile interface (user_mobile)
false
Page ID (page_id)
1484
Page namespace (page_namespace)
0
Page title (without namespace) (page_title)
'Multiplayer'
Full page title (page_prefixedtitle)
'Multiplayer'
Action (action)
'edit'
Edit summary/reason (summary)
''
Old content model (old_content_model)
'wikitext'
New content model (new_content_model)
'wikitext'
Old page wikitext, before the edit (old_wikitext)
'This article covers the complete setup process for a Necesse Dedicated server. If you want to set up a Linux dedicated server specifically, you can follow [[Multiplayer-Linux|this guide]]. 中文开服教程请参考：[[Multiplayer Chinese]] == Purchase a dedicated server == If you'd rather purchase a dedicated game server hosted by a 3rd party, some of them are: www.CitadelServers.com * [https://pingperfect.com/gameservers/necesse-game-server-hosting.php Pingperfect] * Any VPS hosting service, like AWS EC2 == Downloading Server Files == Downloading the server files can be performed in two different ways, which are: '''Through Steam''' Navigate to your Steam library and filter for tools [[File:Filter for Tools.png|thumb]] Identify 'Necesse Dedicated Server' and click install [[File:Download Necesse Dedicated Server.png|thumb]] [[File:Necesse Dedicated Server via Steam.png|thumb]] '''Through SteamCMD''' See Valve's developer wiki for how to download and install SteamCMD: https://developer.valvesoftware.com/wiki/SteamCMD Once installed, run SteamCMD by double-clicking the steamcmd.exe in the installation folder. In the SteamCMD window, type in the following: <code>login anonymous</code> To change where the dedicated server is installed, use the command force_install_dir C:\Necesse That would tell SteamCMD to install the Necesse Dedicated server files to a folder called Necesse on your PC's C drive Next, download the server files to the specified folder by typing: <code>app_update 1169370 validate</code> When the process has completed, it will say "Success! App '1169370' fully installed." You can then close Steam CMD by typing: <code>quit</code> '''Through download''' You can also download the server files located at https://necessegame.com/server/ == Port Forwarding == The protocol and default port for Necesse is UDP and port 14159. You will need to open these ports on your router and server's Windows Firewall. '''Router''' Login to your router. Navigate to your routers port forwarding section. Create the port forward entries in your router. '''Windows Firewall''' Navigate to Control Panel → System and Security → Windows Firewall. Select "Advanced settings" and highlight "Inbound Rules" in the left pane. Right click Inbound Rules and select "New Rule..." Click the "Port" circle and click "Next" [[File:Firewall Select "Port".png|thumb]] Select the protocol (UDP) and the port number (if you've followed this example, it would be 14159) in the "Specific local ports:" text box and click Next. Select "Allow the connection" in the next window and click Next. Select the network type as you see fit and click Next. Name the rule "Necesse Server" and click Finish. '''Port Forwarding Testing''' Test that your ports are forwarded correctly by entering your public IP address and the port number on this site: https://portchecker.co/ == Running the server == To run the server, navigate to wherever you installed the server files, if you've followed the exact steps from this guide, it would be C:\Necesse Locate the file called "StartServer.bat" and double-click it, a new window will appear, this is the dedicated server program. You will be asked to name the world, type your desired world name into the text box and click "Enter" If you want custom server options, type in "y" and click "Enter", if you do not, type "n" and click "Enter" It will ask you to specify the "host port" this is the port we forwarded earlier, so type in 14159 and then click "Enter" Then, it will ask for the amount of player slots, type in a number between 1 and 250, and click "Enter" Next, it will ask whether you want a server password, if you do, type in the server password, don't type anything if you don't want a server password, and click "Enter" It will ask you to specify custom spawn island, leave blank for random or enter a custom spawn island in the format: <x>,<y> and click "Enter" Then you'll be asked to specify spawn seed, enter a random number or leave blank for random, and click "Enter" You'll then be asked to choose whether to spawn the guide house, type in "y" for yes or "n" for no, and click "Enter" Click "Enter" one final time, to start up the server. Leave the dedicated server program window open to keep the server running, when you want to shut down the server, type "quit" into the text box and click "Enter" or click the X at the top right of the window. == How to join the server == Run the game from Steam Click "Multiplayer" Click "Add Server" Type a name that will help you remember the server in the "Name" field Type your public IPv4 address (which can be found here: https://whatismyipaddress.com/) in the "IP address" field Type your server port which if you've followed this guide is 14159 in the "Port Number" field Click "Add" Your server will now appear in the "Multiplayer" menu, double-click it to join (or click it once then click "Join Server") == Configuring the server == If you want to change the configuration of your server (after the initial setup) you will need to edit some files. They can be edited using any Text Editor program, such as Notepad (pre-installed to all Windows based PC's) Before editing any configuration files, you should ALWAYS stop your server first. To navigate to the server's configuration files (and save files) type %appdata% into the Windows search bar, then double-click the "Necesse" folder The server configuration file is named "server.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\cfg The world configuration file is named "worldSettings.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\YourWorldNamehere.zip The world is in a Compressed (zipped) .zip folder by default, meaning you will have to extract the files contained inside by right-clicking and selecting "Extract Here" - rename the original YourWorldNameHere.zip to something different. Then you need to edit the "worldSettings.cfg" file. Then right-click the YourWorldNameHere folder, and hover over "Send to" and click "Compressed (zipped) folder" == File Locations == '''By default''' The server configuration file is named "server.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\cfg The world configuration file is named "worldSettings.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\YourWorldNamehere.zip The save data is the .zip named according to the world name, and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\ The server logs are found at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\logs '''Customizations''' Forcing configs to the game directory can be done with the -localdir parameter in bat file'
New page wikitext, after the edit (new_wikitext)
'This article covers the complete setup process for a Necesse Dedicated server. This page is for setting up a dedicated server in Microsoft Windows. To set up a dedicated server in Linux go to [[Multiplayer-Linux|this guide]]. 中文开服教程请参考：[[Multiplayer Chinese]] == Purchase a dedicated server == If you'd rather purchase a dedicated game server hosted by a 3rd party, some of them are: * [https://citadelservers.com/game-servers/necesse-hosting Citadel Servers] * [https://pingperfect.com/gameservers/necesse-game-server-hosting.php Pingperfect] * Any VPS hosting service, like AWS EC2 == Downloading Server Files == There are several ways to download the dedicated server files. '''Through Necesse's Official Website''' You can download server files for both the current game version and previous game versions at https://necessegame.com/server/ '''Through Steam''' Navigate to your Steam library and filter for tools [[File:Filter for Tools.png|thumb]] Identify 'Necesse Dedicated Server' and click install [[File:Download Necesse Dedicated Server.png|thumb]] [[File:Necesse Dedicated Server via Steam.png|thumb]] '''Through SteamCMD''' See Valve's developer wiki for how to download and install SteamCMD: https://developer.valvesoftware.com/wiki/SteamCMD Once installed, run SteamCMD by double-clicking the steamcmd.exe in the installation folder. In the SteamCMD window, type in the following: <code>login anonymous</code> To change where the dedicated server is installed, use the command force_install_dir C:\Necesse That would tell SteamCMD to install the Necesse Dedicated server files to a folder called Necesse on your PC's C drive Next, download the server files to the specified folder by typing: <code>app_update 1169370 validate</code> When the process has completed, it will say "Success! App '1169370' fully installed." You can then close Steam CMD by typing: <code>quit</code> == Port Forwarding == The protocol and default port for Necesse is UDP and port 14159. You will need to open these ports on your router and the server's firewall. You can also use any port of your choosing. '''Router''' Login to your router. Navigate to your routers port forwarding section. Create the port forward entries in your router. '''Windows Firewall''' Navigate to Control Panel → System and Security → Windows Firewall. Select "Advanced settings" and highlight "Inbound Rules" in the left pane. Right click Inbound Rules and select "New Rule..." Click the "Port" circle and click "Next" [[File:Firewall Select "Port".png|thumb]] Select the protocol (UDP) and the port number (if you've followed this example, it would be 14159) in the "Specific local ports:" text box and click Next. Select "Allow the connection" in the next window and click Next. Select the network type as you see fit and click Next. Name the rule "Necesse Server" and click Finish. '''Port Forwarding Testing''' Test that your ports are forwarded correctly by entering your public IP address and the port number on this site: https://portchecker.co/ == Running the server == To run the server, navigate to wherever you installed the server files, if you've followed the exact steps from this guide, it would be C:\Necesse Locate the file called "StartServer.bat" and double-click it, a new window will appear, this is the dedicated server program. You will be asked to name the world, type your desired world name into the text box and click "Enter" If you want custom server options, type in "y" and click "Enter", if you do not, type "n" and click "Enter" It will ask you to specify the "host port" this is the port we forwarded earlier, so type in 14159 and then click "Enter" Then, it will ask for the amount of player slots, type in a number between 1 and 250, and click "Enter" Next, it will ask whether you want a server password, if you do, type in the server password, don't type anything if you don't want a server password, and click "Enter" It will ask you to specify custom spawn island, leave blank for random or enter a custom spawn island in the format: <x>,<y> and click "Enter" Then you'll be asked to specify spawn seed, enter a random number or leave blank for random, and click "Enter" You'll then be asked to choose whether to spawn the guide house, type in "y" for yes or "n" for no, and click "Enter" Click "Enter" one final time, to start up the server. Leave the dedicated server program window open to keep the server running, when you want to shut down the server, type "quit" into the text box and click "Enter" or click the X at the top right of the window. == Joining the Server == Run the game from Steam. Click ''Multiplayer''. Click ''Add Server''. Type a name that will help you remember the server in the ''Name'' field. Type your public IPv4 address in the ''IP address'' field. You can find that by going to https://whatismyipaddress.com/. Type your server port which if you've followed this guide is 14159 in the ''Port Number'' field. Click ''Add'' Your server will now appear in the ''Multiplayer'' menu, double-click it to join or click it once then click ''Join Server'' == Default File Locations == The server configuration file is named ''server.cfg'' and is located at ''%appdata%\Necesse\cfg\''. The server logs are found at ''%appdata%\Necesse\logs''. Each server start will create a new log file with the log name being the date and time the server started. The server's world save data is located at ''%appdata%\Necesse\saves\''. Each world will have its own .zip file based on the name of the world. Inside each world save file you will find the worlds configuration file named ''worldsettings.cfg''. == Configuring the server == After the initial setup and start of your server you can stop your server and then edit the configuration file to your liking using Notepad or a similar text editor. Do not make edits while the server is running. To edit the ''worldsettings.cfg'' config file navigate to the save path using the path above. ''Identify the world save you want to edit'' → ''Right Click'' → ''Extract Here''. Create a backup of your original world save zip file by just renaming it something different or add additional text to the file name to identify it as your original. You can now navigate to the world save folder now and edit the ''worldsettings.cfg'' file. Once you are done you can recreate your world save. ''Right-click'' the world save folder → ''Send to'' → ''Compressed (zipped) folder''. == Command line Arguments == In your .bat file there are several command line arguments that can be used. The below examples are based on using the "Start Server.bat" file included in the server download from "https://necessegame.com/server/". Specifically version "Windows64 – v0.22.0 build 12012395". The default command line in that file is ''start jre\bin\javaw.exe -jar Server.jar %*'' '''-localdir''' You can add ''-localdir'' like so: ''start jre\bin\javaw.exe -jar Server.jar %* -localdir'' This argument will relocate the default game save path from ''%appdata%\Necesse\saves\'' to whatever folder the batch file was executed from. For example, if my server is located at ''D:\necesse_server\necesse-server-0-22-0-12012395\'' but my server batch file is ran from ''D:\'' it will create all the save game data at ''D:\''. This can sometimes be undesirable so keep this in mind. If you would like to execute the batch file from outside the server folder a shortcut to the batch file can work to keep the save files within the server directory. '''-world worldnamehere''' You can add ''-world worldnamehere'' like so: ''start jre\bin\javaw.exe -jar Server.jar %* -world testworld'' This argument will automatically start up the world save you specify in the argument bypassing the need to manually select the save. This is helpful if you have a want/need to automate the startup of your server. It CAN be used to initially setup a new world with default settings which you can then edit after creation. '''-nogui''' You can add ''-nogui'' like so: ''start jre\bin\javaw.exe -jar Server.jar %* -nogui'' This argument is used to remove the GUI interface and run the server from a command prompt window instead. Keep in mind that if you like to see the real time server stats provided via the GUI interface, they are not visible via -nogui. You will have to run game commands for that info. If you happen to run -nogui AND -world at the same time, your server will be started windowless and in the background. Server commands will need to be ran from in game or some other external program. The server can still be viewed and terminated from within Windows Task Manager under the name ''OpenJDK Platform binary''.'
Unified diff of changes made by edit (edit_diff)
'@@ -1,5 +1,5 @@ This article covers the complete setup process for a Necesse Dedicated server. -If you want to set up a Linux dedicated server specifically, you can follow [[Multiplayer-Linux|this guide]]. +This page is for setting up a dedicated server in Microsoft Windows. To set up a dedicated server in Linux go to [[Multiplayer-Linux|this guide]]. 中文开服教程请参考：[[Multiplayer Chinese]] @@ -7,5 +7,5 @@ == Purchase a dedicated server == If you'd rather purchase a dedicated game server hosted by a 3rd party, some of them are: -www.CitadelServers.com +* [https://citadelservers.com/game-servers/necesse-hosting Citadel Servers] * [https://pingperfect.com/gameservers/necesse-game-server-hosting.php Pingperfect] * Any VPS hosting service, like AWS EC2 @@ -13,5 +13,9 @@ == Downloading Server Files == -Downloading the server files can be performed in two different ways, which are: +There are several ways to download the dedicated server files. + +'''Through Necesse's Official Website''' + +You can download server files for both the current game version and previous game versions at https://necessegame.com/server/ '''Through Steam''' @@ -36,4 +40,5 @@ To change where the dedicated server is installed, use the command force_install_dir C:\Necesse + That would tell SteamCMD to install the Necesse Dedicated server files to a folder called Necesse on your PC's C drive @@ -45,12 +50,8 @@ <code>quit</code> - -'''Through download''' - -You can also download the server files located at https://necessegame.com/server/ == Port Forwarding == -The protocol and default port for Necesse is UDP and port 14159. You will need to open these ports on your router and server's Windows Firewall. +The protocol and default port for Necesse is UDP and port 14159. You will need to open these ports on your router and the server's firewall. You can also use any port of your choosing. '''Router''' @@ -86,4 +87,5 @@ == Running the server == + To run the server, navigate to wherever you installed the server files, if you've followed the exact steps from this guide, it would be C:\Necesse @@ -110,52 +112,75 @@ Leave the dedicated server program window open to keep the server running, when you want to shut down the server, type "quit" into the text box and click "Enter" or click the X at the top right of the window. -== How to join the server == -Run the game from Steam +== Joining the Server == + +Run the game from Steam. + +Click ''Multiplayer''. + +Click ''Add Server''. + +Type a name that will help you remember the server in the ''Name'' field. -Click "Multiplayer" +Type your public IPv4 address in the ''IP address'' field. You can find that by going to https://whatismyipaddress.com/. -Click "Add Server" +Type your server port which if you've followed this guide is 14159 in the ''Port Number'' field. -Type a name that will help you remember the server in the "Name" field +Click ''Add'' -Type your public IPv4 address (which can be found here: https://whatismyipaddress.com/) in the "IP address" field +Your server will now appear in the ''Multiplayer'' menu, double-click it to join or click it once then click ''Join Server'' -Type your server port which if you've followed this guide is 14159 in the "Port Number" field +== Default File Locations == -Click "Add" +The server configuration file is named ''server.cfg'' and is located at ''%appdata%\Necesse\cfg\''. -Your server will now appear in the "Multiplayer" menu, double-click it to join (or click it once then click "Join Server") +The server logs are found at ''%appdata%\Necesse\logs''. Each server start will create a new log file with the log name being the date and time the server started. + +The server's world save data is located at ''%appdata%\Necesse\saves\''. Each world will have its own .zip file based on the name of the world. + +Inside each world save file you will find the worlds configuration file named ''worldsettings.cfg''. == Configuring the server == -If you want to change the configuration of your server (after the initial setup) you will need to edit some files. They can be edited using any Text Editor program, such as Notepad (pre-installed to all Windows based PC's) -Before editing any configuration files, you should ALWAYS stop your server first. +After the initial setup and start of your server you can stop your server and then edit the configuration file to your liking using Notepad or a similar text editor. Do not make edits while the server is running. + +To edit the ''worldsettings.cfg'' config file navigate to the save path using the path above. + +''Identify the world save you want to edit'' → ''Right Click'' → ''Extract Here''. + +Create a backup of your original world save zip file by just renaming it something different or add additional text to the file name to identify it as your original. + +You can now navigate to the world save folder now and edit the ''worldsettings.cfg'' file. + +Once you are done you can recreate your world save. ''Right-click'' the world save folder → ''Send to'' → ''Compressed (zipped) folder''. + +== Command line Arguments == -To navigate to the server's configuration files (and save files) type %appdata% into the Windows search bar, then double-click the "Necesse" folder +In your .bat file there are several command line arguments that can be used. The below examples are based on using the "Start Server.bat" file included in the server download from "https://necessegame.com/server/". Specifically version "Windows64 – v0.22.0 build 12012395". The default command line in that file is ''start jre\bin\javaw.exe -jar Server.jar %*'' -The server configuration file is named "server.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\cfg +'''-localdir''' -The world configuration file is named "worldSettings.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\YourWorldNamehere.zip +You can add ''-localdir'' like so: -The world is in a Compressed (zipped) .zip folder by default, meaning you will have to extract the files contained inside by right-clicking and selecting "Extract Here" - rename the original YourWorldNameHere.zip to something different. +''start jre\bin\javaw.exe -jar Server.jar %* -localdir'' -Then you need to edit the "worldSettings.cfg" file. +This argument will relocate the default game save path from ''%appdata%\Necesse\saves\'' to whatever folder the batch file was executed from. -Then right-click the YourWorldNameHere folder, and hover over "Send to" and click "Compressed (zipped) folder" +For example, if my server is located at ''D:\necesse_server\necesse-server-0-22-0-12012395\'' but my server batch file is ran from ''D:\'' it will create all the save game data at ''D:\''. This can sometimes be undesirable so keep this in mind. If you would like to execute the batch file from outside the server folder a shortcut to the batch file can work to keep the save files within the server directory. -== File Locations == +'''-world worldnamehere''' -'''By default''' +You can add ''-world worldnamehere'' like so: -The server configuration file is named "server.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\cfg +''start jre\bin\javaw.exe -jar Server.jar %* -world testworld'' -The world configuration file is named "worldSettings.cfg" and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\YourWorldNamehere.zip +This argument will automatically start up the world save you specify in the argument bypassing the need to manually select the save. This is helpful if you have a want/need to automate the startup of your server. It CAN be used to initially setup a new world with default settings which you can then edit after creation. -The save data is the .zip named according to the world name, and is located at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\saves\ +'''-nogui''' -The server logs are found at C:\Users\YourPCUsernameHere\AppData\Roaming\Necesse\logs +You can add ''-nogui'' like so: +''start jre\bin\javaw.exe -jar Server.jar %* -nogui'' -'''Customizations''' +This argument is used to remove the GUI interface and run the server from a command prompt window instead. Keep in mind that if you like to see the real time server stats provided via the GUI interface, they are not visible via -nogui. You will have to run game commands for that info. -Forcing configs to the game directory can be done with the -localdir parameter in bat file +If you happen to run -nogui AND -world at the same time, your server will be started windowless and in the background. Server commands will need to be ran from in game or some other external program. The server can still be viewed and terminated from within Windows Task Manager under the name ''OpenJDK Platform binary''. '
Lines added in edit (added_lines)
[ 0 => 'This page is for setting up a dedicated server in Microsoft Windows. To set up a dedicated server in Linux go to [[Multiplayer-Linux|this guide]].', 1 => '* [https://citadelservers.com/game-servers/necesse-hosting Citadel Servers]', 2 => 'There are several ways to download the dedicated server files.', 3 => '', 4 => ''''Through Necesse's Official Website'''', 5 => '', 6 => 'You can download server files for both the current game version and previous game versions at https://necessegame.com/server/', 7 => '', 8 => 'The protocol and default port for Necesse is UDP and port 14159. You will need to open these ports on your router and the server's firewall. You can also use any port of your choosing.', 9 => '', 10 => '== Joining the Server ==', 11 => '', 12 => 'Run the game from Steam.', 13 => '', 14 => 'Click ''Multiplayer''.', 15 => '', 16 => 'Click ''Add Server''.', 17 => '', 18 => 'Type a name that will help you remember the server in the ''Name'' field.', 19 => 'Type your public IPv4 address in the ''IP address'' field. You can find that by going to https://whatismyipaddress.com/.', 20 => 'Type your server port which if you've followed this guide is 14159 in the ''Port Number'' field.', 21 => 'Click ''Add''', 22 => 'Your server will now appear in the ''Multiplayer'' menu, double-click it to join or click it once then click ''Join Server''', 23 => '== Default File Locations ==', 24 => 'The server configuration file is named ''server.cfg'' and is located at ''%appdata%\Necesse\cfg\''.', 25 => 'The server logs are found at ''%appdata%\Necesse\logs''. Each server start will create a new log file with the log name being the date and time the server started.', 26 => '', 27 => 'The server's world save data is located at ''%appdata%\Necesse\saves\''. Each world will have its own .zip file based on the name of the world.', 28 => '', 29 => 'Inside each world save file you will find the worlds configuration file named ''worldsettings.cfg''.', 30 => 'After the initial setup and start of your server you can stop your server and then edit the configuration file to your liking using Notepad or a similar text editor. Do not make edits while the server is running.', 31 => '', 32 => 'To edit the ''worldsettings.cfg'' config file navigate to the save path using the path above.', 33 => '', 34 => '''Identify the world save you want to edit'' → ''Right Click'' → ''Extract Here''.', 35 => '', 36 => 'Create a backup of your original world save zip file by just renaming it something different or add additional text to the file name to identify it as your original.', 37 => '', 38 => 'You can now navigate to the world save folder now and edit the ''worldsettings.cfg'' file.', 39 => '', 40 => 'Once you are done you can recreate your world save. ''Right-click'' the world save folder → ''Send to'' → ''Compressed (zipped) folder''.', 41 => '', 42 => '== Command line Arguments == ', 43 => 'In your .bat file there are several command line arguments that can be used. The below examples are based on using the "Start Server.bat" file included in the server download from "https://necessegame.com/server/". Specifically version "Windows64 – v0.22.0 build 12012395". The default command line in that file is ''start jre\bin\javaw.exe -jar Server.jar %*''', 44 => ''''-localdir'''', 45 => 'You can add ''-localdir'' like so:', 46 => '''start jre\bin\javaw.exe -jar Server.jar %* -localdir''', 47 => 'This argument will relocate the default game save path from ''%appdata%\Necesse\saves\'' to whatever folder the batch file was executed from.', 48 => 'For example, if my server is located at ''D:\necesse_server\necesse-server-0-22-0-12012395\'' but my server batch file is ran from ''D:\'' it will create all the save game data at ''D:\''. This can sometimes be undesirable so keep this in mind. If you would like to execute the batch file from outside the server folder a shortcut to the batch file can work to keep the save files within the server directory.', 49 => ''''-world worldnamehere'''', 50 => 'You can add ''-world worldnamehere'' like so:', 51 => '''start jre\bin\javaw.exe -jar Server.jar %* -world testworld''', 52 => 'This argument will automatically start up the world save you specify in the argument bypassing the need to manually select the save. This is helpful if you have a want/need to automate the startup of your server. It CAN be used to initially setup a new world with default settings which you can then edit after creation.', 53 => ''''-nogui'''', 54 => 'You can add ''-nogui'' like so:', 55 => '''start jre\bin\javaw.exe -jar Server.jar %* -nogui''', 56 => 'This argument is used to remove the GUI interface and run the server from a command prompt window instead. Keep in mind that if you like to see the real time server stats provided via the GUI interface, they are not visible via -nogui. You will have to run game commands for that info.', 57 => 'If you happen to run -nogui AND -world at the same time, your server will be started windowless and in the background. Server commands will need to be ran from in game or some other external program. The server can still be viewed and terminated from within Windows Task Manager under the name ''OpenJDK Platform binary''.' ]
Unix timestamp of change (timestamp)
1693360508
Retrieved from "http://necessewiki.com/Special:AbuseLog/90"