RPG Map Effects 1.0.x

RPG map effects is a plug-in that allows game Masters and dungeon Masters to manage battle maps live. It will allow you to easily layer multiple effect templates onto a battle map . You can have multiples of the same template. Templates are stored as scenes in OBS. The tool allows you to move, rotate, resize, and manage these assets quickly and easily.

This plugin was created in C++/Qt using the built-in OBS API. Some parts were created using AI or an LLM. You should always use caution when running code that was generated using athese methods.


USAGE:

To use the plugin, you will need to create multiple scenes in OBS to store FX and Battlemaps.

Battlemaps will be any scene with the "Map:" prefix "Map: <map_name>". These maps will be available to choose from in the top left dropdown of the plugin.

An FX (effect) is any entity or effect that you want to be able to drop on the map. They will be scenes in OBS that begin with the "FX:" prefix "FX: <effect_name>"

Without at least one Map and one FX, the plugin will not do much.

Any scene that does not start with one of these prefixes will be ignored.


Here is a video explaining the plugin in detail.

Once you have these Maps and FX, you will be able to use the plugin to layer the FX on the battlemap. FX are stored per map to make switching between RPG scenarios easier.

Building an FX:

Start by adding and centering any media that you would like to be included with your entity. This can be multiple layers and include sounds. Be sure to set specifics for each FX layer, including looping, size, and blend mode. FX will use the "ADD" blend mode when added to the battlemap.

You can decide how an FX is spawned (in what order the layers appear) by using the following naming prefix format:

This will play the sound when spawning the FX, and 2000ms later show the image and in another 2000ms show the media. The prefix format is simply "[<number of milliseconds>]" before the name of the layer.


During use, you may notice that the plugin creates layers like "RPG Cursor" or RPG Grid" in your battlemap. This is a normal part of the plugin operation, and it will only do this for scenes with the Map: prefix.

Most functions are self-explanatory when using the batlemap and can be found in a right-click contextual menu. Available functions for FX are

• Move - select to move the FX after spawn (click to end move)
• Resize - select to change the size of the FX
• Rotate - Select to rotate the FX (click to end rotation)
• Clean - This will delete the FX
• Lock - This locks the FX, so it is not deleted when " Clear All " is clicked.
• Show Label - This will make the label visible. Labels can be changed in the FX List
• Show Cursor - Makes a cursor visible on the program output.