Simple Achievements Plugin Guide

simple_achievements_guide.md

Simple Achievements Plugin Guide

Author: Pheonix KageDesu
RPG Maker Versions: MZ, MV
URL: https://kdworkshop.net/plugins/simple-achievements

---

Overview

The Simple Achievements plugin allows you to create and manage achievements in your RPG Maker game.

Important Note: This plugin is represent visual representation of the achievements in your game. It does not track the achievements themselves. And not responsible for the actual logic of unlocking achievements. You will need to implement the logic for unlocking achievements in your game events or scripts. Also this plugin not connected to the Steam achievements system.

This plugin provides a user-friendly interface for players to view their achievements, including locked and unlocked states, descriptions, and images. It supports both RPG Maker MV and MZ versions.

Also plugin provides a two ways of storing achievements data:

• In the game save file: Achievements will be saved in the game save file
• Global storage: Achievements will be stored in the global storage, which means that achievements will not be saved in the game save file, but will be available across all game sessions. Like a settings or options.

How to Use

Installation and Setup

1. Installation: Download the plugin and place it in your RPG Maker project's js/plugins folder.
2. Activation: Open the Plugin Manager in RPG Maker and activate the Simple Achievements plugin.
3. Configuration: Customize the plugin parameters to suit your game's needs.

Creating Achievements

To create an achievement, you need to add it in the plugin's parameters.
Go to the Plugin Manager, find the Simple Achievements plugin, and look for the "Achievements" section. Here you can define your achievements.

Each achievement can have the following properties:

• ID: A unique identifier for the achievement. You can use any string, but it should be unique across all achievements. Used in the plugin commands or script calls for referencing the achievement.
• Name: The name of the achievement displayed to the player.
• Description: A brief description of what the player needs to do to earn the achievement.
• Unlocked Image: The image displayed when the achievement is unlocked.
• Locked Image: The image displayed when the achievement is locked.
• Hidden: If checked, the achievement will not be displayed in the list until it is unlocked.

Note: Example of a hidden achievement:

Unlocking Achievements

To unlock an achievement, you can use the following methods:

• Plugin Command (MV only): Use the plugin command UnlockAchievement followed by the achievement ID.

  Example:

  UnlockAchievement MyFirstAchievement
  

• Plugin Command (MZ): Use the plugin command Unlock Achievement (in Plugin Commands of PKD_SimpleAchievements plugin)

• Script Call (MV and MZ): Use the script call UnlockAchievement('AchievementID'); in your event scripts or JavaScript code.

Extra Plugin Commands

• All available plugin commands for RPG Maker MZ are listed in the Plugin Commands section for the PKD_SimpleAchievements plugin.

• RPG Maker MV plugin commands:

  • OpenAchievementsMenu - Opens the achievements menu.
  • ResetAchievements - Resets all achievements.

Extra Script Calls

• OpenAchievementsMenu(); - Opens the achievements menu.
• ResetAchievements(); - Resets all achievements.

---

Customization

• Plugin based on NUI system, which allows for easy customization of the achievements menu.

• You can customize the appearance of the achievements menu by modifying the .json files in the data\PKD_SimpleAchievements folder.

• All the images used in the achievements menu are stored in the img\PKD_SimpleAchievements folder. You can replace these images with your own to change the look of the achievements.

Extra styles

• The plugin comes with two ready-made styles. You can use these styles as a base for your own customizations or as-is for a quick setup.
• Check folder data\PKD_SimpleAchievements\Style1 and data\PKD_SimpleAchievements\Style2 for the styles.
• To use a style, simply copy the contents of the desired style folder into your project's data\PKD_SimpleAchievements folder, replacing any existing files.

---