From c6d4089e6fee63f4e904257191622a370783366f Mon Sep 17 00:00:00 2001 From: TerminalHash <64691722+TerminalHash@users.noreply.github.com> Date: Sun, 26 Jun 2022 19:57:38 +0300 Subject: [PATCH 1/7] Push man from main repo. For convert txt to man use k8ttman. --- man/d2df.txt | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 man/d2df.txt diff --git a/man/d2df.txt b/man/d2df.txt new file mode 100644 index 0000000..47aff36 --- /dev/null +++ b/man/d2df.txt @@ -0,0 +1,86 @@ +@title Doom2DF 1 06.07.2021 1 1 + +@h1 NAME +Doom2DF - Doom 2D Forever game. + +@h1 SYNOPSIS +Doom2DF [*ARGUMENTS*]... [*OPTION*]...@br +Doom2DF_H [*ARGUMENTS*]... [*OPTION*]... + + +@h1 DESCRIPTION +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 +Note: documentation is not finished yet. + + +@h2 ARGUMENTS +-map WADFILE:\\MAPnn + Run the game with the map from the specified wad for the current game session.@br + All maps in the Doom 2D Forever must be packed to a .wad (incompatible with doom wads) or .dfz (renamed zip) archive.@br + These wads can have a lot of maps inside, usually named as MAPnn. + +-gm NAME [`DM`|`TDM`|`CTF`|`COOP`] + Use a specific gamemode for the current game session. Default is DM. + +-port PORTNUMBER [`25667`] + Use a specific port for the server. Default is 25667. + +-exec FILENAME.txt + You can also set a custom config for the game session. Good for maplists, etc. + +-connect IP:PORT + Connect to server, when game loads. + +-lims nnn + Set the goal limit for current game session. + +-lives nnn + Set the number of lives for the Survival mode. + +-limt nnnn + Set the time limit for current game session. + + +@h1 OPTIONS +--log-file FILENAME.log + Set custom name for the log file. + + +@h1 EXAMPLES +Run the dedicated server in DeathMatch mode, with custom maplist and custom log file. + + @pre + $ Doom2DF_H -map PrikolSoft.wad:\\MAP01 -gm DM -port 25667 -exec maplist_dm.txt --log-file dfserver_dm.log + @endpre + + +@h1 DIRECTORIES +By default, the game checks the entire disc for game files. (The editor can't search for files everywhere.) To follow a hierarchy, files can be located: + +~/.doom2df + in your home directory. + +/usr/share/doom2df + or in default directory. + +@h1 URLS +Our site:@br +http://doom2d.org + +Our forum:@br +http://doom2d.org/forum/index.php + +Our IRC:@br +irc.wenet.ru:6677 #doom2d + +Our Telegram:@br +http://https://t.me/doom2d_channel - Channel@br +http://t.me/doom2d - Chat + +Our Discord:@br +http://discord.gg/sGpJwMy + + +@h1 AUTHOR + +Written by Dmitry Lyashuk , Doom 2D: Forever Developers. From 386d7a2dd6269fd6d1daa287f03c45f8379b1201 Mon Sep 17 00:00:00 2001 From: TerminalHash Date: Tue, 7 Mar 2023 20:40:10 +0300 Subject: [PATCH 2/7] Update links in man, HOWTO... ... and working examples of maplists. --- examples/maplist_coop.txt | 67 +++++++++++++++++++++++++++++++++++++++ examples/maplist_dm.txt | 58 +++++++++++++++++++++++++++++++++ man/HOWTO | 4 +++ man/d2df.txt | 10 +++--- 4 files changed, 134 insertions(+), 5 deletions(-) create mode 100644 examples/maplist_coop.txt create mode 100644 examples/maplist_dm.txt create mode 100644 man/HOWTO diff --git a/examples/maplist_coop.txt b/examples/maplist_coop.txt new file mode 100644 index 0000000..7e2eff0 --- /dev/null +++ b/examples/maplist_coop.txt @@ -0,0 +1,67 @@ +# [GAMEMODES] +# Coop +alias coop "g_gamemode coop;g_warmup_time 16;g_maxlives 0;g_dm_keys 1;g_timelimit 0;g_scorelimit 0;sv_intertime 30;g_friendly_hit_trace 0;g_weaponstay 1;g_friendlyfire 0;centerprint 100 GAMEMODE: Cooperative;call coop01;bot_removeall" + +# Survival +alias survival "g_gamemode coop;g_warmup_time 60;g_maxlives 1;g_dm_keys 1;g_timelimit 0;g_scorelimit 0;g_friendly_hit_trace 0;g_weaponstay 1;g_friendlyfire 1;sv_intertime 30;centerprint 100 GAMEMODE: Survival;call coop01;bot_removeall" + +# [MAPLIST: Cooperative] +# Set maps +alias wad01 "nextmap megawads/doom2d.wad MAP01" +alias wad02 "nextmap megawads/doom2d2.wad MAP01" +alias wad03 "nextmap megawads/VETERAN.wad MAP01" +alias wad04 "nextmap megawads/Bloodworks.wad MAP01" +alias wad05 "nextmap megawads/dm99.dfz MAP01" + +# Set aliases for right calling megawads +alias coop01 "call wad01; event onwadend call coop02" +alias coop02 "call wad02; event onwadend call coop03" +alias coop03 "call wad03; event onwadend call coop04" +alias coop04 "call wad04; event onwadend call coop05" +alias coop05 "call wad05; event onwadend call coop01" + +# [STARTSETTING] +bot_removeall +event oninter "" +event onmapend call coop01 + +# [GAMESETTINGS] +g_allow_exit 1 +g_allow_monsters 1 +g_bot_vsmonsters 1 +g_bot_vsplayers 1 +g_dm_keys 1 +g_friendlyfire 0 +g_gamemode coop +g_item_respawn_time 60 +g_maxlives 0 +g_save_stats 1 +g_scorelimit 0 +g_screenshot_stats 1 +g_spawn_invul 0 +g_timelimit 0 +g_warmup_time 16 +g_weaponstay 1 +g_friendlyfire 0 + +# For team modes +g_friendly_hit_trace 0 +g_friendly_hit_projectile 1 +g_friendly_absorb_damage 1 +g_allow_dropflag 1 + +# [SERVERSETTING] +net_master_list mpms.doom2d.org:25665,deadsoftware.ru:25665,terminalcorner.ru:25665 +rdl_hashdb_save_enabled 1 +rdl_ignore_enabled 1 +rdl_ignore_names standart;shrshade +sv_intertime 30 +sv_master_interval 60000 +sv_maxplrs 16 +sv_name "Default Coop Server" +sv_port 25667 +sv_public 1 +sv_rcon 1 +sv_rcon_password +sv_reliable_interval 18 +sv_update_interval 0 diff --git a/examples/maplist_dm.txt b/examples/maplist_dm.txt new file mode 100644 index 0000000..ddc34e6 --- /dev/null +++ b/examples/maplist_dm.txt @@ -0,0 +1,58 @@ +# [GAMEMODES] +alias dm "g_gamemode dm;g_warmup_time 16;g_maxlives 0;g_dm_keys 1;g_timelimit 900;g_scorelimit 0;sv_intertime -1;centerprint 100 GAMEMODE: DM;nextmap PrikolSoft.wad MAP01;event onmapend call cmap02;bot_removeall" + +# [CHANGING MAP POOL] +alias standart "nextmap PrikolSoft.wad MAP01;event onmapend call cmap02;centerprint 100 Activated map pool: Standart" + +# [MAPLIST: MAIN] +alias cmap01 "event onmapstart nextmap PrikolSoft.wad MAP01; event onmapend call cmap02" +alias cmap02 "event onmapstart nextmap SurMP.wad MAP01; event onmapend call cmap03" +alias cmap03 "event onmapstart nextmap PrikolSoft.wad MAP01; event onmapend call cmap04" +alias cmap04 "event onmapstart nextmap IDM.wad MAP01; event onmapend call cmap05" +alias cmap05 "event onmapstart nextmap DF_DM_MAPS.wad MAP08; event onmapend call cmap01" + + +# [STARTING] +bot_removeall +event oninter "" +event onmapend call cmap01 + +# [GAMESETTINGS] +g_allow_exit 1 +g_allow_monsters 1 +g_bot_vsmonsters 1 +g_bot_vsplayers 1 +g_dm_keys 1 +g_friendlyfire 0 +g_gamemode DM +g_item_respawn_time 60 +g_maxlives 0 +g_save_stats 1 +g_scorelimit 0 +g_screenshot_stats 1 +g_spawn_invul 0 +g_timelimit 900 +g_warmup_time 16 +g_weaponstay 1 + +# For team modes +g_friendly_hit_trace 1 +g_friendly_hit_projectile 1 +g_friendly_absorb_damage 1 +g_allow_dropflag 1 + +# [SERVERSETTING] +net_master_list mpms.doom2d.org:25665,deadsoftware.ru:25665,terminalcorner.ru:25665 +rdl_hashdb_save_enabled 1 +rdl_ignore_enabled 1 +rdl_ignore_names standart;shrshade +sv_intertime -1 +sv_master_interval 60000 +sv_maxplrs 16 +sv_name "Default Server" +sv_port 25667 +sv_public 1 +sv_rcon 1 +sv_rcon_password +sv_reliable_interval 18 +sv_update_interval 0 diff --git a/man/HOWTO b/man/HOWTO new file mode 100644 index 0000000..807530f --- /dev/null +++ b/man/HOWTO @@ -0,0 +1,4 @@ +If you want to convert this txt to man, you need a k8ttman (see https://repo.or.cz/k8ttman.git). +Build them, copy txt file to program directory and run: + + ./ttman d2df.txt d2df.1 diff --git a/man/d2df.txt b/man/d2df.txt index 47aff36..8cd8db1 100644 --- a/man/d2df.txt +++ b/man/d2df.txt @@ -65,20 +65,20 @@ By default, the game checks the entire disc for game files. (The editor can't se @h1 URLS Our site:@br -http://doom2d.org +https://doom2d.org Our forum:@br -http://doom2d.org/forum/index.php +https://doom2d.org/forum/index.php Our IRC:@br irc.wenet.ru:6677 #doom2d Our Telegram:@br -http://https://t.me/doom2d_channel - Channel@br -http://t.me/doom2d - Chat +https://t.me/doom2d_channel - Channel@br +https://t.me/doom2d - Chat Our Discord:@br -http://discord.gg/sGpJwMy +https://discord.gg/sGpJwMy @h1 AUTHOR From 43701ac5d1240cd258e5a056201b39ca6d4435c7 Mon Sep 17 00:00:00 2001 From: TerminalHash Date: Wed, 8 Mar 2023 15:47:55 +0300 Subject: [PATCH 3/7] More manuals --- man/HOWTO | 22 ++- man/{d2df.txt => en/d2df.1.txt} | 10 +- man/en/d2df.2.txt | 272 ++++++++++++++++++++++++++++++++ man/en/d2df.3.txt | 268 +++++++++++++++++++++++++++++++ man/ru/d2df.1.txt | 90 +++++++++++ man/ru/d2df.2.txt | 272 ++++++++++++++++++++++++++++++++ man/ru/d2df.3.txt | 268 +++++++++++++++++++++++++++++++ 7 files changed, 1198 insertions(+), 4 deletions(-) rename man/{d2df.txt => en/d2df.1.txt} (92%) create mode 100644 man/en/d2df.2.txt create mode 100644 man/en/d2df.3.txt create mode 100644 man/ru/d2df.1.txt create mode 100644 man/ru/d2df.2.txt create mode 100644 man/ru/d2df.3.txt diff --git a/man/HOWTO b/man/HOWTO index 807530f..46f93ab 100644 --- a/man/HOWTO +++ b/man/HOWTO @@ -1,4 +1,24 @@ If you want to convert this txt to man, you need a k8ttman (see https://repo.or.cz/k8ttman.git). Build them, copy txt file to program directory and run: - ./ttman d2df.txt d2df.1 + ./ttman d2df.1.txt d2df.1 + ./ttman d2df.2.txt d2df.2 + ./ttman d2df.3.txt d2df.3 + +For the manual to be detectable by man/man-db, it must be packed into a .gz archive. We do this with the command: + + gzip -c d2df.1 > d2df.1.gz + gzip -c d2df.2 > d2df.2.gz + gzip -c d2df.3 > d2df.3.gz + +Then put them in directories based on the number in the name: + + d2df.1 = /usr/share/man/man1 + d2df.2 = /usr/share/man/man2 + d2df.3 = /usr/share/man/man3 + +For russian version, you must use txt from directory "ru" to convert/compression and put them to: + + d2df.1 = /usr/share/man/ru/man1 + d2df.2 = /usr/share/man/ru/man2 + d2df.3 = /usr/share/man/ru/man3 diff --git a/man/d2df.txt b/man/en/d2df.1.txt similarity index 92% rename from man/d2df.txt rename to man/en/d2df.1.txt index 8cd8db1..d4a12b4 100644 --- a/man/d2df.txt +++ b/man/en/d2df.1.txt @@ -1,7 +1,8 @@ -@title Doom2DF 1 06.07.2021 1 1 +@title Doom2DF 1 08.03.2023 1 1 @h1 NAME -Doom2DF - Doom 2D Forever game. +Doom2DF - main game binary.@br +Doom2DF_H - dedicated server binary. @h1 SYNOPSIS Doom2DF [*ARGUMENTS*]... [*OPTION*]...@br @@ -9,7 +10,7 @@ Doom2DF_H [*ARGUMENTS*]... [*OPTION*]... @h1 DESCRIPTION -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 +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.@br Note: documentation is not finished yet. @@ -80,6 +81,9 @@ https://t.me/doom2d - Chat Our Discord:@br https://discord.gg/sGpJwMy +@h1 SEE ALSO + +*d2df*(2), *d2df*(3) @h1 AUTHOR diff --git a/man/en/d2df.2.txt b/man/en/d2df.2.txt new file mode 100644 index 0000000..2b4ea9a --- /dev/null +++ b/man/en/d2df.2.txt @@ -0,0 +1,272 @@ +@title Doom2DF 2 08.03.2023 2 2 + +@h1 NAME +Doom 2D Forever console commands. + + +@h1 CONTENTS + +1. System commands + +2. Binds + +3. Console commands + +4. Debug commands + +5. Game commands + +6. Cheats + + +@h1 1. System commands + +quit, exit + Exit from game. +r_reset + Reload render. +r_maxfps + Limiting the number of frames per second +g_language Russian/English + Change game language. + + +@h1 2. Binds + +bind + Bind a key behind a command. +bindrep + (?) +bindunrep + (?) +bindlist + Show a bind list. +unbind + Remove the bind from the key. +unbindall + Remove binds from all keys (not recommended). +togglemenu + Show or hide the main menu/game menu. +toggleconsole + Show or hide the console. +togglechat + Show or hide the chat. +toggleteamchat + Show or hide the team chat. + +@h2 For device with touchscreen +showkeyboard + Show virtual keyboard. +hidekeyboard + Hide virtual keyboard. + + +@h1 3. Console commands +clear + Clear console window. +clearhistory + Clear commands history. +showhistory + Show commands history +commands + Show command list. +time + Show current time. +date + Show current date. +echo "" + Output the typed characters to the console. +dump + Take a dump. +exec + Execute custom cfg. +writeconfig + Write to cfg. +alias "" + Set a sequence of commands to be executed after a certain name. +call + Execute alias. +ver, version + Show game version. + + +@h1 4. Debug commands + +d_window + Show window resolution. +d_sounds 1/0 + Sound debugging. +d_frames 1/0 + Show item, entities hitboxes. +d_winmsg 1/0 + (?) +d_monoff 1/0 + Switch the work of the AI monsters. +d_botoff 3/2/1/0 + Switch the work of the AI bots. +d_health 1/0 + Toggle the display of XP in numerical form. +d_player 1/0 + Toggle the display of player coordinates. +d_joy 1/0 + (?) +d_mem 1/0 + Toggle the heap status display. + +@h2 Monsters +d_monster + Spawn a monster with a specific behavior. If no behavior is specified, the default behavior is set (normal). + +ID: + 1 - Pinky + 2 - Imp + 3 - Zombie + 4 - Shotgun Guy + 5 - Cyberdemon + 6 - Chaingunner + 7 - Baron of Hell + 8 - Hell Knight + 9 - Cacodemon + 10 - Lost Soul + 11 - Pain Elemental + 12 - Spider Mastermind + 13 - Arachnotron + 14 - Mancubus + 15 - Revenant + 16 - Arch-vile + 17 - Fish + 18 - Barrrel + 19 - Robot + 20 - Prikolist + +Behavior: + 0 - killer + 1 - maniac + 2 - insane + 3 - cannibal, attacks both the player and monsters + 4 - good, player friendly, hostile to monsters + +@h1 5. Game commands + +pause + Pause the game. +endgame + End game (sends to the main menu). +restart + Restart map. +addbot, bot_add + Add bot to game session. +bot_addlist + Add bot to game session from list. If no name is specified, adds a random bot. +bot_addred + Add bot to red team. +bot_addblue + Add bot to blue team. +bot_removeall + Remove all bots from game session. +chat + Send text to chat. +teamchat + Send text to team chat +announce, an + Display the text in the middle of the screen. +game + Run the game on a certain map with a certain number of players (one to two). +host + To get the game at a certain address, with a certain port on some map with some number of players. +map + Change map immediately. +nextmap + Announce the next map. +endmap + Finish the round. +goodbye + Finish the megawad/campaing map. +suicide + Suicide. +spectate + Spectating the game. +ready + Declare readiness during Survival and derivative modes. +kick + Kick a player with a certain nickname. +kick_id + Kick a player with a certain id. +kick_pid + Kick a player with a certain pid. +ban + Ban a player with a certain nickname. +ban_id + Ban a player with a certain id. +ban_pid + Ban a player with a certain pid. +permban + Ban a player permanently with a certain nickname. +permban_id + Ban a player permanently with a certain id. +permban_pid + Ban a player permanently with a certain pid. +permban_ip + Ban a player permanently by ip. +unban + Unban a player. +connect <порт> <пароль> + Connect to the server. +disconnect + Disconnect from the server. +reconnect + Reconnect to the server where you were last on. +say + Write in chat on behalf of the server. +tell + Write to the player on behalf of the server. +centerprint