DEADSOFTWARE

add man page by terminalhash
[d2df-sdl.git] / man / d2df.txt
1 @title Doom2DF 1 04.08.2021 1 1
3 @h1 NAME
4 Doom2DF - Doom 2D Forever game.
6 @h1 SYNOPSIS
7 Doom2DF [*ARGUMENTS*]... [*OPTION*]...@br
8 Doom2DF_H [*ARGUMENTS*]... [*OPTION*]...
11 @h1 DESCRIPTION
12 Doom 2D Forever is Doom-themed platformer game with network multiplayer support. This is the modern port of 1996 Doom 2D game by Prikol Software. Doom2DF_H is the dedicated server binary.@br
13 Note: documentation is not finished yet.
16 @h2 ARGUMENTS
17 -map WADFILE:\\MAP##
18 Run the game with the map from the specified wad for the current game session.@br
19 All maps in the Doom 2D Forever must be packed to a .wad (incompatible with doom wads) or .dfz (renamed zip) archive.@br
20 These wads can have a lot of maps inside, usually named as MAP##.
22 -gm NAME [`DM`|`TDM`|`CTF`|`COOP` ]
23 Use a specific gamemode for the current game session. Default is DM.
25 -port PORTNUMBER [`25667`]
26 Use a specific port for the server. Default is 25667.
28 -exec FILENAME.txt
29 You can also set a custom config for the game session. Good for maplists, etc.
31 -connect IP:PORT
32 Connect to server, when game loads.
34 -lims ###
35 Set the goal limit for current game session.
37 -lives ###
38 Set the number of lives for the Survival mode.
40 -limt ##:##
41 Set the time limit for current game session.
44 @h1 OPTIONS
45 --log-file FILENAME.log
46 Set custom name for the log file.
49 @h1 EXAMPLES
50 Run the dedicated server in DeathMatch mode, with custom maplist and custom log file.
52 @pre
53 $ Doom2DF_H -map PrikolSoft.wad:\\MAP01 -gm DM -port 25667 -exec maplist_dm.txt --log-file dfserver_dm.log
54 @endpre
57 @h1 AUTHOR
59 Written by Dmitry Lyashuk <lyashuk.voxx\@gmail.com>, Doom 2D: Forever Developers.