Frequently Asked Questions

What is EEex and why is it important?

In short, EEex is a bit like what ToBEx is to the original games, an extender that allows temporary modifications of the game’s executable, allowing changes to hardcoded mechanics. Since its inception, several actions that were previously beyond the reach of modders have been made possible.

—Shin

What does EEex do?

Please see the Overview.

What do I need to do to install EEex?

Please see the Overview.

How do I report a bug?

Please see the Overview.

Would EEex allow for more than 6 characters in the party simultaneously?

No – EEex cannot expand the maximum party size, as the limit has been inlined a prohibitive amount of times across the engine.

Does EEex allow the execution of arbitrary executable programs on the user’s computer?

Not any more than a WeiDU mod, a batch file, or any other mod related program, or mod related setup/install tool you might download and run.

Would EEex allow for <x>?

Implementing or allowing for <x> is usually a matter of a specific mod being created to handle <x>. This means that EEex itself is normally not the place for <x> to be implemented; it is up to modders to implement <x> using EEex’s capabilities. Keep in mind that even with EEex, <x> might not be feasible, or might take considerable time and effort to implement.

EEex implements some small engine tweaks / conveniences in optional components. If you feel that <x> could be an EEex component, or that <x> otherwise requires new EEex functionality, feel free to make a suggestion on EEex’s GitHub Issues page or EEex’s thread on the Beamdog Forums.

I’m a modder, how do I use EEex?

EEex makes changes to many different parts of the engine. Accessing and making use of new opcodes, actions, triggers, and objects is as simple as installing EEex.

The real power of EEex, however, comes from its ability to change hardcoded engine behavior. The hooks that enable these alterations are completely defined and controlled by the Lua environment, and as such, modders wishing to use these systems will have to either:

  • Insert a M_*.lua file into the game’s override folder.

  • Edit UI.MENU directly.

How do I add to the EEex documentation?

Please follow the Contributing guide for details on how to add to, or edit, the EEex documentation.