Projects that alter game functions but do not include new maps belong here.
Forum rules
The Projects forums are only for projects. If you are asking questions about a project, either find that project's thread, or start a thread in the General section instead.
Here's a simple little informative gameplay mod I thought up while working on my Wumpus game because I was working with map markers there.
How many times does this happen to you: You see a health/armor/ammo drop but you're too full to take it so yo plan to come back for it later. Later when you need it you're thinking, "Ok, where were all those drops I skipped?" You can mark them on your map with the built-in markers, but you only get 10 of them, and they're just numbers, you have to remember which number marks which loot, and you can't clear a single one off without clearing them all.
Also: You find a locked door, you think you remember seeing the key somewhere - did you forget to pick it up? Where was that?
Here is Loot Markers. It is a mod that automatically marks loot drops on your map and clears them when you pick it up.
Tested with Doom/2, Heretic, Hexen, Chex, Strife, and a handful of add-ons. Shouldn't conflict with other mods because it's pretty simple.
Items are marked when the player sees them. When an item is moved, the mark location is updated only if the player sees the item moving. The mark is removed if the player sees the spot where the item used to be and the item is not there. In this way this mod is not a cheat, it doesn't allow the player to track items that aren't seen.
All inventory items are automatically marked. If you want to mark other things, for example the exploding barrels, or evil eyes for playing Sigil, or if another mod with chests or crates or merchants or other things you want to mark, just put a comma separated list of items in the language files like so: AddLootMarkerTo="ExplosiveBarrel,EvilEye";EDIT: removed in favor of LOOTMARK lump
This list is case sensitive, not because of my code but because the dynamic array find() function seems to be case sensitive. So if your items aren't being marked, be sure that the case matches how the item is coded.
DOWNLOAD Download it here and check map MARKTEST to see how things are marked.
Spoiler: INSTALLATION
INSTALLATION
In the ZIP file are these two PK3 files:
MWR_Cursor3D.pk3
MWR_LootMarkers.pk3
Load them into GZDoom in that order.
Spoiler: USAGE
The options menu:
Auto Mark Pickups = automatically attach a lootmarker to pickups (inventory items) when seen
Auto Mark Other Classes = automatically attach a lootmarker to other items when seen
Auto Mark Class List = a list of classes to add lootmarkers to if the previous option is enabled
Filter = enable a filter to keep certain items from appearing on the map
Filter Classes = a list of classes to filter if the previous option is enabled
Use Position Marker = If the marker cursor is summoned without an item to mark, the position will be marked
Position Marker Color = The color of the next position marker
Position Marker Number = the number of the next position marker
Set/Remove Marker = press and hold this key to summon the marker cursor.
Cycle Marker Color = press the key to change the next position marker color
See the included README.TXT file for more details
Spoiler: UPDATES
UPDATE 2022/07/15
For the modders and power users: a new lump called LOOTMARK contains a list of rules to tell which items get automatically marked or not. Details in this post.
Because of this the AddLootMarkerTo and DontAddLootMarkerTo in the LANGUAGE lump are no longer processed. All rules should be placed in the LOOTMARK lump.
For the casual users: Added ability to manually mark or unmark items from the map. Hold the mark key (default M) and put the cursor on the item you want marked or removed. Details in this post
UPDATE 2023/08/24
Fixed to work with newer version of GZDoom. Tested on 4.10.0.
Fixed issue where items remain on map after being picked up without facing them.
For simplicity's sake I included 2 PK3 files since combining them wasn't working for everyone. Load the cursor file before the lootmarker file.
UPDATE 2023/08/26
Added filters
Fixed some cursor glitches and some other internal issues see the post
Last edited by Sir Robin on Wed Aug 30, 2023 6:56 am, edited 6 times in total.
This was something I always wanted in Doom, since the simple 0-9 markers are so simple and limited, in that you can't individually toggle number markers on or off with a matching numerical keybind. Thanks for this!
I admit, this is one of those things I didn't know I needed until I got to try it. Cheers.
I have to ask, though; what I'd like to be able to do is have my own mod provide a list of classes that any user will get drawn on their map if they load both this mod and my mod. Something like a LOOTMARK lump that I can just put class names into.
I have code lying around that does something similar already, if it would be useful.
Abba Zabba wrote:This was something I always wanted in Doom, since the simple 0-9 markers are so simple and limited, in that you can't individually toggle number markers on or off with a matching numerical keybind. Thanks for this!
Lots of times when I finish a level, I want to run back through and top-off my health, armor, ammo, etc., but can't always remember where I "left" everything. So I'll do an IDDTx2 with actors set to draw sprites, but that's a cheat because it will show me stuff I haven't officially found yet. So I wanted a non-cheat version of that and so I wrote this. Glad you like it.
TheRatCircus wrote:I have to ask, though; what I'd like to be able to do is have my own mod provide a list of classes that any user will get drawn on their map if they load both this mod and my mod. Something like a LOOTMARK lump that I can just put class names into.
You can already do that. Just put a line like this in the LANGUAGE lump: AddLootMarkerTo="ExplosiveBarrel,EvilEye";
In that list you can put classes, tags, or inheritance classes. So if you put "actor" in there it would show everything.
You can see that in the file I linked, there is a map called MARKTEST. Load that up, look at the objects on the conveyer belt. See there is an explosive barrel and an evil eye but they don't show up on the map. Now open the LANGUAGE lump and uncomment the line and run the map again. You'll see the barrel and eye on the map now.
But I can only replace that string, right? I would have to put in those two classes in addition to anything I wanted to add, and then if another mod got loaded later in the file order that also replaced it, any changes I make would be overriden.
TheRatCircus wrote:But I can only replace that string, right? I would have to put in those two classes in addition to anything I wanted to add, and then if another mod got loaded later in the file order that also replaced it, any changes I make would be overriden.
Ah, I see what you mean. I can't think of an easy way to accumulate a list instead of replace it. Even if it loaded the list from a special LOOTMARK lump, that could also be replaced by a later loading mod.
Just take out the extra console logging and you're good to go. It even supports blank lines and single-line comments, though you could just as well take that out too.
Awesome. I'll have a look. Meanwhile I've been working on an exclude list. I've got an idea for allowing each successive mod to add include and exclude rules to a list. I'll incorporate your successive lump reader into that and post it when I've got it working.
TLDR: I made some changes hardly noticeable to the typical user but very convenient to modders
So I added an exclude list along side the include list. The way it worked is that first the actor is checked for the include list, and if found, is checked for the exclude list. This works on a basic level, but if for example one mod excludes a certain class, then a later mod creates a subclass and wants it included, it can't do that. So now instead of two lists there is a list of rules each rule is checked for each spawned thing. A later rule can override an earlier one, so a later loading mod can override an earlier one's rules.
Sound complicated? It's not. Start with inventory, I want to mark all inventory items. But I don't really like blur spheres, I don't want those marked. But there's this mod with a subclass of the blur sphere that I do like, and I want that one marked. My LOOTMARK lump could look like this:
Inventory is actually included by default, no need to include that in the file, I just did that for a demo.
Also, MapMarker is hard-coded as an exclude, and can never be included. That prevents markers from marking markers marking markers infinitely.
class MarkerRuleHandler
{
protected array<bool> RuleIsInclusive;
protected array<string> RuleText;
void SanityCheck()
{
//this should never happen
if (RuleIsInclusive.size() != RuleText.size())
{
PrintRules();
ThrowAbortException("Marker Rule List is corrupted");
//or just start over
RuleIsInclusive.clear();
RuleText.clear();
}
}
uint AddRuleToList(bool InclusiveRule, string MatchText)
{
SanityCheck();
RuleIsInclusive.push(InclusiveRule);
uint i = RuleText.push(MatchText);
return i;
}
//try to add a line as a rule. Line should be like "(include|exclude)=(match text)"
bool TryAddLineAsRule(string RuleLine)
{
if (!RuleLine || RuleLine ~== "" || RuleLine.left(2) ~== "//") return false;
int splitpoint = RuleLine.IndexOf("=");
if (splitpoint < 0) return false;
if (splitpoint >= RuleLine.length()-1) return false;
//console.printf("rule [split,len]=[%d,%d] %s",splitpoint,RuleLine.length(), RuleLine);//DEBUG
string RuleKey=RuleLine.left(splitpoint);
string RuleVal=RuleLine.mid(splitpoint+1,int.max);
if (RuleKey~=="include")
{
AddRuleToList(true, RuleVal);
return true;
}
if (RuleKey~=="exclude")
{
AddRuleToList(false, RuleVal);
return true;
}
return false;
}
//reads rules from specified lump and successive lumps
void ReadRulesFromLump(string LumpName)
{
int lump = -1, next = 0;
while ((lump = Wads.FindLump(LumpName, next, Wads.GLOBALNAMESPACE)) >= 0)
{
next = lump + 1;
string thisLumpName=Wads.GetLumpFullName(lump);
//Console.Printf("[MarkerRules]Reading lump: %s", thisLumpName);//DEBUG
let content = Wads.ReadLump(lump);
Array<string> lines;
content.Split(lines, "\n", TOK_SKIPEMPTY);
for (uint i = 0; i < lines.Size(); i++)
{
lines[i].StripRight("\r"); //trim CR leftovers from CRLF files
if (lines[i] ~== "" || lines[i].Left(2) ~== "//") continue;
if (!TryAddLineAsRule(lines[i]))
{
console.printf("[ERROR]Marker Rules: Bad line [%d] in %s: %s", i + 1, thisLumpName, lines[i]);
}
}
}
}
//check if given actor matches rules for include or exclude
bool CheckRules(actor a)
{
if (!a) return false;
SanityCheck();
bool ShouldInclude = false;
for (int i = 0; i < RuleText.size(); i++)
{
//ignore rules that don't matter
if (ShouldInclude && RuleIsInclusive[i]) continue;
if (!ShouldInclude && !RuleIsInclusive[i]) continue;
string thisRule=RuleText[i];
string thisTag=a.GetTag();
string thisClass=a.GetClassName();
bool MatchesRule = thisTag ~== thisRule || thisClass ~== thisRule || (a is thisRule);
if (MatchesRule) ShouldInclude = RuleIsInclusive[i];
}
return ShouldInclude;
}
uint PrintRules()
{
console.printf("Marker Rules "..RuleIsInclusive.size().."/"..RuleText.size());
//Arrays *should* be the same size, but just in case they're not
int iMax = max(RuleIsInclusive.size(),RuleText.size());
for (int i = 0; i < iMax; i++)
{
string RuleKey=(i < RuleIsInclusive.size()) ? (RuleIsInclusive[i] ? "include" : "exclude") : "[Undefined]";
string RuleVal=(i < RuleText.size()) ? RuleText[i] : "[Undefined]";
console.printf("["..i.."]"..RuleKey.."="..RuleVal);
}
return iMax;
}
}
class LootMarkerHandler : EventHandler
{
MarkerRuleHandler MarkerRules;
override void OnRegister()
{
console.printf("Initialize LootMarkers");
MarkerRules=new("MarkerRuleHandler");
MarkerRules.TryAddLineAsRule("include=inventory");
MarkerRules.ReadRulesFromLump("LOOTMARK");
MarkerRules.PrintRules();//DEBUG
}
override void WorldThingSpawned(WorldEvent e)
{
if (!e.thing) return;
//DEBUG
// string thisTag = e.thing.getTag();
// string thisClassName = e.thing.getClassName();
// string thisDisplayName = thisTag ~== thisClassName ? thisTag : thisClassName.." ["..thisTag.."]";
// console.printf((MarkerRules.CheckRules(e.thing) ? "+" : "-").."Spawned: "..thisDisplayName);
if (ShouldBeMarked(e.thing)) LootMarker.AttachOneTo(e.thing);
}
bool ShouldBeMarked(actor a)
{
if (!a) return false;
if (a is "MapMarker") return false; //hardcode this to prevent loops
return (MarkerRules.CheckRules(a));
}
}
class LootMarker : MapMarker
{
default
{
+DORMANT;
}
states
{
spawn:
UNKN A -1;
stop;
}
actor AttachedTo;
//MapMarker class has the activate/deactivate swapped, so I swap them back
override void Activate(actor activator){super.deactivate(activator);}
override void Deactivate(actor activator){super.activate(activator);}
override void Tick(void)
{
bool ShouldBeActive, ShouldBeMoved;
[ShouldBeActive, ShouldBeMoved] = ShouldBeActiveAndMoved();
if (bDormant)
{
if (!AttachedTo)
{
//got no reason to live
destroy();
}
else if (ShouldBeActive)
{
Activate(null);
}
}
else
{
if (!ShouldBeActive)
{
Deactivate(null);
}
}
if (ShouldBeActive && AttachedTo)
{
sprite = AttachedTo.sprite;
frame = AttachedTo.frame;
}
if (ShouldBeMoved)
{
SetOrigin(AttachedTo.pos, true);
}
Super.tick();
}
virtual bool, bool ShouldBeActiveAndMoved()
{
bool ShouldBeActive, ShouldBeMoved;
if (bDormant)
{
if (!AttachedTo)
{
// Nothing to see here
ShouldBeActive=false;
ShouldBeMoved=false;
}
else
{
// Maybe something to see here
ShouldBeActive=!AttachedTo.CheckIfSeen();
ShouldBeMoved=ShouldBeActive;
}
}
else
{
bool Moved = (!AttachedTo || pos != AttachedTo.pos);
if (!Moved)
{
// No change
ShouldBeActive=true;
ShouldBeMoved=false;
}
else
{
if (!AttachedTo || AttachedTo.CheckIfSeen())
{
// See a missing item
ShouldBeActive=CheckIfSeen();
ShouldBeMoved=false;
}
else
{
// See a moved item
ShouldBeActive=true;
ShouldBeMoved=true;
}
}
}
return ShouldBeActive, ShouldBeMoved;
}
static LootMarker AttachOneTo(actor attachee)
{
if (!attachee) return null;
let marker = LootMarker(spawn("LootMarker",attachee.pos));
marker.AttachedTo = attachee;
return marker;
}
}
Thanks to the example posted by TheRatCircus, all versions of LOOTMARK are loaded chronologically instead of just the latest one.
The language file part has been removed entirely, all rules are sourced in LOOTMARK lumps.
I'll update the first post when I've have more time to test this.
I wrote a system for the user to choose items to mark on the map, pretty slick if I do say so myself. In testing it works in the stock iwads but breaks several mods - One I've noticed so far are High Noon Drifter, Action Doom, and Hocus Pocus. Not sure why but I'll look into it.
New feature I'm working on: User-markable objects. Any pick-ups (inventory items) are already marked on the map by default, but what if the user wants some other item marked? For example some NPC to talk to?
Take for example a game like Strife. You find this NPC:
And he seems like h might be useful. You'd like to mark him on your map to remember where he is.
You press and hold the marker key (default M) and get the blue marker cursor:
You move your view so that the cursor is on the item you want to mark, and the blue cursor turns green and the item has a green box around it:
Now you let go of the marker key, and check your map. Sure enough, there he is:
But what if you decide he isn't really all that important and you don't want him on your map after all? No problem, hold the M key again, look at the item you want off the map, and the cursor will change to a red mark and the item will have a red frame around it:
Release the marker key and the marker is removed and he is no longer on your map.
Hmm... Not sure what you been doing with it since you made that version, because I downloaded it from the link, tried this in the latest GZDoom and it gives me this error trying to run this, even alone it gives me at least only these handful of errors:
MWR_LootMarkers.pk3:zscript/lootcursor.zs, line 1: Class LootCursorInv has unknown base class MWR_Cursor3dInv
MWR_LootMarkers.pk3:zscript/lootcursor.zs, line 84: Class MarkerCursor has unknown base class MWR_Cursor2d
MWR_LootMarkers.pk3:zscript/lootcursor.zs, line 1: LootCursorInv: Non-actor classes may not have defaults
MWR_LootMarkers.pk3:zscript/lootcursor.zs, line 8: Attempt to override non-existent virtual function DoWhileEnabled
MWR_LootMarkers.pk3:zscript/lootcursor.zs, line 30: Attempt to override non-existent virtual function DoBeforeDisable
MWR_LootMarkers.pk3:zscript/lootcursor.zs, line 84: MarkerCursor: States can only be defined for actors.
Execution could not continue.
6 errors, 0 warnings while compiling MWR_LootMarkers.pk3:zscript.zs
