Rinual's Practice Arena - Addon System
This system is designed for modders learning or experienced with scripting to quickly test their changes.
If you're only testing outfits or modifying files like weapon or character stats, this addon system is unnecessary and can just use the basic Practice Arena.
How it works:
- When booting Rinual's Practice Arena, the player gets prompted to initiate a fight with a practice cactaur. If the player selects no, a script is loaded into the game, by default this script is empty and unused by the game.
- By changing the contents of this script, users can have modify what loads and have unlimited ability to test new functionalities and behaviors.
There are two simple example addons provided.
- Music, Ramuh's Staff, and Ramuh VFX load in and trigger, allowing for quick VFX and music testing.
- Teleports the party to a looking platform that spawns in for them above the arena, this is useful for environment testing.
An example XML is also provided already setup that you can edit easily, with comments, and provides an easier base than the vanilla temporary.xml file.
- The Practice Arena will attempt to load
data://common/temporary.ebex by default when the player opts not to battle the Cactaur. We will be using that ourselves to build over.
- To trigger the package/script, you'll likely need to use an area package script, as shown at the top of the file (e.g.,
type="Black.Entity.Area.AreaPackage").
- The default
temporary.xml is set to type="SQEX.Ebony.Framework.Entity.EntityPackage," so you'll need to adjust it similarly to the provided file example, though any comparable script will work.
- The test room's coordinates are
[0,0,0,0], making it easy to place entities around the room.
This system speeds up testing music changes and lets you fully modify the triggered script to suit your needs, providing quick testing options for most mod creations that don't require visiting a specific location.
If you need help with understanding scripts, we have a guide here
Mod Menu Notes:
- To use with Rinual's Mod Menu - Remove the line from the mod: "
data://level/debugsystem/mission/ch03/qt_ch03_0021_debug_main.ebex" or see optional files in the Practice Arena Listing.
- An update to mod menu will fix this more correctly in the future, or already has if that file doesnt exist in your version of the mod. Failing to do this will cause the world to not load correctly and you will fall forever
Linked File Notes
An example file is included that spawns Ramuh's staff and triggers a lightning storm VFX:
data://effects/Combat/summon/ramuh/vlink/ramuh_wand_lightning.vlink
data://character/ws/ws99/entry/ws99_000.ebex
These paths can be easily changed to other entities and VFX, but you'll need to add references to any new files.
The file also changes BGM tracks after selecting "No" to fighting the Cactaur:
data://sound/resources/20001music2/jp/bgm_cp02_06rmu_30.max
This will require a reference and the ability to reference loose files. More information is available here:
The other song that plays is in the main mod itself but can be manually replaced for testing a second song:
data://sound/resources/20000music/jp/bgm_car_ff8or_09.sax
To load the world without the arena and just see the environment, remove "data://environment/insomnia/props/in_in_king02/models/in_in_king02_typa.gmdl" or use the provided example.
Manually install by double clicking the .fmod
https://ko-fi.com/rinual -- Support me on Ko-fi or message me on Discord for commissions.
https://discord.gg/7cNNwwJKsJ --- FFXV Exineris Modding Discord
https://github.com/Kizari/Flagrum/releases *Version 1.5.14+ required
https://github.com/Kizari/Flagrum/wiki/Using-the-Mod-Manager Guide for new users
