Dynamic Mod Menu

Not important.

For 2.3
For 2.4
For 2.5
For 2.6
For 2.7

2.8

What’s the reasoning behind this?
Reasoning is that I wanted a "dynamic" mod GUI but couldn’t find one.

The only way for modders to create their own mod options menus are:
1. Using edict screen
2. Creating a custom button by overwriting a .gui file
3. Using Mod Menu mod

The only rather "dynamic" approach is using the edict screen. Others either have mod conflicts or require additional steps to be performed by third party developers.

We already have a mod menu.
Yes, but it’s not "dynamic".

Is it truly a "dynamic" mod menu?
Nothing in this game can be truly "dynamic" but this mod menu gives an appearance of being "dynamic".

What the hell do you mean "dynamic"?
This mod menu exposes 100 "slots" for other mods to "inject" as a button into this mod.

Developers get to pick one unique Id (list will be kept somewhere which mods use which Id) and then:
1. Overwrite localization files related to this unique mod Id
2. Overwrite events related to this unique mod Id
3. Set a global flag related to this unique Id (comes via generated code)
4. Create own mod icon for the mod menu by overwriting a GFX resource related to this unique Id

Only 100 slots?
Don’t worry the code is auto generated (via script). If the limit is ever hit we can create more ids obviously.

What’s the advantage of this approach?
– Mod developers don’t have to message back and forth (Mod Menu maintainer and XYZ mod developer)
– Create compatibility patches for custom buttons
– Mods don’t clutter the edicts menu

Almost zero communication between myself and mod developers is necessary (only if you require support probably). I don’t need to do anything in order for your mod menu button to show here. Only thing mod developers need to do is let everyone know which mod Id they’ve taken.

What files are overwritten?
main_bottom.gui

Some other mod that I use already overwrites main_bottom.gui.
Let me know which so I can create a patch. Other developers are welcome to create patches themselves as well.

Menu icon is not showing.
It’s probably a mod conflict. See above.

Are there any existing compatibility patches?
Here

Mod icon is terrible.
I know and that’s not a question.

Can I create my own mod icon for this?
Yes of course. You can send it to me to include in the mod (credits will be given) or create your own mod override. Whatever suits you is fine by me.

I found a typo or grammar error.
Great. Let me know what the error is and where exactly and post a correction so I can update the localization file.

I don’t like this mod!
Don’t install it then.

Is this mod required to be installed?
If the mod developer who pointed you here implemented the overrides via provided python script then it should not be a dependency. You can use whatever alternate method is present to launch the mod UI that you installed.

Help, Mod Id conflicts with another mod.
Please ask the mod author to change the selected mod Id.

Achievements compatible? Ironman compatible?
I don’t care about Achievements or Ironman so assume all my mods are not compatible.

I want to make a menu for my mod.
Here’s a python script which can generate bare bones code for you: https://pastebin.com/ugZQEAPD
If you need an actual sample message me and I’ll use the following tool to generate one for you.

As a mod developer what can I customize?
Button look on the menu, text on the menu.

Once the menu button is clicked control is transferred to your own dmm event. You can do what you want with it (in the override). Relaunch your own menu, replace whole code.

I only recommend that you add somewhere

in your close options event code. In the sample it is added in after block.

How can I check if DMM is installed?