robojumper/modachievementsystem

In XCOM 2, only the game has achievements. How unfair. Let's change that.

Mod Achievement System

A system for mods to register and unlock achievements. Takes care of all the UI work for mods.

Features

• Optional Dependency - It's not required for your users, everything will work normally if they don't install the Achievement System
• Lightweight API - Only one class to tell my mod what achievement to unlock. Everything else is handled by my mod.
• In-game popups - some small popups, but nothing that hinders gameplay
• Default Icons - Can't design icons? No worries, we prepared something.
• Support for points, categories and completion rates - The maximum amount of gimmicks you can get. Also, hidden achievements.

Documentation here

Demo Images

In game popup

List of all achievements

Credits

Huge thanks to Grimy and RealityMachina, for they were the first to implement achievements and give valuable feedback!

modachievementsystem's Issues

Support for counting achievements.

An API transition to LW_Tuple would be beneficial, as it doesn't require recompiling the package for all mod authors.

Better Notification

Right now, the achievement unlocked panels blocks the whole screen and requires manual disposal. Would be better if there was a more subtle way...

Delay for certain achievements?

Add a configurable delay so that actions are not being spoiled?

find a good way to access Achievement List

Currently, this is done via a ScreenListener on UIPauseMenu, and is not very stable as other mods tend to do the same but clear all the buttons that already might be there.

There is a console command, but that shouldn't become the main way of viewing Achievements

Collapse / expand Achievements?

To not have a total mess once some more mods support the system.

Documentation & Guidelines

• There Should be a guideline for how many points to give
• There should be basic documentation on how to add an achievement and properly trigger it.

Better default Icons

We need better default Icons for modders to use. The small preview image should be 64x64, the wide card image should be 512x256. Both in enabled and disabled variants. Possibly just add a fallback to default images if none are specified.

Sound

Some unlock sound I'd say