ref: eb0c1ba61a7230c457442124ebbb7c6c28c9662e
dir: /src/hexen/h2_main.c/
//
// Copyright(C) 1993-1996 Id Software, Inc.
// Copyright(C) 1993-2008 Raven Software
// Copyright(C) 2005-2014 Simon Howard
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// HEADER FILES ------------------------------------------------------------
// haleyjd: removed WATCOMC
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#include "config.h"
#include "h2def.h"
#include "ct_chat.h"
#include "d_iwad.h"
#include "d_mode.h"
#include "m_misc.h"
#include "s_sound.h"
#include "i_input.h"
#include "i_joystick.h"
#include "i_system.h"
#include "i_timer.h"
#include "m_argv.h"
#include "m_config.h"
#include "m_controls.h"
#include "net_client.h"
#include "p_local.h"
#include "v_video.h"
#include "w_main.h"
// MACROS ------------------------------------------------------------------
#define MAXWADFILES 20
#define CT_KEY_BLUE 'b'
#define CT_KEY_RED 'r'
#define CT_KEY_YELLOW 'y'
#define CT_KEY_GREEN 'g'
#define CT_KEY_PLAYER5 'j' // Jade
#define CT_KEY_PLAYER6 'w' // White
#define CT_KEY_PLAYER7 'h' // Hazel
#define CT_KEY_PLAYER8 'p' // Purple
#define CT_KEY_ALL 't'
// EXTERNAL FUNCTION PROTOTYPES --------------------------------------------
void R_ExecuteSetViewSize(void);
void D_ConnectNetGame(void);
void D_CheckNetGame(void);
boolean F_Responder(event_t * ev);
void I_StartupKeyboard(void);
void I_StartupJoystick(void);
void I_ShutdownKeyboard(void);
void S_InitScript(void);
// PUBLIC FUNCTION PROTOTYPES ----------------------------------------------
void H2_ProcessEvents(void);
void H2_DoAdvanceDemo(void);
void H2_AdvanceDemo(void);
void H2_StartTitle(void);
void H2_PageTicker(void);
// PRIVATE FUNCTION PROTOTYPES ---------------------------------------------
static void DrawMessage(void);
static void PageDrawer(void);
static void HandleArgs(void);
static void CheckRecordFrom(void);
static void DrawAndBlit(void);
static void CreateSavePath(void);
static void WarpCheck(void);
// EXTERNAL DATA DECLARATIONS ----------------------------------------------
extern boolean automapactive;
extern boolean MenuActive;
extern boolean askforquit;
// PUBLIC DATA DEFINITIONS -------------------------------------------------
GameMode_t gamemode;
char *gamedescription;
char *iwadfile;
static char demolumpname[9]; // Demo lump to start playing.
boolean nomonsters; // checkparm of -nomonsters
boolean respawnparm; // checkparm of -respawn
boolean randomclass; // checkparm of -randclass
boolean debugmode; // checkparm of -debug
boolean ravpic; // checkparm of -ravpic
boolean cdrom = false; // true if cd-rom mode active
boolean cmdfrag; // true if a CMD_FRAG packet should be sent out
boolean artiskip; // whether shift-enter skips an artifact
int maxzone = 0x800000; // Maximum allocated for zone heap (8meg default)
skill_t startskill;
int startepisode;
int startmap;
boolean autostart;
boolean advancedemo;
FILE *debugfile;
int UpdateState;
int maxplayers = MAXPLAYERS;
// PRIVATE DATA DEFINITIONS ------------------------------------------------
static int WarpMap;
static int demosequence;
static int pagetic;
static char *pagename;
static char *SavePathConfig;
// CODE --------------------------------------------------------------------
void D_BindVariables(void)
{
int i;
M_ApplyPlatformDefaults();
I_BindInputVariables();
I_BindVideoVariables();
I_BindJoystickVariables();
I_BindSoundVariables();
M_BindBaseControls();
M_BindMapControls();
M_BindMenuControls();
M_BindWeaponControls();
M_BindChatControls(MAXPLAYERS);
M_BindHereticControls();
M_BindHexenControls();
key_multi_msgplayer[0] = CT_KEY_BLUE;
key_multi_msgplayer[1] = CT_KEY_RED;
key_multi_msgplayer[2] = CT_KEY_YELLOW;
key_multi_msgplayer[3] = CT_KEY_GREEN;
key_multi_msgplayer[4] = CT_KEY_PLAYER5;
key_multi_msgplayer[5] = CT_KEY_PLAYER6;
key_multi_msgplayer[6] = CT_KEY_PLAYER7;
key_multi_msgplayer[7] = CT_KEY_PLAYER8;
NET_BindVariables();
M_BindIntVariable("graphical_startup", &graphical_startup);
M_BindIntVariable("mouse_sensitivity", &mouseSensitivity);
M_BindIntVariable("sfx_volume", &snd_MaxVolume);
M_BindIntVariable("music_volume", &snd_MusicVolume);
M_BindIntVariable("messageson", &messageson);
M_BindIntVariable("screenblocks", &screenblocks);
M_BindIntVariable("snd_channels", &snd_Channels);
M_BindIntVariable("vanilla_savegame_limit", &vanilla_savegame_limit);
M_BindIntVariable("vanilla_demo_limit", &vanilla_demo_limit);
M_BindStringVariable("savedir", &SavePathConfig);
// Multiplayer chat macros
for (i=0; i<10; ++i)
{
char buf[12];
M_snprintf(buf, sizeof(buf), "chatmacro%i", i);
M_BindStringVariable(buf, &chat_macros[i]);
}
}
// Set the default directory where hub savegames are saved.
static void D_SetDefaultSavePath(void)
{
SavePath = M_GetSaveGameDir("hexen.wad");
if (!strcmp(SavePath, ""))
{
// only get hexen.cfg path if one is not already found
if (SavePathConfig == NULL || !strcmp(SavePathConfig, ""))
{
// If we are not using a savegame path (probably because we are on
// Windows and not using a config dir), behave like Vanilla Hexen
// and use hexndata/:
SavePath = malloc(10);
M_snprintf(SavePath, 10, "hexndata%c", DIR_SEPARATOR);
}
else
{
SavePath = M_StringDuplicate(SavePathConfig);
}
}
// only set hexen.cfg path if using default handling
if (!M_ParmExists("-savedir") && !M_ParmExists("-cdrom"))
{
SavePathConfig = SavePath;
}
}
// The Mac version of the Hexen IWAD is different to the "normal" DOS
// version - it doesn't include lumps used by the DOS DMX library.
// This means that we can't do GUS or OPL emulation and need to apply
// a workaround.
static void AdjustForMacIWAD(void)
{
boolean adjust_music = false;
switch (snd_musicdevice)
{
case SNDDEVICE_ADLIB:
case SNDDEVICE_SB:
adjust_music = W_CheckNumForName("GENMIDI") < 0;
break;
case SNDDEVICE_GUS:
adjust_music = W_CheckNumForName("DMXGUS") < 0;
break;
default:
break;
}
if (adjust_music)
{
printf("** Note: You appear to be using the Mac version of the Hexen\n"
"** IWAD file. This is missing the lumps required for OPL or\n"
"** GUS emulation. Your music configuration is being adjusted\n"
"** to a different setting that won't cause the game to "
"crash.\n");
snd_musicdevice = SNDDEVICE_GENMIDI;
}
}
//
// D_GrabMouseCallback
//
// Called to determine whether to grab the mouse pointer
//
static boolean D_GrabMouseCallback(void)
{
// when menu is active or game is paused, release the mouse
if (MenuActive || paused)
return false;
// only grab mouse when playing levels (but not demos)
return (gamestate == GS_LEVEL) && !advancedemo && !demoplayback;
}
// Message displayed when quitting Hexen
static void D_HexenQuitMessage(void)
{
printf("\nHexen: Beyond Heretic\n");
}
static void D_AddFile(char *filename)
{
printf(" adding %s\n", filename);
W_AddFile(filename);
}
// Find out what version of Hexen is playing.
void D_IdentifyVersion(void)
{
// The Hexen Shareware, ne 4 Level Demo Version, is missing the SKY1 lump
// and uses the SKY2 lump instead. Let's use this fact and the missing
// levels from MAP05 onward to identify it and set gamemode accordingly.
if (W_CheckNumForName("SKY1") == -1 &&
W_CheckNumForName("MAP05") == -1 )
{
gamemode = shareware;
maxplayers = 4;
}
// The v1.0 IWAD file is missing a bunch of lumps that can cause the game
// to crash, so we exit with an error if the user tries to play with it.
// But we provide an override command line flag if they really want to
// do it.
//!
// If provided, the check for the v1.0 IWAD file is disabled, even though
// it will almost certainly cause the game to crash.
//
// @category compat
//
if (!M_ParmExists("-v10override")
&& gamemode != shareware && W_CheckNumForName("CLUS1MSG") < 0)
{
I_Error(
"You are trying to use the Hexen v1.0 IWAD. This isn't\n"
"supported by " PACKAGE_NAME ". Please upgrade to the v1.1\n"
"IWAD file. See here for more information:\n"
" https://www.doomworld.com/classicdoom/info/patches.php");
}
}
// Set the gamedescription string.
void D_SetGameDescription(void)
{
/*
NB: The 4 Level Demo Version actually prints a four-lined banner
(and indeed waits for a keypress):
Hexen: Beyond Heretic
4 Level Demo Version
Press any key to continue.
*/
if (gamemode == shareware)
{
gamedescription = "Hexen: 4 Level Demo Version";
}
else
{
gamedescription = "Hexen";
}
}
//==========================================================================
//
// H2_Main
//
//==========================================================================
void InitMapMusicInfo(void);
void D_DoomMain(void)
{
GameMission_t gamemission;
int p;
I_AtExit(D_HexenQuitMessage, false);
startepisode = 1;
autostart = false;
startskill = sk_medium;
startmap = 1;
gamemode = commercial;
I_PrintBanner(PACKAGE_STRING);
// Initialize subsystems
ST_Message("V_Init: allocate screens.\n");
V_Init();
// Load defaults before initing other systems
ST_Message("M_LoadDefaults: Load system defaults.\n");
D_BindVariables();
#ifdef _WIN32
//!
// @platform windows
// @vanilla
//
// Save configuration data and savegames in c:\hexndata,
// allowing play from CD.
//
cdrom = M_ParmExists("-cdrom");
#endif
if (cdrom)
{
M_SetConfigDir("c:\\hexndata\\");
}
else
{
M_SetConfigDir(NULL);
}
M_SetConfigFilenames("hexen.cfg", PROGRAM_PREFIX "hexen.cfg");
M_LoadDefaults();
D_SetDefaultSavePath();
I_AtExit(M_SaveDefaults, false);
// Now that the savedir is loaded, make sure it exists
CreateSavePath();
ST_Message("Z_Init: Init zone memory allocation daemon.\n");
Z_Init();
// haleyjd: removed WATCOMC
ST_Message("W_Init: Init WADfiles.\n");
iwadfile = D_FindIWAD(IWAD_MASK_HEXEN, &gamemission);
if (iwadfile == NULL)
{
I_Error("Game mode indeterminate. No IWAD was found. Try specifying\n"
"one with the '-iwad' command line parameter.");
}
D_AddFile(iwadfile);
W_CheckCorrectIWAD(hexen);
D_IdentifyVersion();
D_SetGameDescription();
AdjustForMacIWAD();
HandleArgs();
I_PrintStartupBanner(gamedescription);
ST_Message("MN_Init: Init menu system.\n");
MN_Init();
ST_Message("CT_Init: Init chat mode data.\n");
CT_Init();
InitMapMusicInfo(); // Init music fields in mapinfo
ST_Message("S_InitScript\n");
S_InitScript();
ST_Message("SN_InitSequenceScript: Registering sound sequences.\n");
SN_InitSequenceScript();
ST_Message("I_Init: Setting up machine state.\n");
I_CheckIsScreensaver();
I_InitTimer();
I_InitJoystick();
I_InitSound(false);
I_InitMusic();
ST_Message("NET_Init: Init networking subsystem.\n");
NET_Init();
D_ConnectNetGame();
S_Init();
S_Start();
ST_Message("ST_Init: Init startup screen.\n");
ST_Init();
// Show version message now, so it's visible during R_Init()
ST_Message("R_Init: Init Hexen refresh daemon");
R_Init();
ST_Message("\n");
//if (M_CheckParm("-net"))
// ST_NetProgress(); // Console player found
ST_Message("P_Init: Init Playloop state.\n");
P_Init();
// Check for command line warping. Follows P_Init() because the
// MAPINFO.TXT script must be already processed.
WarpCheck();
ST_Message("D_CheckNetGame: Checking network game status.\n");
D_CheckNetGame();
ST_Message("SB_Init: Loading patches.\n");
SB_Init();
ST_Done();
if (autostart)
{
ST_Message("Warp to Map %d (\"%s\":%d), Skill %d\n",
WarpMap, P_GetMapName(startmap), startmap, startskill + 1);
}
CheckRecordFrom();
p = M_CheckParm("-record");
if (p && p < myargc - 1)
{
G_RecordDemo(startskill, 1, startepisode, startmap, myargv[p + 1]);
H2_GameLoop(); // Never returns
}
p = M_CheckParmWithArgs("-playdemo", 1);
if (p)
{
singledemo = true; // Quit after one demo
G_DeferedPlayDemo(demolumpname);
H2_GameLoop(); // Never returns
}
p = M_CheckParmWithArgs("-timedemo", 1);
if (p)
{
G_TimeDemo(demolumpname);
H2_GameLoop(); // Never returns
}
//!
// @arg <s>
// @vanilla
//
// Load the game in savegame slot s.
//
p = M_CheckParmWithArgs("-loadgame", 1);
if (p)
{
G_LoadGame(atoi(myargv[p + 1]));
}
if (gameaction != ga_loadgame)
{
UpdateState |= I_FULLSCRN;
BorderNeedRefresh = true;
if (autostart || netgame)
{
G_StartNewInit();
G_InitNew(startskill, startepisode, startmap);
}
else
{
H2_StartTitle();
}
}
H2_GameLoop(); // Never returns
}
//==========================================================================
//
// HandleArgs
//
//==========================================================================
static void HandleArgs(void)
{
int p;
//!
// @vanilla
//
// Disable monsters.
//
nomonsters = M_ParmExists("-nomonsters");
//!
// @vanilla
//
// Monsters respawn after being killed.
//
respawnparm = M_ParmExists("-respawn");
//!
// @vanilla
// @category net
//
// In deathmatch mode, change a player's class each time the
// player respawns.
//
randomclass = M_ParmExists("-randclass");
//!
// @vanilla
//
// Take screenshots when F1 is pressed.
//
ravpic = M_ParmExists("-ravpic");
//!
// @vanilla
//
// Don't allow artifacts to be used when the run key is held down.
//
artiskip = M_ParmExists("-artiskip");
debugmode = M_ParmExists("-debug");
//!
// @vanilla
// @category net
//
// Start a deathmatch game.
//
deathmatch = M_ParmExists("-deathmatch");
// currently broken or unused:
cmdfrag = M_ParmExists("-cmdfrag");
// Check WAD file command line options
W_ParseCommandLine();
//!
// @vanilla
// @arg <path>
//
// Development option to specify path to level scripts.
//
p = M_CheckParmWithArgs("-scripts", 1);
if (p)
{
sc_FileScripts = true;
sc_ScriptsDir = myargv[p+1];
}
//!
// @arg <skill>
// @vanilla
//
// Set the game skill, 1-5 (1: easiest, 5: hardest). A skill of
// 0 disables all monsters.
//
p = M_CheckParmWithArgs("-skill", 1);
if (p)
{
startskill = myargv[p+1][0] - '1';
autostart = true;
}
//!
// @arg <demo>
// @category demo
// @vanilla
//
// Play back the demo named demo.lmp.
//
p = M_CheckParmWithArgs("-playdemo", 1);
if (!p)
{
//!
// @arg <demo>
// @category demo
// @vanilla
//
// Play back the demo named demo.lmp, determining the framerate
// of the screen.
//
p = M_CheckParmWithArgs("-timedemo", 1);
}
if (p)
{
char *uc_filename;
char file[256];
M_StringCopy(file, myargv[p+1], sizeof(file));
// With Vanilla Hexen you have to specify the file without
// extension, but make that optional.
uc_filename = strdup(myargv[p + 1]);
M_ForceUppercase(uc_filename);
if (!M_StringEndsWith(uc_filename, ".LMP"))
{
M_StringConcat(file, ".lmp", sizeof(file));
}
free(uc_filename);
if (W_AddFile(file) != NULL)
{
M_StringCopy(demolumpname, lumpinfo[numlumps - 1]->name,
sizeof(demolumpname));
}
else
{
// The file failed to load, but copy the original arg as a
// demo name to make tricks like -playdemo demo1 possible.
M_StringCopy(demolumpname, myargv[p+1], sizeof(demolumpname));
}
ST_Message("Playing demo %s.\n", myargv[p+1]);
}
//!
// @category demo
//
// Record or playback a demo without automatically quitting
// after either level exit or player respawn.
//
demoextend = M_ParmExists("-demoextend");
if (M_ParmExists("-testcontrols"))
{
autostart = true;
testcontrols = true;
}
}
//==========================================================================
//
// WarpCheck
//
//==========================================================================
static void WarpCheck(void)
{
int p;
int map;
p = M_CheckParm("-warp");
if (p && p < myargc - 1)
{
WarpMap = atoi(myargv[p + 1]);
map = P_TranslateMap(WarpMap);
if (map == -1)
{ // Couldn't find real map number
startmap = 1;
ST_Message("-WARP: Invalid map number.\n");
}
else
{ // Found a valid startmap
startmap = map;
autostart = true;
}
}
else
{
WarpMap = 1;
startmap = P_TranslateMap(1);
if (startmap == -1)
{
startmap = 1;
}
}
}
//==========================================================================
//
// H2_GameLoop
//
//==========================================================================
void H2_GameLoop(void)
{
if (M_CheckParm("-debugfile"))
{
char filename[20];
M_snprintf(filename, sizeof(filename), "debug%i.txt", consoleplayer);
debugfile = fopen(filename, "w");
}
I_SetWindowTitle(gamedescription);
I_GraphicsCheckCommandLine();
I_SetGrabMouseCallback(D_GrabMouseCallback);
I_InitGraphics();
while (1)
{
// Frame syncronous IO operations
I_StartFrame();
// Process one or more tics
// Will run at least one tic
TryRunTics();
// Move positional sounds
S_UpdateSounds(players[displayplayer].mo);
DrawAndBlit();
}
}
//==========================================================================
//
// H2_ProcessEvents
//
// Send all the events of the given timestamp down the responder chain.
//
//==========================================================================
void H2_ProcessEvents(void)
{
event_t *ev;
for (;;)
{
ev = D_PopEvent();
if (ev == NULL)
{
break;
}
if (F_Responder(ev))
{
continue;
}
if (MN_Responder(ev))
{
continue;
}
G_Responder(ev);
}
}
//==========================================================================
//
// DrawAndBlit
//
//==========================================================================
static void DrawAndBlit(void)
{
// Change the view size if needed
if (setsizeneeded)
{
R_ExecuteSetViewSize();
}
// Do buffered drawing
switch (gamestate)
{
case GS_LEVEL:
if (!gametic)
{
break;
}
if (automapactive)
{
AM_Drawer();
}
else
{
R_RenderPlayerView(&players[displayplayer]);
}
CT_Drawer();
UpdateState |= I_FULLVIEW;
SB_Drawer();
break;
case GS_INTERMISSION:
IN_Drawer();
break;
case GS_FINALE:
F_Drawer();
break;
case GS_DEMOSCREEN:
PageDrawer();
break;
}
if (testcontrols)
{
V_DrawMouseSpeedBox(testcontrols_mousespeed);
}
if (paused && !MenuActive && !askforquit)
{
if (!netgame)
{
V_DrawPatch(160, viewwindowy + 5, W_CacheLumpName("PAUSED",
PU_CACHE));
}
else
{
V_DrawPatch(160, 70, W_CacheLumpName("PAUSED", PU_CACHE));
}
}
// Draw current message
DrawMessage();
// Draw Menu
MN_Drawer();
// Send out any new accumulation
NetUpdate();
// Flush buffered stuff to screen
I_FinishUpdate();
}
//==========================================================================
//
// DrawMessage
//
//==========================================================================
static void DrawMessage(void)
{
player_t *player;
player = &players[consoleplayer];
if (player->messageTics <= 0)
{ // No message
return;
}
if (player->yellowMessage)
{
MN_DrTextAYellow(player->message,
160 - MN_TextAWidth(player->message) / 2, 1);
}
else
{
MN_DrTextA(player->message, 160 - MN_TextAWidth(player->message) / 2,
1);
}
}
//==========================================================================
//
// H2_PageTicker
//
//==========================================================================
void H2_PageTicker(void)
{
if (--pagetic < 0)
{
H2_AdvanceDemo();
}
}
//==========================================================================
//
// PageDrawer
//
//==========================================================================
static void PageDrawer(void)
{
V_DrawRawScreen(W_CacheLumpName(pagename, PU_CACHE));
if (demosequence == 1)
{
V_DrawPatch(4, 160, W_CacheLumpName("ADVISOR", PU_CACHE));
}
UpdateState |= I_FULLSCRN;
}
//==========================================================================
//
// H2_AdvanceDemo
//
// Called after each demo or intro demosequence finishes.
//
//==========================================================================
void H2_AdvanceDemo(void)
{
advancedemo = true;
}
//==========================================================================
//
// H2_DoAdvanceDemo
//
//==========================================================================
void H2_DoAdvanceDemo(void)
{
players[consoleplayer].playerstate = PST_LIVE; // don't reborn
advancedemo = false;
usergame = false; // can't save/end game here
paused = false;
gameaction = ga_nothing;
demosequence = (demosequence + 1) % 7;
switch (demosequence)
{
case 0:
pagetic = 280;
gamestate = GS_DEMOSCREEN;
pagename = "TITLE";
S_StartSongName("hexen", true);
break;
case 1:
pagetic = 210;
gamestate = GS_DEMOSCREEN;
pagename = "TITLE";
break;
case 2:
BorderNeedRefresh = true;
UpdateState |= I_FULLSCRN;
G_DeferedPlayDemo("demo1");
break;
case 3:
pagetic = 200;
gamestate = GS_DEMOSCREEN;
pagename = "CREDIT";
break;
case 4:
BorderNeedRefresh = true;
UpdateState |= I_FULLSCRN;
G_DeferedPlayDemo("demo2");
break;
case 5:
pagetic = 200;
gamestate = GS_DEMOSCREEN;
pagename = "CREDIT";
break;
case 6:
BorderNeedRefresh = true;
UpdateState |= I_FULLSCRN;
G_DeferedPlayDemo("demo3");
break;
}
}
//==========================================================================
//
// H2_StartTitle
//
//==========================================================================
void H2_StartTitle(void)
{
gameaction = ga_nothing;
demosequence = -1;
H2_AdvanceDemo();
}
//==========================================================================
//
// CheckRecordFrom
//
// -recordfrom <savegame num> <demoname>
//
//==========================================================================
static void CheckRecordFrom(void)
{
int p;
p = M_CheckParm("-recordfrom");
if (!p || p > myargc - 2)
{ // Bad args
return;
}
G_LoadGame(atoi(myargv[p + 1]));
G_DoLoadGame(); // Load the gameskill etc info from savegame
G_RecordDemo(gameskill, 1, gameepisode, gamemap, myargv[p + 2]);
H2_GameLoop(); // Never returns
}
// haleyjd: removed WATCOMC
/*
void CleanExit(void)
{
union REGS regs;
I_ShutdownKeyboard();
regs.x.eax = 0x3;
int386(0x10, ®s, ®s);
printf("Exited from HEXEN: Beyond Heretic.\n");
exit(1);
}
*/
//==========================================================================
//
// CreateSavePath
//
//==========================================================================
static void CreateSavePath(void)
{
M_MakeDirectory(SavePath);
}