Creating a moveset
This is the easy but possibly a bit tedious part of the mod.
Once you have the mod installed, check the Enable debug checkbox in the mod's REFramework UI.
Moving around, you'll see numbers appear below it: these are the latest actions your character has done. These actions are separated into two numbers:
- A category, which will usually be 0 for unsheathed actions, 1 for sheathed non-attack actions and 2 for attacks.
- An index, which indicates the specific action within that category.
For example, 2: 6 on Long Sword corresponds to Fade Slash.
The file format in version 2.x has been updated to enable more complex features.
Files will generally follow this pattern, where everything in curly brackets ({}) being places where you'll want to add your own information:
name: {moveset name}
author: {your username}
weapon: {weapon in PascalCase, see below}
----
{description of what your moveset does for people using it}
====
{swap id or _ if unneeded}: {category} {index} => {category} {index} | {modifier}
{swap id or _ if unneeded}: {category} {index} => {category} {index}
So an example file would look something like this:
name: Big Bonk
author: HoloTheDrunk
weapon: Hammer
----
Turns Big Bang I into Big Bang Finisher.
====
_: 2 37 => 2 41
Pretty straightforward, right? You can do way more with this mod, but simple use cases are equally simple.
The name of your moveset. Make it a little unique, as it quickly becomes a pain to search the moveset list when they all have generic names!
You can put anything here, but ideally make that your username if you want to become an ultra-niche internet microcelebrity of microscopic scale. More seriously, having consistent author names will help later on when I make a small website to share movesets with other users.
Weapon names should be in PascalCase, which just means sticking all the words together and making the first letter of every word uppercase.
Just in case, this is the full list:
GreatSword
SwordAndShield
DualBlades
LongSword
Hammer
HuntingHorn
Lance
Gunlance
SwitchAxe
ChargeBlade
InsectGlaive
Bow
HeavyBowgun
LightBowgun
Notice SnS and the bowguns, which differ slightly from their common acronyms.
Optional section, starts with a line of dashes (like ----). If you don't want to write a description, make sure to omit that line of dashes.
This has no functional value and is only meant for the people using your moveset, as it will show up in the mod's UI when they have it selected and have the relevant weapon equipped (see screenshot at the top of the page).
This is the meat and potatoes of the mod. Each swap is composed of 4 distinct parts: the swap id, the action to replace, the replacement actions and the modifiers.
Modifiers get their own wiki page to keep things clean: Modifiers
Has to be a number and is used by some modifiers. Multiple swaps can have the same ID, as it's not meant to be a unique identifier.
You can also use an underscore (_) if you don't want to bother because you don't need to be able to refer to that swap somewhere else. Although irrelevant to you, internally this just means that the swap has an ID of -1.
The replaced and replacement action are both composed of an action category and index, and must be separated by a thick arrow (=>) for readability.