Scene Transitions
If you want to buy me a coffee
Allows GM to make simple transitions to show players before navigating to new screen. Can be used for narrative effect. Can now be used with macros to create transitionless Transitions. And journal entries can now be used to generate a Transition.
Installation
It's always easiest to install modules from the in game add-on browser.
To install this module manually:
- Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules"
- Click "Install Module"
- In the "Manifest URL" field, paste the following url:
https://raw.githubusercontent.com/p4535992/foundryvtt-scene-transitions/master/src/module.json
- Click 'Install' and wait for installation to complete
- Don't forget to enable the module in game using the "Manage Module" button
libwrapper
This module uses the libwrapper library like a dependency. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.
socketLib
This module uses the socketLib library like a dependency. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.
Feature
Use the context menu on the navigator or directory to 'Create Transition'
Add background image, text, and configure to your liking and save. When you want to play it, bring up context menu and press 'Play Transition'
Transition will play and begin preloading scene. Scene will activate underneath transition.
Use the textbox sourcecode editor to add custom html and override default css.
Api
game.modules.get('scene-transitions').api.macro({
sceneID: false, // To play a transition without a scene activation, simple pass `false` as the sceneID in the data object or use the string id of the scene.
content:"TEST MACRO",
fontColor:'#ffffff',
fontSize:'28px',
bgImg:'', // pass any relative or absolute image or video url here.
bgPos:'center center',
bgLoop: true, // Only for VIDEO, if true will loop the video
bgMuted: true, // Only for VIDEO, if true will play the video muted
bgSize:'cover',
bgColor:'#333333',
bgOpacity:0.7,
fadeIn: 400, //how long to fade in
delay:5000, //how long for transition to stay up
fadeOut: 400, //how long to fade out
audio: "", //path to audio file, NOTE: is not advisable to use this with a video and the property 'bgMuted = false'
skippable:true, //Allows players to skip transition with a click before delay runs out.
audioLoop: true, //Loop the audio file ?
gmHide: true, // hide the transition on other windows logged in as a GM
gmEndAll: true, // when the GM clicks to end the transition - end for everyone
showUI: false, // Show the User Interface elements to all players allowing them to interact with character sheets etc
activateScene: false, // Activate the scene when play the transation ?
fromSocket: false, // This is usually a application variable for manage socket calls YOU DIDN'T NEED TO TOUCH THIS, MUST BE ALWAYS FALSE.
users: [], // show the transaction to this list of users ids, NOTE: if 'showMe' is true the current user id is add to the list
}, true ); // show to the triggering user (the one who click to the macro usually the GM)
To play a transition without a scene activation, simple pass false
as the sceneID in the data object.