Documentation
Readme
View as plain text
***********************************************************************************************
Date: 1, November 2023.
Mod name: Dedicated Grenade Keys Mod and other QOL (shortname: GrenadeKeysMod)
Nexus Mod Page: https://www.nexusmods.com/doometernal/mods/1255
Mod Tutorial video: https://youtu.be/ftI0vx3-5L0 (keep in mind new features have been added since.)
Author: Kaibz (https://steamcommunity.com/id/Kaibz)
Current Mod Version: 1.5
ChangeLog:
1.5 (1/11/23)
-Fixed a bug where the crosshair color change system, that indicates if frag or ice nade is ready, was showing wrong colors at the start of the campaign because it assumed the grenades items we already owned.
1.4 (28/10/23)
-Added an option for FOV minimal so now the FOV can be set between 70 and 150.
1.3 (28/10/23)
-Added an actual ice grenade icon next to the frag nade icon. The ice icon also has a numerical cooldown timer that is easy to see. It also works with color profiles. You can also customize the cooldown color of the icon.
-Added an option to override the frag icon color and its cooldown color, for example the cooldown color can be totally grey so that the color feedback only comes in when at least one frag is ready or it can be very flashy because that makes more sens for you.
-Added an option to have the Chainsaw icon change to a custom color when it is 3 pips full to make it easier to notice.
-Added an option to remove the color change of the ammo/weapon bar everytime player changes weapons so it makes the color feedback of the equipment more prominent and easier to notice.
-Added a user requested option to remove the zoom on the Balista arbalest.
-Added a user requested option to unlock maximum FOV to 150 in the game settings.
-Bug fixes.
1.2 (17/10/23)
-Added an Option to have the dot crosshair change color when the frag/ice/both nades are ready
-Bug fixes
1.1 (2/10/23)
-Added an Option to disable Hit Marker
-Added an Option to set the Color for the Desperate Punch (Thanks Crazyslugger)
-You can now use the Immersive crosshair setting with the dot crosshair
-Added an Option to have the Immersive crosshair for the Balista Arbaleste (Thanks to Crazyslugger for suggestion and testing)
-Made the Auto reload of the ini file a default setting.
-Fixed a crash related to another mod (HUD_Low_Health_De-Crapifier_No_Red) and made the mode compatible with it
1.0 (26/9/23)
-Reworked the grenade key system so the the objective key can be used for objectives/challenges again
-Added an Option to change the arrow on the right of the grenade icon depending on the ice nade ready status
-Added a crosshair scale Option.
-Added a dot crosshair color Option.
-Added a dot crosshair cooldown color Option.
-Added a "HAR ADS only" crosshair option
-Added an option to remove the Dash blur effect.
-Added different color customizations for BloodPunch ready statuses
-Added Radiation Suit meter color customization.
-Added an Option to remove the button binds reminder on the Hud
-Added an Option to automatically reload the .ini file.
-Added a debug level feature for the GrenadeKeysModLog.txt file output
-Fixed many bugs and rewrote big chucks of the mod code to make it more resiliant
-skipped a few mod versions numbers to reflect the changes.
0.6: (7/3/23)
-Added a setting to customize weapon FOV.
-Made the grenade keys system more robust.
-Made the mod compatible with Modpack Collection mod (thanks to redcatisthenewblack for bug report)
-Made the mod loading beep setting to no beep by default, but you can still change it in the ini file.
-Adjusted some translations for Frag and Ice grenade in some languages. (thanks Ёсиков)
-Fixed bugs.
0.51: (14/2/23)
-fixed an issue where the log file could have its name set to GrenadeKeysModLogTEST.txt.
-fixed typos in install.txt.
0.5: (14/2/23)
-Reverted back the dll to XINPUT1_3.dll, as once again, some users could not load the mod with XInput9_1_0.dll. Because this is such a hassle, i will not use any other dll from now on and XINPUT1_3.dll will be the default mod loader, and unfortunately it means the mod will not be compatible with MeatHook mod.
-Added a feature that will automatically delete a previous version of the mod (XInput9_1_0.dll or DINPUT8.dll) if it is found in the game folder.
0.4: (14/2/23)
-Made the mod compatible with "Meathook mod" by changing this mod dll from XINPUT1_3.dll to XInput9_1_0.dll
-Removed Debug version as the default version should have extra info in the log file.
-added a more robust system to display "Frag Grenade" and "Ice Grenade" in bind menus for other languages, including localization.
-added a system to detect if a previous version of the mod is still installed so the user can be warned that he should remove it.
-added an option in the ini file to disable the 2 beeps when the mod loads.
-made the beep when the weapons bug fixes triggers to off by default.
0.3: (6/2/23)
-Fixed a typo error in log file and install.txt about dll mod file name.
0.2: (6/2/23)
-switched proxy to use XINPUT1_3.dll instead of DINPUT8.dll. This should solve the issue of some users not being able to load the mod.
0.1 (5/2/23)
-Initial release.
Mod Features Explained:
-Dedicated Grenade Buttons:
The mod adds 2 dedicated keys/buttons for Ice grenade and Frag grenade that you can assign in the bind menu of the game. Works for mouse/keyboard and controllers. The grenade keys system works like this: the use equipment key become the throw frag name key and the switch equipment key becomes the throw ice nade key, so if you used previous version of this mod you’ll have to rebind those keys in the game menu. This is good because now the Objective Marker/Show Challenges key will work as it’s supposed to and pressing any dedicated nade key will not bring up the objective marker. This system works for keyboard but also for controllers, even in the controller custom profile.
-The grenade Icon system works like this: The grenade icon will always shows the frag nade status, and the Arrow (on the right side of the grenade icon) will now always indicate if the ice grenade is ready or not. You can customize its color for ready and cooldown status, and to make it flashy enough to give you good visual feedback, you can even set the icon to be invisible if the ice grenade is not ready. The next mod update will "hopefully" add an actual countdown timer for the ice nade as well if possible...
-Dedicated ice grenade icon with a cooldown timer, so now both grenades status can be seen at the same time (that required much more work that you might think...)
-Customizable ADS sensitivity:
For the precision bolt and the Balista Arbalest you can adjust the sensitivity (when zoomed). You also have an option to disable the zoom effect and lowered sensitivity of the shotgun for the sticky grenades and full auto. This works for mouse and also for controllers.
-Option to change the size of the crosshair (dot and normal) to make it smaller or bigger.
-Option to change the color of the dot crosshair and another option to make it change color when shotgun sticky or the meathook is recharging, give it a try it's a nice little feedback. You can set any color you want for both.
-Option for "immersive Crosshair", this is for people who like to play with no hud and/or with no crosshair, but who believe that the crosshair should show up in the ADS view of the assault rifle. Update 1.1: you can now also have this for the Balista Arbaleste view and have it work with the dot crosshair.
-Option to make the bloodpunch icon change color depending on the number of bloodpunch available, to give more visual feedback. This also works with the desperate punch from the dlc. You can customize the colors to almost anything you want. These colors can be changed in the ini file.
-Option to change the weapon FOV and make it very low, so you don't even see the weapon or very high, to see more of the weapon.
-Option to unlock maximum FOV from the game settings.
-Option to change the default color of the radiation suit meter icon, color can be changed in the ini file (some users thought the default game color was too similar to the green armor color meter
-Option to remove the "key binds reminders" above the grenade icons and bloodpunch icons, which makes the hud much cleaner, give it a try, you won't go back.
-Option to remove the hit marker, which is the x like crosshair that pops up when you hit something. Some users don't like it and the last mod that removed it doesn't work with last version of the game so i worked on a way to had it in the mod.
-Option to remove the Dash blur effect (the white flash on the borders of the screen). If you ever had eye strain or nausea for playing the game for long periods you should give this a try, and even if you didn't.
-Improved weapon switching:
An experimental feature mainly for mouse and keyboard users, it attempt to fix a behavious when the last weapon key you press will not bring up the weapon key you pressed, this happens rarely but can be frustrating, this features, try to fix it, but is still a wip.
-Option to have the ini file reload the mod settings automatically everytime you save the file. (Basically it means you don’t have to press F8 everytime you change a setting in the inifile and alt tab back into the game)
-Added a log debug level feature so it makes troubleshooting easier.
-Unlocked Console
-Easy install:
Download the mod => extract it to Doom Eternal Folder => Boom, you're ready to slay.
How to install:
1. Quit the game if it's running. Open the rar archive, put XINPUT1_3.dll into the game folder which on your computer should be something like this: ...Steam\steamapps\common\DOOMEternal And that's basically all you have to do you can just launch the game and start using the mod features !
2. Upon launching the game, if something went wrong you may hear an error message.
3. Once you have launched the game, the mod will generate a file called GrenadeKeysModLog.txt which will lop potential issue and will help with debugging. You could also paste the content of this file if you want to file a bug report in the bug report section of the mod's nexus page.
4. The mod will also generate a GrenadeKeysMod.ini file in the same folder, and this is the file that will let you modify the mod's options like colors, features...Read the "How to customize the mod settings" section below for more info.
How to Uninstall:
Simply quit the game, and delete XINPUT1_3.dll (which is in the same folder as DOOMEternalx64vk.exe). That's it.
How to customize the mod settings:
The game will generate a GrenadeKeysMod.ini file (in the same folder as the game) the first time launches. you can then modifies the values to change the sensitivities of zoomed weapons for mouse or controller and enabled/disable the mod's other features.
For example if you want to change the Mouse sensitivity of the bolt rifle, Open GrenadeKeysMod.ini with notepad or notepad++ and change the line from PrecisionBolt_ADS_Mouse_Sens = 50 ;
To:
PrecisionBolt_ADS_Mouse_Sens = 80 ;
SAVE the GrenadeKeysMod.ini file, go back in the game, PRESS THE F8 KEY to reload the mod (you can change the key to something else if you really need to), and you should hear "ini file reloaded" which will confirm changes have been made in the game. You can check the mod's video tutorial to see how i do it. You can also set the ini file to reload automatically when you save it, but if you have any issue with that feature, keep it disabled.
Compatibility:
At the moment, this mod is NOT compatible with mods that use XINPUT1_3.dll (like Meathook mod). Other mods "should" work but if you encounter an issue please report about it or file a bug repport or a least let me know which mod is conflicting with this one.
Requirements:
This mod doesn't require any other mod to work.
The mod should work is you use other mods but, because of the astronomical amount of mods for this game, it is not guaranteed.
It has been tested with mouse and keyboard and should also work fine with an xbox controller.
It requires the latest Steam version of Doom Eternal (as of 26, September 2023.). Other "versions" are NOT supported.
It's been designed for the single player portion of the game, it's NOT recommended to play battlemode with this mod.
Questions:
Q: the mod doesn't launch what do i do?
A: If you heard a voice mentioning an error, check the mod's log file in the game folder (GrenadeKeysModLog.txt). Set the Debug_Level in the ini file to 2 or 3 and if you can't figure it out by yourself, let me know on the nexus discussion page what your issue is.
Q: I disabled the dash blur effect and now i can not set it back on:
A: Go back to the .ini file, reenable the dash effect, save, and relaunch the game.
Q: i don't see the crosshair anymore:
A: check the ini file for Crosshair_Scale value, you may have set it too low or you may have enabled the Immersive_Crosshair mode
Q: I have messed up the .ini file what do i do?
A: Just quit the game and delete the .ini file, a new one will be generated the next time you launch the game.
Q: The Ice Grenade button doesn't work, what do i do?
A: Are you 100% sure you have bound the key for it(?). If the answer is yes send a message in the discussion forum, i might also need you to paste the content of your GrenadeKeysModLog.txt in a bug report on the nexus mod page bug report section.
Q: The improved weapons switch does triggers when it should not at the start of the campaign when i only have 2 weapons or i don't have the faster weapon switch perk.
A: It's ok, the improved weapon switch timings are designed for a Slayer who has already acquired the Faster weapon switch perk, but it will not change anything to your experience at the start of the game so you can just leave it on.
Q: Donations?
A: No thank you, but if you have a game on Steam you want to gift, that would certainly be appreciated, my profile is: https://steamcommunity.com/id/Kaibz/
Credits:
-Crazyslugger for testing and feedback
-Zwip-Zwap Zapony for all that he has done for the DE modding community
-SamPT for his help, testing and advices.
-Chrispy for his amazing Meathook mod.
-MethanHydrat for the inspiration and advices.
-The Doom Eternal modders community.
-Everyone who has reported a bugs/issue (so i could fix it.)
***********************************************************************************************