FoundryVTT-Battle-Transitions

KO | EN

gitlite — search

#javascript #llm #golang #go #machine-learning #rust #nodejs #cli #kubernetes #awesome-list #vue #mcp #openai #open-source

FoundryVTT-Battle-Transitions

(★ 9)

A module for Foundry-VTT to provide for JRPG-like scene transitions.

FoundryVTT-Battle-Transitions Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![GitHub License](https://img.shields.io/github/license/Unarekin/FoundryVTT-Battle-Transitions)](https://raw.githubusercontent.com/Unarekin/FoundryVTT-Battle-Transitions/refs/heads/master/LICENSE?token=GHSAT0AAAAAACYQQTQK6ODLNX6QMRS6G7GWZY22EZQ)
![GitHub package.json version](https://img.shields.io/github/package-json/v/Unarekin/FoundryVTT-Battle-Transitions)
![Supported Foundry Version](https://img.shields.io/endpoint?url=https%3A%2F%2Ffoundryshields.com%2Fversion%3Fstyle%3Dflat%26url%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2FUnarekin%2FFoundryVTT-Battle-Transitions%2Frefs%2Fheads%2Fmain%2Fmodule.json)
![Supported Game Systems](https://img.shields.io/endpoint?url=https%3A%2F%2Ffoundryshields.com%2Fsystem%3FnameType%3Dfull%26showVersion%3D1%26style%3Dflat%26url%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2FUnarekin%2FFoundryVTT-Battle-Transitions%2Frefs%2Fheads%2Fmain%2Fmodule.json)

![GitHub Downloads (specific asset, latest release)](https://img.shields.io/github/downloads/Unarekin/FoundryVTT-Battle-Transitions/latest/module.zip)
[![Forge Installs](https://img.shields.io/badge/dynamic/json?label=Forge%20Installs&query=package.installs&suffix=%25&url=https%3A%2F%2Fforge-vtt.com%2Fapi%2Fbazaar%2Fpackage%2Fbattle-transitions)](https://forge-vtt.com/bazaar#package=battle-transitions) 
![BattleTransitionsLogo](https://github.com/user-attachments/assets/089b3b1c-8fed-48ed-b388-0fa743808a7e)

- [Battle Transitions](#battle-transitions)
  - [Installation](#installation)
  - [Examples](#examples)
  - [How does this Work?](#how-does-this-work)
  - [What About \[Some Effect Here\]?](#what-about-some-effect-here)
  - [Known Issues / Compatibility With Other Modules](#known-issues--compatibility-with-other-modules)
- [Attributions \& Acknowledgements](#attributions--acknowledgements)
- [Support](#support)
- [Socials](#socials)
- [100% Human Made](#100-human-made)

![Transition Sample](https://github.com/user-attachments/assets/aa516048-74b0-4046-82df-8cbbbd98d9dd)

# Battle Transitions
Battle Transitions seeks to empower GMs with the ability to configure interesting, dynamic transitions from one scene to another, geared towards reproducing some of the effects that you might see when starting a random battle in your favorite JRPG-style games.

The current list of transition types is somewhat basic, but with the framework in place, this list ease easy to expand as time goes on and I plan to introduce ever more interesting options.

## Installation
You can install this module through the Foundry module installer by searching for "battle transitions", or copying and pasting the manifest URL in the text field at the bottom:
```
https://github.com/Unarekin/FoundryVTT-Battle-Transitions/releases/latest/download/module.json
```

## Examples
For a list of provided effects, please see the [examples wiki page](https://github.com/Unarekin/FoundryVTT-Battle-Transitions/wiki/Examples)

## How does this Work?
Short version: Smoke and Mirrors.

Longer version that actually explains anything:  When triggering a transition, either via command line / macro, the scene navigation context menu, or automatically on scene activation, Battle Transitions first renders a copy of the current scene and creates an overlay placed on top of Foundry's normal canvas.  The module then activates the next scene, and applies a series of PIXI filters on the overlay image to allow for effects that reveal the new scene in some interesting way.  These effects generally use GLSL shaders, which allows for a great deal of freedom when designing them.

## What About [Some Effect Here]?
I do have a short list of effects from some classic JRPG titles (mostly Final Fantasy, honestly) that I'm looking at incorporating, but am very open to implementing requests from the module's users.

If you'd like to request some particular effect, please [open a github issue](https://github.com/Unarekin/FoundryVTT-Battle-Transitions/issues/new) and describe the effect you would like to see.  If you're looking to reproduce an effect from an existing game, please provide a sample video of the effect in action to better illustrate just how it ought to look.

## Known Issues / Compatibility With Other Modules
- Compatibility with [Scene Transitions](https://foundryvtt.com/packages/scene-transitions/) - Currently, no specific measures are taken to ensure compatibility with Scene Transitions or any other modules that affect Foundry's behavior when changing scenes, but preliminary testing shows that the two modules can be used side-by-side if you take some care with how you configure the timing of your Battle Transition sequence.
- [Theatre Inserts](https://foundryvtt.com/packages/theatre) - Actor inserts are displayed over a Battle Transition, which is the most likely desired behavior.  This is unlikely to be changed in the future, as Theatre Inserts uses HTML elements for its dialogue boxes, and canvas effects cannot be displayed above HTML elements.

For a list of known bugs and feature requests, please see the project's [issues page](https://github.com/Unarekin/FoundryVTT-Battle-Transitions/issues)

# Attributions & Acknowledgements
- The [crossed swords icon](https://game-icons.net/1x1/lorc/crossed-swords.html) is from [Game-Icons.net](https://game-icons.net/), by [Lorc](https://lorcblog.blogspot.com/) and is released under the [CC-BY-3.0](http://creativecommons.org/licenses/by/3.0/) license
- The [character](https://opengameart.org/content/js-actors-aeon-warriors-field-battle-sprites) and [wolf](https://opengameart.org/content/js-monsters-aeon-monsters-i) sprites used in the logo animation are by [JosephSeraph](https://opengameart.org/users/josephseraph) on [OpenGameArt](https://opengameart.org/) and are both released under under the [CC-BY-3.0](http://creativecommons.org/licenses/by/3.0/) license
- The [Hazy Hills](https://opengameart.org/content/battle-background-hazy-hills-0) background used in the logo animation is by [ansimuz](https://opengameart.org/users/ansimuz) also from [OpenGameArt](https://opengameart.org/) and released under the [CC-BY-3.0](http://creativecommons.org/licenses/by/3.0/) license
- The cloud background used in the logo animation is from [Pixel Clouds Parallax](https://garzettdev.itch.io/pixel-clouds) by [garzetdev](https://garzettdev.itch.io/) on [itch.io](https://itch.io) and is released under no specific license, but free to use in commercial projects

# Support
Do please consider throwing me a few bucks over on [Ko-Fi](https://ko-fi.com/unarekin) or [Patreon](https://www.patreon.com/BattleTransitions) if you like what you see and are feeling generous.  Every little bit helps.

# Socials
- [Linktree](https://linktr.ee/EricasCodebin)
- [Discord](https://discord.gg/RaFYSW9Vcp)

# 100% Human-made
This module contains exactly 0% AI-generated content, whether that be code generation, code *completion*, documentation, art assets, etc.  None, never.  I don't need a torment nexus to write bad code, I can do that well enough on my own.

FoundryVTT-Battle-Transitions

FoundryVTT-Battle-Transitions Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

FoundryVTT-Battle-Transitions

FoundryVTT-Battle-Transitions Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README