Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add maplist examples and manual for GNU/Linux. #2

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions examples/maplist_coop.txt
Original file line number Diff line number Diff line change
@@ -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
58 changes: 58 additions & 0 deletions examples/maplist_dm.txt
Original file line number Diff line number Diff line change
@@ -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
24 changes: 24 additions & 0 deletions man/HOWTO
Original file line number Diff line number Diff line change
@@ -0,0 +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.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
90 changes: 90 additions & 0 deletions man/en/d2df.1.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
@title Doom2DF 1 08.03.2023 1 1

@h1 NAME
Doom2DF - main game binary.@br
Doom2DF_H - dedicated server binary.

@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.@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
https://doom2d.org

Our forum:@br
https://doom2d.org/forum/index.php

Our IRC:@br
irc.wenet.ru:6677 #doom2d

Our Telegram:@br
https://t.me/doom2d_channel - Channel@br
https://t.me/doom2d - Chat

Our Discord:@br
https://discord.gg/sGpJwMy

@h1 SEE ALSO

*d2df*(2), *d2df*(3)

@h1 AUTHOR

Written by Dmitry Lyashuk <lyashuk.voxx\@gmail.com>, Doom 2D: Forever Developers.
Loading