VoidExpanse/Server setup: Difference between revisions

From AtomicTorchWiki
No edit summary
No edit summary
Line 13: Line 13:
=== Installation ===
=== Installation ===
1. Copy the following files from game distributive to your server machine:
1. Copy the following files from game distributive to your server machine:
* folder "Server"
* folder "Server_dotNET" (if you using .NET) or "Server_Mono"
* folder "Mods"
* folder "Core" (put it inside the "Server_*" folder)


Installation complete!
Installation complete!
Line 23: Line 23:


====Windows====
====Windows====
Launch ''AtomicTorch.SpaceRPG.Server.RuntimeWin.exe'' from ''./Server/'' folder.
Launch ''VoidExpanse.Server.exe'' from ''./Server_dotNET/'' folder.


====Other system with Mono====
====Other system with Mono====
Launch ''AtomicTorch.SpaceRPG.Server.RuntimeWin.exe'' from ''./Server/Mono'' folder with mono,
Launch ''VoidExpanse.ServerMono.exe'' from ''./Server_Mono'' folder with mono,
like this:
like this:
<pre>mono AtomicTorch.SpaceRPG.Server.RuntimeWin.exe</pre>
<pre>mono VoidExpanse.ServerMono.exe</pre>




Launch complete!
Launch complete! Follow printed into the console instructions if you want to run server as the dedicated server.


=== Settings ===
=== Settings ===


'''SettingsServer.xml'''
'''SettingsServer.xml'''
Most of settings are stored in ''SettingsServer.xml'', which is located in the same folder as server .exe file.
Most of settings are stored in ''SettingsServer.xml'', which is located in the same folder as server .exe file if you launch server as the dedicated server, or in "Documents/AtomicTorchStudio/VoidExpanse" if you launch it without "--dedicated" flag.
If it's not there, launch server once with "-new" argument, and it'll be created automatically and placed in the main folder.
If it's not there, launch server once with "-new" argument, and it'll be created automatically.


In ''SettingsServer.xml'', '''do not modfify misc and network parts'''! It may cause malifunction if you modify something in a way it is not intended to be.
In ''SettingsServer.xml'', '''do not modify misc and network parts'''! It may cause mailfunction if you modify something in a way it is not intended to be.


You may, however, modify <server> part on your own risk. There you can setup some server configurations that would affect gameplay.
You may, however, modify <server> part on your own risk. There you can setup some server configurations that would affect gameplay.

Revision as of 10:03, 22 January 2015

Multiplayer server setup

GUI for multiplayer server

The GUI is currently in development. We are planning to create a gui for Windows, Mac and Linux to provide easy, user-friendly server setup and management. However, on console-based systems, like FreeBSD, there are also standard console commands for server setup and management.


Multiplayer server setup

To launch a multiplayer server on any system, your system needs to meet following requirements:

  • .NET or Mono, compatible with .NET Framework 4.0

Installation

1. Copy the following files from game distributive to your server machine:

  • folder "Server_dotNET" (if you using .NET) or "Server_Mono"
  • folder "Core" (put it inside the "Server_*" folder)

Installation complete!

Or you can actually run the server from the same folder as it is distributed with the game.

Launch

Windows

Launch VoidExpanse.Server.exe from ./Server_dotNET/ folder.

Other system with Mono

Launch VoidExpanse.ServerMono.exe from ./Server_Mono folder with mono, like this:

mono VoidExpanse.ServerMono.exe


Launch complete! Follow printed into the console instructions if you want to run server as the dedicated server.

Settings

SettingsServer.xml Most of settings are stored in SettingsServer.xml, which is located in the same folder as server .exe file if you launch server as the dedicated server, or in "Documents/AtomicTorchStudio/VoidExpanse" if you launch it without "--dedicated" flag. If it's not there, launch server once with "-new" argument, and it'll be created automatically.

In SettingsServer.xml, do not modify misc and network parts! It may cause mailfunction if you modify something in a way it is not intended to be.

You may, however, modify <server> part on your own risk. There you can setup some server configurations that would affect gameplay.

Whitelist, blacklist

To enable whitelist, you need to follow the following procedure:

  • Be sure, that white_list_enabled in SettingsServer.xml is set to 1.
  • Create a file "whitelist.txt" next to the server executable file, and add there names of player you want to play on your server, one name on one line:
Portoss
Zegrr
Terrinaa

After this steps are done, only players listed in whitelist.txt will be able to connect to your server.

To enable blacklist, just create a file "blacklist.txt" next to game executable, and add there names of player, which you don't want to play with. Rules are the same - one name per one line. Blacklists are always enabled, so there's no need to change SettingsServer.xml

Create a new game

When server starts, you can create a new game, or load an existing one. To create a new game, type to create a new server:

-new [seed_key]

Seed_key is a word, which is used like seed value for random-based generation, like "voidexpance" or "hellyeah", which will affect world generation on server. For example, if you type

-new myworld

random world will be created, always the same for "myworld" seed key. And if you type

-new hellyeah

random world will be created too, but different from the one you'll get with "myworld". In other words, seed_key word defines generated world. Feel free to experiment, type in you nickname to create your personal world =)


Saving game

In multiplayer mode, server automatically saves game every time interval, specified in SettingsServer.xml (autosave_delay parameter). You can save server game with console command savegame.

savegame

- will save you game to slot 0 under the name "CurrentWorld".

savegame 5 ServerNameWord

- will save you game to slot 5 under the name "ServerNameWord".

Loading game

When server starts, you can create a new game, or load an existing one. To load an existing game, use command:

-load [slot_number]

You can use the same command not only when server starts, but even during the game, just type in console:

load 0