Achievement Helper

Adds an in-game achievement system. Vanilla Steam achievements are included in a pack as a separate download. Mods can easily add custom achievements using an extensive condition system to control when an achievement is awarded.

Achievements are defined in the AchievementHelperAchievements.yaml file positioned in the root of your mod. See the one included with Achievement Helper for an example of the format. Some properties of achievements are:

• Mod - The mod the achievement comes from. Used to group achievements in the menu and make sure achievements can have the same name across different mods.

• Name - The name of the achievement to be used internally.

• Implies - A list of other achievements (identified by their mod and name) that will be granted when this achievement is acquired.

• Icon - The texture in the Gui Atlas that will be used as an icon for this achievement. Scaled to fit an 80x80 box. Can be animated.

• AnimationSpeed - The fps of an animated icon.

• SecretName - Whether the name should be hidden before this achievement is collected.

• SecretDescription - Whether the description should be hidden before this achievement is collected.

• SecretIcon - Whether the icon should be hidden before this achievement is collected.

• SecretAchievement - Whether the entire achievement should be hidden before being collected.

• Invisible - Whether the achievement should ever be displayed in any form (collection popup or achievements menu)

• Condition - An expression which, when evaluated as true, grants the achievement.

The Achievement Trigger and Achievement Controller can each be used to grant an achievement. The trigger grants the achievement when the player enters the trigger and the provided condition is true. The controller grants the achievement when the condition is true. Achievements are specified by their mod and name, as defined in the yaml. Note: only Lönn plugins are provided.

The condition system uses soukoku/ExpressionParser with several custom functions to get commonly needed values. See Condition Helper for more details.

Source Code