This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
multiplayer:shell_help [2018-12-13 11:12] – skyjake | multiplayer:shell_help [2018-12-15 18:16] (current) – skyjake | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | <- Running a server ^ guide: | ||
+ | |||
+ | ====== Shell ====== | ||
+ | |||
+ | **Doomsday Shell** is a tool that helps you to run your own Doomsday servers and monitor the status of Doomsday servers running on remote computers over the internet. | ||
+ | |||
+ | This article is for [[version: | ||
+ | |||
+ | |||
+ | ===== Getting started ===== | ||
+ | |||
+ | In the past, hosting a multiplayer game has required one to run Doomsday in a special " | ||
+ | |||
+ | The Shell comes in two flavors: | ||
+ | * Qt 5 desktop app that works on Windows, macOS, and Linux. | ||
+ | * Text-based shell for Unix platforms ('' | ||
+ | |||
+ | On Unix, information specific to the text-mode version of the Shell can be found in the manual page [[guide: | ||
+ | |||
+ | |||
+ | ===== Basic features ===== | ||
+ | |||
+ | |||
+ | |||
+ | ==== Hosting a game ==== | ||
+ | |||
+ | |||
+ | To host your own multiplayer game, you need to start a Doomsday server. Typically this is done by starting a server on your local computer. The Shell makes this easy: select Server → New Local Server. This opens a dialog where you can configure the server' | ||
+ | |||
+ | === Basic settings === | ||
+ | |||
+ | ; Name | ||
+ | : Name of the server. This is just for identification purposes so that players know which server they are connecting to. | ||
+ | ; Game mode | ||
+ | : Game mode to run in. You must ensure that Doomsday will find the required [[guide: | ||
+ | ; TCP port | ||
+ | : Port that the server listens to for incoming connections. If you are expecting people to connect over the internet, make sure that the port is open in your firewall and/or NAT settings. Automatic port forwarding through a NAT is not supported, so you'll have to set that up manually. | ||
+ | ; Public server | ||
+ | : Checking this will make the server public so that everyone can see it. | ||
+ | ; Shell password | ||
+ | : Password for opening a Shell connection to the server. This is only for admin use — clients joining the game do not need to know this password. | ||
+ | |||
+ | === Advanced settings === | ||
+ | |||
+ | ; Runtime folder | ||
+ | : Folder where the server stores its runtime files ([[guide: | ||
+ | ; Options | ||
+ | : Additional command line options for [[guide: | ||
+ | |||
+ | < | ||
+ | |||
+ | Click **Start Server** when you're done. After the server has launched, a connection to it is automatically opened. (If the connection fails, it means the server failed to launch. Check the error from the server' | ||
+ | |||
+ | |||
+ | === Public servers (visible on master server) === | ||
+ | |||
+ | |||
+ | The server has to be configured as public to allow other people to see your server via the [[: | ||
+ | server-password " | ||
+ | server-public 1 | ||
+ | |||
+ | Defining a password is mandatory for public servers; otherwise malicious users could log in via the Shell and misconfigure it at will. | ||
+ | |||
+ | If a server is not public, it will not be announced to the [[: | ||
+ | |||
+ | |||
+ | ==== Connecting and disconnecting ==== | ||
+ | |||
+ | |||
+ | Each Shell window connects to a single server. It is important to note that a Shell connection is akin to an ssh connection to a Unix server — the server is running before the connection is opened and continues to run after the connection is closed. | ||
+ | |||
+ | * Connection → Connect: Specify any IP address to connect to. Servers running on the local network are automatically detected and appear in the address dropdown list. | ||
+ | * Connection → Disconnect: Closes the currently open connection. (The server keeps running.) | ||
+ | |||
+ | |||
+ | ==== Status overview ==== | ||
+ | |||
+ | |||
+ | The Status page displays an outline of the current map on the server. The positions of all players in the game are shown using position markers. | ||
+ | |||
+ | {{ file: | ||
+ | |||
+ | |||
+ | ==== Game options ==== | ||
+ | |||
+ | |||
+ | The Options page can be used to quickly change the game type, the current map, and a handful of other gameplay settings. The map has to be changed or restarted for the new options to come into effect. | ||
+ | |||
+ | {{ file: | ||
+ | |||
+ | |||
+ | ==== Console command line and log messages ==== | ||
+ | |||
+ | |||
+ | The Console page provides a console command line interface to control the server. You can enter both console commands and new values for console variables. | ||
+ | |||
+ | {{ file: | ||
+ | |||
+ | Keyboard shortcuts for the command line: | ||
+ | |||
+ | ^ Shortcut^ Function | | ||
+ | | Home, Ctrl-A, ⌘-A| Move to the beginning of the line | | ||
+ | | End, Ctrl-E, ⌘-E| Move to the end of the line | | ||
+ | | Ctrl-K, ⌘-K| Delete the rest of the current line | | ||
+ | | Up / Down| Move up/down in the command history (or lines of the current command) | | ||
+ | | Tab| Complete the current word (cycle through suggestions on each press) | | ||
+ | | Shift-Tab| Complete the current word (cycle backwards through suggestions on each press) | | ||
+ | |||
+ | |||
+ | ===== Settings / Preferences ===== | ||
+ | |||
+ | ==== Console font ==== | ||
+ | |||
+ | The font used on the console page for log entries and the command prompt. | ||
+ | |||
+ | ==== Server location ==== | ||
+ | |||
+ | Folder where the Doomsday Server executable can be found. Shell will use this for running local servers. | ||
+ | * On Windows and Linux, it is ok to leave this empty: the server executable is found in the same folder where the Shell is running. | ||
+ | * On macOS, you should specify here where **Doomsday.app** is located. The server executable is inside the Doomsday application bundle. | ||
+ | |||
+ | ==== Custom IWAD folder ==== | ||
+ | |||
+ | Unless you've told Doomsday where to find [[guide: | ||
+ | |||
+ | ===== See also ===== | ||
+ | |||
+ | * [[guide: | ||