RPGCore

What is RPGCore?

RPGCore is a specialized API that provides developers with a ready-made skill implementation system for Minecraft. The main purpose of the mod is to simplify the creation of new abilities that can be integrated into existing modifications to add progression elements or develop completely new projects with RPG mechanics.

How the System Works

The RPGCore concept is inspired by the skill system from the Sword Art Online anime. Players access the skill interface through the F4 key (configurable in controls), where they can equip skills, customize the layout of screen elements, and manage groups (guilds, factions, squads).

The maximum number of simultaneously active skills is 12, but when fully equipped with armor, only 8 slots are available. Some slots are locked until a certain Global Level is reached. Experience is only awarded for equipped abilities.

Skill equip screen — opened with F4

Global Level System

Global Level reflects the player's overall progress and is visible to other participants. For every 10 experience points in any skill, you get 1 XP towards your Global Level. Some abilities require reaching a specific GL to unlock. Global Level does not occupy slots and is always active.

Skill Leveling

To gain experience, a skill must be equipped. Leveling mechanics are determined by the developers of specific abilities. The base version of the mod only includes examples, but the Flenix's Skills addon already implements the Aerobatics skill, which levels up when falling from a height of more than 3 blocks without taking damage.

Special cases: Strength and Agility are non-XP skills. Their level increases through skill points, which are awarded 3 per each Global Level. Point allocation is done through the "Player Settings" button in the main skills menu.

Skill selection screen. Click on a slot to assign an ability Note: the "Player Config" button here doesn't work yet — use the corresponding option in the main menu

For Developers

The API greatly simplifies the creation of new skills. The ExampleSkills mod demonstrates the process of implementing two abilities with detailed documentation.

To get started, download the deobfuscated version of the mod, place it in the /libs folder of your development project, and add it to the build path as an external .jar file. It's also recommended to use the javadocs for development convenience.

Main steps: extend SkillLevelBase, implement IExtendedEntityProperties and add the necessary methods according to the examples. The API may change to maintain compatibility with MCSAO, so specifying specific version ranges is recommended.

For integration with existing mods, use soft dependency via Loader.isModLoaded, which will make the skill system optional for users.

Important Features

• Experience data is saved in player NBT (player.dat file). Deleting this file will result in loss of all progress
• The command /rpgcore addxp skillId amount allows adding/removing XP
• All XP bars are fully customizable: position, size, text, icon display
• To fully display the skill interface, a screen resolution of at least 256x450 pixels is required
• The player inventory in the current version has limited functionality — fixes are planned in future updates

Report any found bugs to improve the mod!