Forgotten-Adventures / FA_Battlemaps

6 stars 1 forks source link

FA_Battlemaps

This Module contains battlemaps from Forgotten Adventures, fully integrated for use with Foundry VTT. Featuring extra capabilities using Monk's Active Tile Triggers and Tagger for truly dynamic scenes!

Installation:

  1. Copy & paste this link in Foundrys Module Manager to install the Module

    https://raw.githubusercontent.com/Forgotten-Adventures/FA_Battlemaps/main/module.json

Install1

  1. Enable the Module + the dependency modules (Monk's Active Tile Triggers & Tagger) in your worlds Module Settings

Install2

How to Use

To open the module interface click the "FA Battlemaps" button at the bottom of the Scenes panel. You can also open the interface in the module settings and disable this button if you wish.

Interface1

Downloading & Importing Scenes

  1. Choose a map you would like to import and click the "Download" button.

  2. Wait until the loading and download of all associated assets is finished and you see a "[Map name] has been imported successfully." popup.

  3. Enjoy!

Download1

Patreon Login

  1. Open the module interface
  2. Click on "Login with Patreon" button to authenticate with patreon (Sucessful authentication turns the button green) which allows you to download Premium ( Patreon only ) maps - You must be a Battlesmith or higher Patreon supporter of FA_Battlemaps.

PatreonLogin1

Module Settings

Module Settings allow you to

  1. Open the interface
  2. Disable the "FA Battlemaps" button at the bottom of the scenes panel
  3. To activate "Download High Quality Maps"
  4. Modify where the map assets are downloaded to

ModuleSettings2

Changelog:


v1.1.9

Acknowledgement

Many thanks Blair#9056 for picking up the project and helping us get it through the finish line - amazing work! and also DarkestHour111#2731 for early development ^_^

Our module utilizes these awesome modules:

Support

You can support the creation of our battlemaps on Patreon!

A gallery of our work can be found on the website.

Join our Discord server for any further questions or bug reports.

Contributing

This section is for mapmakers who contribute to the module.

Since v1.1.0 of the module, the database has moved to levelDB. This means that the JSON files are no longer directly viewable. To assist with maintaining visibility of changes, an npm script exists to convert the levelDB database to a JSON file.

Prior to committing changes to git, you should run the following commands:

  1. npm run build:json to export the database to JSON files.
  2. The JSON files will be output to the packs/_source directory.
  3. You can then compare the changes in the JSON files to ensure that the changes are as expected using something like git diff.

Building the database from JSON files is also possible (for example: you accidentally broke something locally, or wanted to make a change to the raw JSON) using the following command:

  1. npm run build:db to import the JSON files back into the database.