GithubHelp home page GithubHelp logo

daft-develop / mob-attack-tool Goto Github PK

View Code? Open in Web Editor NEW

This project forked from stendarpaval/mob-attack-tool

4.0 2.0 4.0 373 KB

A module for Foundry VTT that offers a tool for handling mob attacks in the dnd5e system.

License: GNU General Public License v3.0

JavaScript 81.34% CSS 3.31% HTML 15.36%

mob-attack-tool's Introduction

Mob Attack Tool Version Foundry Core Compatible Version Latest Release Download Count

ko-fi

Mob Attack Tool

This is a Foundry VTT module that streamlines mob attacks in the dnd5e system. It focuses on helping the GM and players quickly resolve multiple attack and damage rolls from groups of monsters (mobs), summons, and/or creatures with the multiattack action. This module supports use of the Dice so Nice!, Midi-QOL, and Automated Animations modules.

This module was originally created by Stenderpaval and is currently being maintained by Dafto.

Use Cases

  • The party is attacked by two dozen goblins and the GM doesn't want to resolve each attack individually
  • You have a Circle of the Sheperd Druid or School of Necromancy Wizard and want to let them run 10+ summons without bogging down combat turns
  • The big boss monster has 6 claw attacks and a tail attack and the GM wants to focus all the attacks on one poor character without having to roll each action separately, or keeps loosing count halfway between the rolls
  • Your level 5+ character wants to use all their extra attacks on one monster but doesn't want to click through each one

How to install

You can install this module by searching Foundry's package browser or by pasting this url in the corresponding text field of Foundry's package installer: https://raw.githubusercontent.com/daft-develop/mob-attack-tool/main/module.json. The module has no required dependencies and is only available for the D&D 5e system.

How to use

After activating this module, a new button appears in the token controls bar.

dice icon

By default this button is only visible to users with the GM role, but this can be changed in settings. To begin using Mob Attack Tool, make sure you have at least one token selected and at least one token targeted before you click the button.

A dialog window will appear, populated with the weapon options of the selected tokens and a checkbox. Tick the checkbox of the weapon(s) you want to use for the mob attack. Mob Attack Tool can also automatically select weapons that are part of a multiattack ability, or just the weapon option that deals most damage. Once the dialog is open, changing your selection or targets will update the dialog automatically.

Clicking on the Mob Attack button in the dialog window will then whisper a message to the GM (by default) with the mob attack results, showing hits, misses, critical hits, and critical misses with attack modifiers included. Furthermore, the weapon item is rolled the number of times that an attack would hit and a damage total is calculated.

If the MidiQOL module is installed, enabled, and activated within Mob Attack Tool settings, the damage roll is handed off to MidiQOL, which may then apply the damage to targets for you (or however you've configured MidiQOL)

If the Dice So Nice! module is installed, enabled, and activated within Mob Attack Tool settings, on screen dice will be rolled for both attacks and damage. Optionally, attack dice can be hidden and only damage rolls shown.

If the Automated Animations module is installed, enabled, and activated within Mob Attack Tool settings, attack animations configured by Automated Animations will play for each successful hit.

Instead of rolling for each mob, a lookup table can be used instead which will determine a fixed number of attacks based on the number of creatures and attack bonus vs ac difference. This table can be manually adjusted in the settings menu.

Limitations

  • Currently damage is just rolled without saves or condition checks. Mobs of ghouls biting will not trigger any paralysing effects
  • Older versions of this module worked with grouped initiative modules, but isn't actively supported in newer release. It might still work but hasn't been tested recently

New

Make sure to read through the latest release notes to see what the newest features are.

Examples

This is what the Mob Attack dialog looks like (as of v0.2.18) with multiattack autodetect + autoselect enabled. (Also shown are JB2A Animated Assets triggered by a macro that makes use of Midi-QOL's On Use Macro field).

MAT-v0 2 18-on-use-macro-JB2a

Below are some (older) GIFs that give a brief idea of how you can use Mob Attack Tool.

Click to show GIF of Mob Attack Tool

MAT-video-v0 0 3

Click to show GIF of Mob Attack Tool + Midi-QOL

MAT-video-midi-qol-v0 0 3

For more elaborate examples and screenshots, please head over to EXAMPLES.md. (Note: the examples are currently quite outdated, but they should still give a general overview. Mob Attack Tool can do much nowadays than what is shown in the examples. Browse the latest release notes to find out what exactly.

Planned improvements

  • Further (optional) automation of the initial selection of tokens
  • Some documentation and better structuring of the repo
  • Multiple target selection enhancements
  • Better incorporation of damage rolls to make use of latest 5e system enhancements

Bugs / Feature Requests

Have an issue or think the module could use a new feature? Create a new Github issue!

Translations

Mob Attack Tool currently supports these languages:

  • English
  • Korean (translation provided by KLO (discord : KLO#1490). Thanks, KLO!)

Inspirations

  • This module was inspired by Multiattack 5e.
  • The map shown in the examples was made by Printable RPG Spellarena. You can check out more of their beautiful maps on the Spellarena Patreon.

Contributors

  • Stenderpaval was the original author of this module and largely responsible for all the great features it provides
  • Juanfrank has kindly given feedback and helped me out with condensing damage formulas.
  • mike-marshall0164 has fixed various aspects of the individually rolled attacks.
  • Many thanks to members of the League of Extraordinary Foundry VTT Developers for module development advice, including how to set-up GitHub Actions.
  • 4cer improving the v10 fork with additional cleanup

mob-attack-tool's People

Contributors

4cer avatar daft-develop avatar drdwing avatar merudo avatar mike-marshall0164 avatar stendarpaval avatar veithflo avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

mob-attack-tool's Issues

Mayor Issue!!

No ko-fi.com link in the description to donate to your amazing work for maintaing this module :)

[BUG] 5e 3.x chat card enrichment breaks attack chat cards

Hi there, posting my screenshots from the issue I raised over at Stendarpaval#61 (comment).

Here are my settings (Same as yours far as I can tell)
Screenshot 2024-04-18 212101

The tool appears and I can increase/decrease the number in the mob and verify the target, as well as make the attack with advantage but when I click the "Mob Attack" button, the attack never resolves.
Screenshot 2024-04-18 212651

Pasting a screenshot of my chat too, but it just shows the initiative no attacks.
Screenshot 2024-04-18 212512

[BUG] v12 Support

Latest version of this module (0.6.0) is confirmed to not be working with v12 of Foundry since it's using legacy "data.data" access calls which are formally depreciated as of v12.

I'm intending to update the module for compatibility with v12 but don't have a timeline yet. This ticket is just a placeholder to let people know it's been considered and I'll update here once the work is in progress and/or more likely once it's complete.

[FEATURE] Allow Midi QOL to handle attack and damage workflow

Currently workflow only allows damage to be rolled/calculated and ignores conditions, saves, and other nice features. Look into option to apply all this other nice stuff. It may require more/different calls to MidiQOL or condensing multiple attacks into a single "equivalent" attack so MidiQOL can resolve it sanely.

[FEATURE] Compatibility with Roll Groups & More Midi QOL Options?

Hi, I'm currently poking around with Mob Attack Tool using Midi QOL and Roll Groups. And I can see that the roll automation using Midi QOL doesn't work well with Challenge Mode Armor Class and there is no option to change critical damage rules.

I'd love it if we could have Mob Attack Tool working with more options from Midi QOL, or at least more options in general for customization. And for Mob Attack Tool to recognize and separate the damage option from Roll Groups, like it did with versatile damage already.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.