Guides

How to install

This is the recommended way to install either the free or the Patreon JB2A module.

Free module

The free module could be considered a demo of our module on patreon. We’re working hard to ensure that the module has all the animated assets we’ve made, minus their colour variations and a few exceptions to comply with licensing requirements.

It’s a good place to start, if you want to discover the whole FoundryVTT effects environment before committing yourself to our Patreon module. Simple to install, and can be updated directly on FoundryVTT.

The installation process may differ depending on your hosting method. Select the corresponding tab below.

Self-Hosting

1. Go to the FoundryVTT landing page and click on the “Add-On Modules” tab.

   

2. Click on the “Install Module”

   

3. Search for JB2A and click “Install” and the installation process will occur.

   

4. Once installed, you need to enable our module in your world. Start your world and click on “Manage Modules” in the Settings tab.

   

5. Finally find our module and enable it. That’s it, our free module is ready for you to use.

   

Foundry Server

Our free module is 1.2GB in size. (as of october 2024) As long as you have enough space from the tier you’ve subscribed to on Foundry Server, you can find and install our free module from the list from within FoundryVTT

1. Go to the FoundryVTT landing page and click on the “Add-On Modules” tab.

   

2. Click on the “Install Module”

   

3. Search for JB2A and click “Install” and the installation process will occur.

   

4. Once installed, you need to enable our module in your world. Start your world and click on “Manage Modules” in the Settings tab.

   

5. Finally find our module and enable it. That’s it, our free module is ready for you to use.

   

The Forge

1. We’ll assume you already know the basics about The Forge. If not read their documentation

2. To install the module, go to “The Bazaar” tab and click on “Modules”.

   

3. Search for jb2a in the search bar and select “JB2A - Jules&Ben’s Animated Assets”

   

4. Then install the module.

   

5. Once installed, you need to enable our module in your world. Start your world and click on “Manage Modules” in the Settings tab.

   

6. Finally find our module and enable it. That’s it, our free module is ready for you to use.

   

Molten Hosting

Our free module is 1.2GB in size. (as of october 2024) As long as you have enough space from the tier you’ve subscribed to on Molten Hosting, you can find and install our free module from the list from within FoundryVTT

1. Go to the FoundryVTT landing page and click on the “Add-On Modules” tab.

   

2. Click on the “Install Module”

   

3. Search for JB2A and click “Install” and the installation process will occur.

   

4. Once installed, you need to enable our module in your world. Start your world and click on “Manage Modules” in the Settings tab.

   

5. Finally find our module and enable it. That’s it, our free module is ready for you to use.

   

Patreon module

Our Patreon module has all the assets we’ve produced since the early days of JB2A, with a few exceptions to comply with licensing requirements. Currently, the zip file size is around 6.5GB (as of october 2024).

The installation process may differ depending on your hosting method. Select the corresponding tab below.

Self-Hosting

1. You must have an account and subscribe to any tier on our Patreon. They all have access to the same module. To find out more about how our Patreon works, click here.

   

2. Find the Master Post, it’s a pinned post in the “Home” section. It will always be at the top of the list of recent posts.

   

3. Consult the Master Post section called “Download Links”.

4. Under “Manifest Link”, right-click on the link and “Copy Link Address”.

   

5. Go to the FoundryVTT landing page.

   

6. Click on the “Install Module”.

   

7. Paste the manifest link inside the field named “Manifest URL”. Click “Install” and the installation process will occur.

   

8. Once installed, you need to enable our module in your world. Start your world and click on “Manage Modules” in the Settings tab.

   

9. Finally find our module and enable it. That’s it, our Patreon module is ready for you to use.

   

Foundry Server

Credits and thanks to WWQuicksilver (Rob) on Discord for this guide! This post is to assist anyone using the Foundry Server hosting site and Digital Ocean (or similar S3 bucket service for asset storage). It assumes you’re NOT using the manifest option because you don’t want to eat up ~6GB directly on Foundry Server, and are instead uploading the entire package to your S3 bucket.

Note

Using the manifest would actually temporarily require twice the size of our module since FoundryVTT downloads the zip, and only deletes it once the installation process is completed.

1. Create a folder on the root (easiest option) of your S3 bucket called jb2a_patreon (case sensitive).

2. From wherever you’ve unzipped the contents of the complete JB2A package, go into the jb2a_patreon folder and copy the entire Library folder over to your jb2a_patreon folder on your S3 bucket. Because the Library folder and its subfolders are large in size and the number of files, you quite likely will need to upload it in smaller chunks…while maintaining the directory structure AND making sure to mark the files as public during the process. Attention to detail here will save you time and frustration later. 😉

3. Check that you can access/view some of the webm files via the tile browser

4. Install just the free version of JB2A on your Foundry Server instance of FoundryVTT and then shut the FVTT instance down so you can safely update some files (Hit the red Game Control button on Foundry Server).

5. Using your SFTP tool of choice (e.g. FileZilla), find the /Data/modules/JB2A_DnD5e folder and rename it to jb2a_patreon. Then replace the contents of every subfolder (except Library) with the files from your JB2A package.

6. Restart FVTT, launch your world, and enable JB2A.

7. In Configure Settings select JB2A and in the JB2A - location field enter the full path of your S3 bucket, including https://, as in this example (no slash at the end):

   https://mygame123.sfo3.digitaloceanspaces.com

8. If you’re using Automated Animations, in its settings for the JB2A Asset Location field enter the same thing, plus this at the end /jb2a_patreon. example:

   https://mygame123.sfo3.digitaloceanspaces.com/jb2a_patreon

   

The Forge

1. We’ll assume you already know the basics about The Forge. If not, read their documentation.

   Important

   On The Forge, don’t use the manifest link to install our Patreon module or it will count against your data quota ! Follow these steps to avoid that.

2. You must have an account and subscribe to any tier on our Patreon. They all have access to the same module. To find out more about how our Patreon works, click here.

   

3. In the My Account section of The Forge, link your Patreon account in the “Linked Account” tab.

   

4. The Forge will ask you to allow them to look for your personal info. Click on the “Allow” button.

   

5. Then, still on The Forge, in the My Account section, go to the “Patreon” tab and click on the “Refresh Pledges” button on the right of your screen.

   

6. To install the module, go to “The Bazaar” tab and click on “Modules”.

   

7. Search for jb2a in the search bar and select “JB2A - Patreon Complete Collection”.

   

8. Then install the module.

   

9. Once installed, you need to enable our module in your world. Start your world and click on “Manage Modules” in the Settings tab.

   

10. Finally find our module and enable it. That’s it, our free module is ready for you to use.

    

Molten Hosting

Credits and thanks to Tyreal2012 on Discord for this guide!

Depending on what tier/plan you opt for in Molten Hosting (MH), you may not have enough space to host all the files, the module being 6GB+ in size! On top of this, if you use the manifest link like in the Self-Hosting section, you will need twice that temporarily as FoundryVTT downloads the zip and installs the module and only once the install goes through does it delete the zip. This means the “Basic Plan” will not be enough, you’ll need at least the “Pro Plan” or “Elite Plan”, or you could alternatively use Digital Ocean or an AWS bucket to host only the Library folder. See the steps for Foundry Server to see how that’s done.

1. Download the “Complete Collection” zip from the Master Post on the JB2A Patreon.

   

2. Extract it on your local hard drive.

3. Open up the Cloud Commander (CC).

   How to access the Cloud Commander

4. In CC, navigate to the Data/modules folder.

5. Create a folder inside called jb2a_patreon (case-sensitive) and open it.

6. Drag all files except the Library folder from the extracted zip (Step 2) into the CC.

7. Create a folder called Library. The Library folder is very large and needs to be uploaded little by little. So, this means upload the 1st_Level,2nd_Level folders one by one. CC, for whatever reason, seems to have issues with large quantities of files in one go.

8. The Generic folder is also very large at around 5GB in size, so create a folder called Generic and upload in small batches into this folder.

9. Once you have uploaded all of the files, restart your Foundry instance.

10. You’re done! You can activate our module in your world and browse the assets using the Sequencer Database Viewer!

    

Manual Install

If you’re having issues with the manifest link for whatever reason or you have downloaded the “Complete Collection” zip as a backup and need to re-install our module, here’s how.

Note

This only concerns the Patreon module as you shouldn’t have to install our free module this way.

1. Download and Extract the “Complete Collection” zip somewhere on your hard drive.

2. Browse to your FoundryVTT User Data folder. There are two ways to locate this folder.

   • If you have the App installed, you can right-click the FoundryVTT icon in your taskbar and choose “Browse to User Data”
   • Otherwise, on the home page of FoundryVTT, click the gear icon to change the configuration settings and the User Data folder path will appear there.

   

3. Inside the User Data folder, open the modules folder.

4. Create a folder called exactly jb2a-patreon. It’s case-sensitive.

5. Back to our extracted zip, we want to drag the files inside over to the newly created jb2a_patreon folder. The file transfer might take a while, it’s a large amount of data! Once finished, it should look like this:

   • Directorydata

     • Directorymodules

       • Directoryjb2a-patreon

         • Directoryartwork/

           • …
         • DirectoryLibrary/

           • …
         • Directorypacks/

           • …
         • Directoryscripts/

           • …
         • module.json
     • Directorysystems/

       • …
     • Directoryworlds/

       • …

6. Restart your FoundryVTT server.

7. That’s it! You should be able to enable our module in any of your worlds!

How to use

JB2A + FoundryVTT core

What is described in this subsection applies to any game system and without additional modules. In other words, with the FoundryVTT core.

Our assets are in the Library folder in our modules. Once in the FoundryVTT data folder, you’ll find them in this location:

• Directorydata

  • Directorymodules

    • Directoryjb2a-moduleName

      • Directoryartwork/

        • …
      • DirectoryLibrary/

        • …
      • Directorypacks/

        • …
      • Directoryscripts/

        • …
      • module.json
  • Directorysystems/

    • …
  • Directoryworlds/

    • …

Tiles

To use an animated asset as a tile to a FoundryVTT canvas, follow the instructions on the official website. FoundryVTT Tiles Documentation

What is a Tile?

If you don’t know what a tile is on FoundryVTT, we encourage you to read the first Overview section of their documentation.

Tokens

To use an animated asset as a token on FoundryVTT, follow the instructions on the official website. The information you need can be found in the ‘Token Configuration Options -> The Appearance Tab’ section. FoundryVTT Token Documentation

What is a Token?

If you don’t know what a token is on FoundryVTT, we encourage you to read the first Overview section of their documentation.

Macros

This method requires a good knowledge of javascript to be able to do just about anything with our assets. To find out more about what a macro is on FoundryVTT and how to use them, read the documentation provided on their official website. FoundryVTT Macros Documentation

Depending on the game system you’re using, you won’t necessarily have to use macros to do the most basic automation, such as triggering an animated effect when a player takes an action on their character sheet.

Note

The Sequencer module, created by Fantasy Computerworks, makes it much easier to write macros to create effects from our animated assets. We’ll talk more about this later.

More about Sequencer

JB2A + Automated Animations

Trigger your first effect

Before embarking on this step, read the “Prerequisites” and “Understanding Animation” secions first or you’ll be missing the basics to understand what you’re doing.

Prerequisites

Understanding Automation

This step-by-step guide is for the DnD5e gaming system. Some things may be different depending on the game system you wish to use. If Automated Animations is compatible with your game system, only the character sheet part will need to be adapted.

List of compatible game systems for Automated Animations

Requirements

To follow this guide, here’s what you need:

• FoundryVTT
  • A world for the DnD5e game system.
• Modules
  • Sequencer from Fantasy Computerworks.
  • Automated Animations from Otigon.
  • Our Free or Patreon module.

These modules must be installed with their dependencies. FoundryVTT will alert you when this is the case. Make sure they are all updated. Then all these modules must be activated in your world.

Versions

Here are the different versions used to produce this guide. You don’t need to have exactly the same versions. However, you should be aware that there may be some differences depending on the versions you use.

Note

The version of our Free or Patreon module is not important for this guide.

Scene setup

1. First, import two actors from the SRD compendium and drag and drop them onto the canvas. We’ll use Akra as the Player Character and an Acolyte as the Non-Player Character.

   

   

2. Automated Animations has a number of animated effects already configured. There are only a few of them and they serve as a reference. To access the Automated Animations menu, which we’ll call the Autorec menu from now on:

   1. Go to the Settings tab
   2. Click on Configure Settings.
   3. Then select Automated Animations in the sidebar
   4. And click on Launch Menu.

   

3. Explore the Autorec Menu. There are various tabs for creating or customising effects (Melee - Active Effects), Settings, and Diagnostics (to help you troubleshoot any problems).

   

4. Quick Tip: To simplify access to the menu, Automated Animations provides a macro allowing you to open this window directly from the hot bar.

   1. At the top of the Autorec Menu window, click Settings.
   2. At the bottom of this window, there is an area called Automatic Recognition Menu Macro, click on the area and drag the macro into the hot bar.
   3. To return to the Autorec Menu, you can now either:
      • Close the window and use the macro,
      • or click on Main Menu.

   

5. Back on the canvas, with Akra, we’re going to attack the Acolyte with his mace.

   1. First, target the Acolyte,
   2. then, select Akra.
   3. Finally, trigger the attack from his character sheet.
   4. The animation should be triggered after rolling the dice. You’ve just triggered your first animated effect!

6. But why stop there? Now, move Akra a few dozen feet away from the Acolyte, check that he still has his target and make an attack with the light crossbow. An animation should be triggered when you roll the dice.

7. Then try Fog Cloud. The animation should be triggered after you place the template on the canvas.

   In this case, there are two options for deleting the template: Click on the Template tool in the FoundryVTT left-hand toolbar and delete the template.

   Alternatively, go to the Sequencer Manager, the button on the left-hand bar of FoundryVTT. This is where you’ll find all the persistant animation on the Canvas. Then go to the template tool to remove the template from the canvas.

8. Finally do the same thing with Inflict Wounds. Normally, if you have exactly the same setup, there are no animations after triggering the attack. This is perfectly normal!

9. Open the Autorec menu and look at the melee tab. You’ll see that the Mace is there. All our melee attack animations must be configured in this tab to work correctly.

   

10. Then go to the Range tab, and you’ll see that there’s only the Crossbow preset and not Light Crossbow. This is because Automated Animations has recognised part of the name of the weapon and used this effect. All our ranged attack animations must be configured in this tab to work correctly.

    

11. In the Template tab, you’ll find Fog Cloud. This is where all spells/abilities similar to it must be configured. Whether it’s a square, circular, conical template, etc…

    

12. Inflict Wounds is a bit special. It could be possible to configure it in the melee tab but also in the On Token tab, depending on the animations you want to use. This was simply to illustrate what follows.

13. Automated Animations has very few pre-configured animated effects. These are generally called Effects. Depending on the game system you are using, there are several options available to you:

    • If you are using D&D5e, you can install the D&D5e animations module made by Vauxs among others. It can be downloaded and installed via FoundryVTT directly.
    D&D5e Animations
    • If you are using PF2e, you can install the PF2e Animations module or the PF2e Graphics module, which is currently under development. They can be downloaded and installed via FoundryVTT directly.
    PF2e Animations

    PF2e Graphics
    • For other game systems, you can join our Discord server, in the channel #aa-autorec-sharing, where people may have shared their presets. For example Cyberpunk and Warhammer.
    Join our Discord

14. This is where the guide ends. To go further with Automated Animations, we recommend that you read its documentation. Otigon has explained everything in more detail. For example :

    How to configure an Effect About persistent Effects