Skip to content
This repository has been archived by the owner on Apr 30, 2021. It is now read-only.
/ MountUp Public archive

Mount Up! is a module for Foundry VTT that allows tokens to carry or be carried by other tokens. This is completely system agnostic, and fully customizable to fit right into your game.

License

Notifications You must be signed in to change notification settings

jaltepeter/MountUp

Repository files navigation

logo

Mount Up!

Mount Up! is a module for Foundry VTT that allows tokens to carry or be carried by other tokens. This is completely system agnostic, and fully customizable to fit right into your game.

Twitter Follow Become a Patron Donate via Ko-Fi

NOTE

This is just a variant code of the wonderful work of brunhine hope to see you back, (try to make it work for 0.7.9), but i failed there is to many issues, i will try to make some strange patches, but anyone more skilled then me is welcome take charge of this.

Known issue

  • There is a incompatibility with the Token Factions when i "Mount Up" a faction token the PIXI Graphic go in conlict and launch a exception is not a grave exception but is annoying

Installation

It's always better and easier to install modules through in in app browser. Just search for "Mount Up!"

To install this module manually:

  1. Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules"
  2. Click "Install Module"
  3. In the "Manifest URL" field, paste the following url: https://raw.githubusercontent.com/p4535992/MountUp/master/src/module.json
  4. Click 'Install' and wait for installation to complete
  5. Don't forget to enable the module in game using the "Manage Module" button

libWrapper

This module uses the libWrapper library for wrapping core methods. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.

token-attacher

This module uses the token-attacher library like a dependency. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.

Mounting

To mount a token:

  1. Select the "rider" and the "mount" tokens.
  2. Right click on the "mount" icon to bring up the token HUD.
  3. Click on the horse icon (you can change this in your game).
    mount example
    The rider will now be linked to the mount. Anywhere the mount moves, the rider follows.

Dismounting

To dismount a token from a token:

  1. Right click on the "mount" to bring up the token HUD.
  2. Click on the dismount icon.
    dismount example
    The rider will now be un-linked from the mount, and is free to move on their own.

Macros

Some functionality is exposed to macros for repeatable usage. All macros will either accept a token ID or name (case insensitive).

Mounting

You can mount a rider to a mount using the following syntax:

MountUp.mount('RiderNameOrId', 'MountNameOrId')

or you can use the module 'token-attacher'

Dismounting

You can have a rider dismount by passing it's token name or id:

MountUp.dismount('RiderNameOrId)

or you can use the module 'token-attacher'

Drop a rider from a mount

You can have a mount drop its rider by passing the mount's name or id:

MountUp.dropRider('MountNameOrId')

or you can use the module 'token-attacher'

Localization

Japanese Language support provided by BrotherSharper ('Brother Sharp#6921' on discord)

always welcoming more translations

Feedback

Any issues, bugs, or feature requests are always welcome to be reported directly to the Issue Tracker, or using the Bug Reporter Module.

Licensing

Mount Up! is a module for Foundry VTT by Jeremiah Altepeter and is licensed under a Creative Commons Attribution 4.0 International License.

This work is licensed under Foundry Virtual Tabletop EULA - Limited License Agreement for module development v 0.1.6.

Acknowledgements

Bootstrapped with League of Extraordinary FoundryVTT Developers foundry-vtt-types.

Mad props to the 'League of Extraordinary FoundryVTT Developers' community which helped me figure out a lot.

About

Mount Up! is a module for Foundry VTT that allows tokens to carry or be carried by other tokens. This is completely system agnostic, and fully customizable to fit right into your game.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published