Skip to content

Commit

Permalink
fixed various assorted issues from draft PR
Browse files Browse the repository at this point in the history
  • Loading branch information
@elf-alchemist
elf-alchemist committed Jan 12, 2025
1 parent 290cc6a commit 1a1c509
Show file tree
Hide file tree
Showing 4 changed files with 131 additions and 164 deletions.
3 changes: 2 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,8 @@ Copyright:
© 2022-2024 Alaux;
© 2022-2024 ceski;
© 2023 Andrew Apted;
© 2023 liPillON.
© 2023 liPillON;
© 2025 Guilherme Miranda.
License: [GPL-2.0+](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)

Files: `src/i_flickstick.*, src/i_gyro.*`
Expand Down
188 changes: 62 additions & 126 deletions src/d_demoloop.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,143 +12,80 @@
// GNU General Public License for more details.
//
// DESCRIPTION:
// ID24 DemoLoop
// ID24 DemoLoop Specification - User customizable title screen sequence.
// Though originally hardcoded on the original Doom engine this allows
// for Doom modders to define custom sequences, using any provided custom
// graphic-and-music, or DEMO lump.
//
// Some assorted notes about the original hardcoded behavior
// * Oddly, Doom's TITLEPIC lasts for a brifer period than Doom II.
// About ~4.857 seconds, as opposed to Doom II's exact 11 seconds.
// * HELP2 titlescreen lasts for about ~5.714 seconds.
// Used only in Shareware and Registered mode.
// * CREDIT titlescreen lasts for about ~5.714 seconds.
// Used in Retail and Commercial mode.
// * The DEMO4 lump was only present in Ultimate Doom.
// The DEMO4 entry crashed in the original Final Doom EXE's loop.

#include "doomdef.h"
#include "doomstat.h"

#include "doomtype.h"
#include "i_printf.h"
#include "m_array.h"
#include "m_json.h"
#include "w_wad.h"

#include "d_demoloop.h"

// DEMO1 lump playback.
static const demoloop_entry_t dl_demo1 = {
"DEMO1",
"",
0,
TYPE_DEMO_LUMP,
OUTRO_WIPE_SCREEM_MELT,
};

// DEMO2 lump playback.
static const demoloop_entry_t dl_demo2 = {
"DEMO2",
"",
0,
TYPE_DEMO_LUMP,
OUTRO_WIPE_SCREEM_MELT,
};

// DEMO3 lump playback.
static const demoloop_entry_t dl_demo3 = {
"DEMO3",
"",
0,
TYPE_DEMO_LUMP,
OUTRO_WIPE_SCREEM_MELT,
};

// DEMO4 lump, only present in Ultimate Doom.
// The DEMO4 entry crashed in the original Final Doom EXE's loop.
static const demoloop_entry_t dl_demo4 = {
"DEMO4",
"",
0,
TYPE_DEMO_LUMP,
OUTRO_WIPE_SCREEM_MELT,
};

// Oddly, Doom's TITLEPIC lasts for a brifer period than Doom II.
// About ~4.857 seconds, as opposed to Doom II's exact 11 seconds.
static const demoloop_entry_t dl_doom1_titlepic = {
"TITLEPIC",
"D_INTRO",
170,
TYPE_ART_SCREEN,
OUTRO_WIPE_SCREEM_MELT,
};

// HELP2 titlescreen lasts for about ~5.714 seconds.
// Used only in Registered mode.
static const demoloop_entry_t dl_help2 = {
"HELP2",
"",
200,
TYPE_ART_SCREEN,
OUTRO_WIPE_SCREEM_MELT,
};

// Plain Doom II, Commercial mode, TITLEPIC lasts for exactly 11.0 seconds.
static const demoloop_entry_t dl_doom2_titlepic = {
"TITLEPIC",
"D_DM2TTL",
385,
TYPE_ART_SCREEN,
OUTRO_WIPE_SCREEM_MELT,
};

// CREDIT titlescreen lasts for about ~5.714 seconds.
// Used in Retail and Commercial mode.
static const demoloop_entry_t dl_credit = {
"CREDIT",
"",
200,
TYPE_ART_SCREEN,
OUTRO_WIPE_SCREEM_MELT,
};

// Used to check for fault tolerance
static const demoloop_entry_t dl_none = {
static demoloop_entry_t dl_none = {
"",
"",
0,
TYPE_NONE,
OUTRO_WIPE_NONE,
-1,
-1,
};

// Doom
demoloop_entry_t demoloop_registered[6] = {
dl_doom1_titlepic,
dl_demo1,
dl_credit,
dl_demo2,
dl_help2,
dl_demo3,
demoloop_entry_t demoloop_registered[] = {
{ "TITLEPIC", "D_INTRO", 170, TYPE_ART, WIPE_MELT },
{ "DEMO1", "", 0, TYPE_DEMO, WIPE_MELT },
{ "CREDIT", "", 200, TYPE_ART, WIPE_MELT },
{ "DEMO2", "", 0, TYPE_DEMO, WIPE_MELT },
{ "HELP2", "", 200, TYPE_ART, WIPE_MELT },
{ "DEMO3", "", 0, TYPE_DEMO, WIPE_MELT },
};

// Ultiamte Doom
demoloop_entry_t demoloop_retail[7] = {
dl_doom1_titlepic,
dl_demo1,
dl_credit,
dl_demo2,
dl_credit,
dl_demo3,
dl_demo4,
// Ultimate Doom
demoloop_entry_t demoloop_retail[] = {
{ "TITLEPIC", "D_INTRO", 170, TYPE_ART, WIPE_MELT },
{ "DEMO1", "", 0, TYPE_DEMO, WIPE_MELT },
{ "CREDIT", "", 200, TYPE_ART, WIPE_MELT },
{ "DEMO2", "", 0, TYPE_DEMO, WIPE_MELT },
{ "CREDIT", "", 200, TYPE_ART, WIPE_MELT },
{ "DEMO3", "", 0, TYPE_DEMO, WIPE_MELT },
{ "DEMO4", "", 0, TYPE_DEMO, WIPE_MELT },
};

// Doom II & fixed Final Doom
demoloop_entry_t demoloop_commercial[6] = {
dl_doom2_titlepic,
dl_demo1,
dl_credit,
dl_demo2,
dl_doom2_titlepic,
dl_demo3,
demoloop_entry_t demoloop_commercial[] = {
{ "TITLEPIC", "D_DM2TTL", 385, TYPE_ART, WIPE_MELT },
{ "DEMO1", "", 0, TYPE_DEMO, WIPE_MELT },
{ "CREDIT", "", 200, TYPE_ART, WIPE_MELT },
{ "DEMO2", "", 0, TYPE_DEMO, WIPE_MELT },
{ "TITLEPIC", "D_DM2TTL", 385, TYPE_ART, WIPE_MELT },
{ "DEMO3", "", 0, TYPE_DEMO, WIPE_MELT },
};

// TNT: Evilution & The Plutonia Experiement
demoloop_entry_t demoloop_final[7] = {
dl_doom2_titlepic,
dl_demo1,
dl_credit,
dl_demo2,
dl_doom2_titlepic,
dl_demo3,
dl_demo4,
demoloop_entry_t demoloop_final[] = {
{ "TITLEPIC", "D_DM2TTL", 385, TYPE_ART, WIPE_MELT },
{ "DEMO1", "", 0, TYPE_DEMO, WIPE_MELT },
{ "CREDIT", "", 200, TYPE_ART, WIPE_MELT },
{ "DEMO2", "", 0, TYPE_DEMO, WIPE_MELT },
{ "TITLEPIC", "D_DM2TTL", 385, TYPE_ART, WIPE_MELT },
{ "DEMO3", "", 0, TYPE_DEMO, WIPE_MELT },
{ "DEMO4", "", 0, TYPE_DEMO, WIPE_MELT },
};

// For local parsing purposes only.
Expand All @@ -171,16 +108,16 @@ demoloop_entry_t D_ParseDemoLoopEntry(json_t *entry)
// We don't want a malformed entry to creep in, and break the titlescreen.
// If one such entry does exist, skip it.
// TODO: modify later to check locally for lump type.
if (type <= TYPE_NONE || type > TYPE_DEMO_LUMP)
if (type <= TYPE_NONE || type > TYPE_DEMO)
{
return dl_none;
}

// Similarly, but this time it isn't game-breaking.
// Let it gracefully default to "closest vanilla behavior".
if (outro_wipe <= OUTRO_WIPE_NONE || outro_wipe > OUTRO_WIPE_SCREEM_MELT)
if (outro_wipe <= WIPE_NONE || outro_wipe > WIPE_MELT)
{
outro_wipe = OUTRO_WIPE_SCREEM_MELT;
outro_wipe = WIPE_MELT;
}

// Providing the time in seconds is much more intuitive for the end users.
Expand Down Expand Up @@ -249,37 +186,39 @@ void D_GetDefaultDemoLoop(GameMission_t mission, GameMode_t mode)
switch(mission) {
case doom:
// The versions of Doom that have HELP2, instead.
if (mode == registered || mode == shareware) {
if (mode == registered || mode == shareware)
{
demoloop = demoloop_registered;
demoloop_count = 6;
demoloop_count = arrlen(demoloop_registered);
break;
}
case pack_chex3v:
// Check for chex3d2.wad, "Chex Quest 3: Modding Edition".
if (mode == commercial) {
if (mode == commercial)
{
demoloop = demoloop_commercial;
demoloop_count = 6;
demoloop_count = arrlen(demoloop_commercial);
break;
}
case pack_rekkr:
case pack_chex:
// Plain Ultimate Doom
demoloop = demoloop_retail;
demoloop_count = 7;
demoloop_count = arrlen(demoloop_retail);
break;

case doom2:
case pack_hacx:
// Plain Doom II
demoloop = demoloop_commercial;
demoloop_count = 6;
demoloop_count = arrlen(demoloop_commercial);
break;

case pack_tnt:
case pack_plut:
// Plain Final Doom
demoloop = demoloop_final;
demoloop_count = 7;
demoloop_count = arrlen(demoloop_final);
break;

case none:
Expand All @@ -294,10 +233,7 @@ void D_GetDefaultDemoLoop(GameMission_t mission, GameMode_t mode)
}

void D_SetupDemoLoop(void) {
if (W_CheckNumForName("DEMOLOOP") >= 0)
{
D_ParseDemoLoop();
}
D_ParseDemoLoop();

if (demoloop == NULL)
{
Expand Down
43 changes: 31 additions & 12 deletions src/d_demoloop.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,34 +12,51 @@
// GNU General Public License for more details.
//
// DESCRIPTION:
// ID24 DemoLoop
// ID24 DemoLoop Specification - User customizable title screen sequence.
// Though originally hardcoded on the original Doom engine this allows
// for Doom modders to define custom sequences, using any provided custom
// graphic, music or DEMO lump.
//
// Some assorted notes about the original hardcoded behavior
// * Plain Doom II, Commercial mode, TITLEPIC lasts for 11 seconds.
// * Oddly, Doom's TITLEPIC lasts for a brifer period than Doom II.
// About ~4.857 seconds, as opposed to Doom II's exact 11 seconds.
// * HELP2 titlescreen lasts for about ~5.714 seconds.
// Used only in Shareware and Registered mode.
// * CREDIT titlescreen lasts for about ~5.714 seconds.
// Used in Retail and Commercial mode.
// * The DEMO4 lump was only present in Ultimate Doom.
// The DEMO4 entry crashed in the original Final Doom EXE's loop.

#include "doomdef.h"

#ifndef _D_DEMOLOOP_
#define _D_DEMOLOOP_

// Screen graphic or DEMO lump, NONE is used for fault tolerance.
typedef enum
{
TYPE_NONE = -1,
TYPE_ART_SCREEN,
TYPE_DEMO_LUMP,
TYPE_ART,
TYPE_DEMO,
} dl_type_t;

// Immediate switch or screen melt, NONE is used for fault tolerance.
typedef enum
{
OUTRO_WIPE_NONE = -1,
OUTRO_WIPE_IMMEDIATE,
OUTRO_WIPE_SCREEM_MELT,
} dl_outro_wipe_t;
WIPE_NONE = -1,
WIPE_IMMEDIATE,
WIPE_MELT,
} dl_wipe_t;

// Individual demoloop units.
typedef struct
{
const char* primary_lump; // Screen graphic or DEMO lump.
const char* secondary_lump; // Music lump for screen graphic.
int duration; // Game tics.
dl_type_t type;
dl_outro_wipe_t outro_wipe;
const char *primary_lump; // Screen graphic or DEMO lump.
const char *secondary_lump; // Music lump for screen graphic.
int duration; // Game tics.
dl_type_t type;
dl_wipe_t outro_wipe;
} demoloop_entry_t;

typedef demoloop_entry_t* demoloop_t;
Expand All @@ -57,3 +74,5 @@ void D_ParseDemoLoop(void);
void D_GetDefaultDemoLoop(GameMission_t mission, GameMode_t mode);
// Perform both "D_ParseDemoLoop" and "D_GetDefaultDemoLoop".
void D_SetupDemoLoop(void);

#endif // _D_DEMOLOOP_
Loading

0 comments on commit 1a1c509

Please sign in to comment.