[WOTC] UFOpedia & Bestiary

An update and improvement to the XCOM Archives, found in the Commanders Quarters.
It aims to bring some life, style and colour to one of the most dry sections of the game.

It is a mod of passion with the occasional core piece of lore, written, illustrated, coded and created by members of the XCOM2 Modders community.

Please enjoy the works presented.

The 2D UFOpedia Archives will unlock and complete as you progress through the campaign. Keep checking back for new entries. This will also expand as future updates bring more completed entries and artwork into the mod.

The 3D Bestiary will slowly fill up as you kill enemy units. You can also use BattleScanners and Gremlins/Bits to scan enemy units for the Bestiary. If you have a new unit to view the Commanders Quarters will have a highlight border and the new entry in the list will have an amber exclamation!

No further work is required in mods with "old" X2EncyclopediaTemplate.ini entries.
This mod will still work with those.
BUT if you want to specifically support the UFOPedia in your mod, please see the TemplatesandInstructions.txt for information (or look at the examples in this mod)

YES! .. Everything about the UFOPedia is config entries, except for the UI framework that this mod provides. A lot of the settings for the pages and bestiary can be adjusted.

The scanning perk can be completely adjusted for costs, charges and cool-downs. It can also be given to other items too (such as the Holotargeter from LW2 Secondaries, which is in the default configs)

Please see the configs and TemplatesandInstructions.txt‘s for guidance on creating your own entries.

Sometimes the very first entry/move/access/view into the Bestiary (after the intro movie) may lock the UI. In this case either push the ESC key twice or the number1 key and it should unfreeze. Further access to the Bestiary should not have this issue.

If using Yet Another F1 – Autopsy Required , the stats and abilities displayed in the Bestiary will also be obfuscated until the autopsy is done. This behaviour can be turned off in the configs.

Should work in all modes of play. Covert Infiltration, RPGO etc
Bestiary should work with *most* modded enemies.

No known compatibility issues. 🙁 There’s always one 🙁
Does not work with WC_Labyrinth both mods MCO the Archives. No this can not be easily fixed..

Has an MCO for UIAvengerShortcuts.uc, this is optional and can be turned off with no major drawbacks. This MCO controls what base game buttons are shown on the Avenger HUD menus.

The MOCX mod required some very specific handling for MOCX units, so we have released an additional plugin to handle this; see here for MOCX Bridge Plugin Addon
This plugin also serves as an example for adding ‘other’ new barracks into the Bestiary rotation and display.

Has built-in compatibility with MEMEBots these units will show up as ‘fake’ crew so you can view them. You can disable this is the MEMEBots configs.

LWOTC Issues;
Should work fine with LWotC v1.03 onwards

• There may be some issues with Bestiary units becoming floating heads.
  There is currently nothing we can do about this issue.
• There are some issues with the Bestiary only showing the units that were present in your last mission. This issue has a temporary workaround until LWotC can be updated.
• If you do this you should consider adding the standalone Tactical State Cleaner mod in its place (which does not suffer the issue the outdated LWotC integrated version does) …

This mod has plans to expand with more entries in the future. We have been working on it at a reasonable pace and we will continue to add entries and update.

Many thanks to Kexx for envisioning this project, creating the artwork, and Head Writer.
Many thanks to RustyDios for designing the entire UI, and Bestiary.
Many thanks to Xymanek and Iridar for guidance and examples of UI code.

Many thanks to the writer team: renegade_ginger, CerebralCloud92, novaseer, and GameBreaker for additional writing of entries.
Please also see the Tactical Unit Descriptions by Aquilio

Many thanks to the countless people that done beta tests for this mod.
Many thanks to Krakenhous for helping test the temporary fix to the LWotC Issue of the Bestiary missing units after each mission.

Many thanks to the MEME and XCOM2 discord communities.

~ Enjoy !! and please buy me, RustyDios, a Cuppa Tea [www.buymeacoffee.com]
~ Enjoy !! and please buy Kexx some pizza too [www.buymeacoffee.com]