Skip to content

Commit

Permalink
Fixed up module.json and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RainingDragon committed Dec 8, 2022
1 parent ab87f11 commit 6d0f66a
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 28 deletions.
29 changes: 8 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,30 @@
# Ready Set Roll for 5e - FoundryVTT Module
# Ready Set Roll for sw5e - FoundryVTT Module
![Latest Version](https://img.shields.io/badge/dynamic/json.svg?url=https%3A%2F%2Fraw.githubusercontent.com%2FMangoFVTT%2Ffvtt-ready-set-roll-5e%2Fmaster%2Fmodule.json&label=Latest%20Release&prefix=v&query=$.version&colorB=blue&style=for-the-badge)
![Foundry Versions](https://img.shields.io/endpoint?url=https%3A%2F%2Ffoundryshields.com%2Fversion%3Fstyle%3Dfor-the-badge%26url%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2FMangoFVTT%2Ffvtt-ready-set-roll-5e%2Fmaster%2Fmodule.json&color=ff601e&label=Compatible%20Foundry%20Versions)
![GitHub all releases](https://img.shields.io/github/downloads/MangoFVTT/fvtt-ready-set-roll-5e/total?style=for-the-badge&label=Module%20Downloads)

**Ready Set Roll** is a Foundry VTT module that accelerates the built in rolling system of the [Foundry DnD5e system](https://github.com/foundryvtt/dnd5e). It allows for quick rolls with advantage, disadadvantage, and other modifiers for skills, items, ability checks, and saving throws. This module is a complete rewrite and modernisation of [RedReign](https://github.com/RedReign)'s [Better Rolls for 5e](https://github.com/RedReign/FoundryVTT-BetterRolls5e) module, which is no longer supported, and no longer functional as of more recent versions of FoundryVTT.
**Ready Set Roll for sw5e** is a Foundry VTT module that accelerates the built in rolling system of the [Foundry sw5e system](https://github.com/unrealkakeman89/sw5e). It allows for quick rolls with advantage, disadadvantage, and other modifiers for skills, items, ability checks, and saving throws. This module is a complete rewrite and modernisation of [RedReign](https://github.com/RedReign)'s [Better Rolls for 5e](https://github.com/RedReign/FoundryVTT-BetterRolls5e) module, which is no longer supported, and no longer functional as of more recent versions of FoundryVTT.

If you are feeling generous, and would like to support my work, you can do so through this [Paypal](https://www.paypal.com/paypalme/MangoFVTT) link, or through the sponsorship options in the sidebar. Thank you!
Check out [MangoFVTT](https://github.com/MangoFVTT/fvtt-ready-set-roll-5e), the original author of Ready Set Roll for dnd5e!

## Installation

### Method 1
1. Start up Foundry and click "Install Module" in the "Add-on Modules" tab.
2. Search for "Ready Set Roll" in the pop up window.
3. Click "Install" and the module should download and appear in your modules list.
4. Enjoy!

### Method 2
1. Start up Foundry and click "Install Module" in the "Add-on Modules" tab.
2. Paste one of the following into the "Manifest URL" field:
- *Latest Release:* `https://raw.githubusercontent.com/MangoFVTT/fvtt-ready-set-roll-5e/master/module.json`
- *Previous Releases:* A link to the `module.json` file from any of the [previous releases](https://github.com/MangoFVTT/fvtt-ready-set-roll-5e/releases).
- *Latest Release:* `https://raw.githubusercontent.com/RainingDragon/fvtt-ready-set-roll-sw5e/working-sw5e/module.json`
3. Click "Install" and the module should download and appear in your modules list.
4. Enjoy!

## Compatibility
**IMPORTANT:** Ready Set Roll is not compatible with other modules which modify DnD5e rolls (for example, [Midi-QOL](https://gitlab.com/tposney/midi-qol) or [MRE](https://github.com/ElfFriend-DnD/FVTT-Minimal-Rolling-Enhancements-DND5E)). While it is possible that such modules may also still work, using their roll automation features alongside this module is likely to cause issues, and is not recommended.
**IMPORTANT:** Ready Set Roll is not compatible with other modules which modify sw5e rolls (for example, [Midi-QOL](https://gitlab.com/tposney/midi-qol) or [MRE](https://github.com/ElfFriend-DnD/FVTT-Minimal-Rolling-Enhancements-DND5E)). While it is possible that such modules may also still work, using their roll automation features alongside this module is likely to cause issues, and is not recommended.

Ready Set Roll requires [libWrapper](https://foundryvtt.com/packages/lib-wrapper/) as a dependency to avoid conflicts with other modules. This dependency will be automatically resolved by Foundry when installed. It is recommended to have the latest version of libWrapper installed at all times.

### Verified Modules
The following modules have been verified as compatible from the specified module release onward. Note that updates to Foundry VTT or the module in question may cause incompatibilities that need to be re-tested. Furthermore, each verified module is tested with Ready Set Roll in isolation. Combining modules is likely to still work, however may cause issues. Always proceed with caution (keep backups) when installing and using multiple modules.
- [Dice So Nice](https://gitlab.com/riccisi/foundryvtt-dice-so-nice) <sup>(1.2.0+)</sup>
- [Tidy5e Sheet](https://github.com/sdenec/tidy5e-sheet) <sup>(1.2.0+)</sup>
- [Dynamic Active Effects](https://gitlab.com/tposney/dae) <sup>(1.3.1+)</sup>
- [Build-a-Bonus](https://github.com/krbz999/babonus) <sup>(1.3.2+)</sup>
- [Combat Utility Belt](https://github.com/death-save/combat-utility-belt) <sup>(1.3.11+)</sup>

## Implemented Features

Expand Down Expand Up @@ -75,17 +65,14 @@ The following modules have been verified as compatible from the specified module

![damagecontext](https://user-images.githubusercontent.com/110994627/188952930-f8be9901-a45e-43dd-97b4-d707062bc1ad.png)

## Planned Features
- Sheet roll buttons ([Issue #34](https://github.com/MangoFVTT/fvtt-ready-set-roll-5e/issues/34))
- More compatibility with other modules.
- Macro support for more flexible quick rolling.

## Known Issues
- [See [BUG] Issues list](https://github.com/MangoFVTT/fvtt-ready-set-roll-5e/issues?q=label%3Abug+)
Come here for issues (do NOT report issues to MangoFVTT, sw5e is slightly different): https://github.com/RainingDragon/fvtt-ready-set-roll-sw5e/issues
- Chat icon for weapon or spell is off, we're looking into though!

## Acknowledgements
- Atropos and the Foundry development team for making a truly fantastic VTT.
- RedReign for creating the original Better Rolls for 5e module, without which this module would not exist.
- MangoFVTT for creating the new Ready Set Rolls for 5e module, without it we wouldn't have it for sw5e!
- All the wonderful folks on the Foundry VTT discord for their tireless community efforts.

## License
Expand Down
14 changes: 7 additions & 7 deletions module.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"id": "ready-set-roll-sw5e",
"title": "Ready Set Roll for sw5e",
"description": "This module overhauls rolls for the D&D 5e system in the style of BetterRolls5e.",
"version": "1.3.13",
"description": "This module overhauls rolls for the sw5e system in the style of BetterRolls5e.",
"version": "1.0.0",
"compatibility": {
"minimum": "10.274",
"verified": "10.290",
Expand Down Expand Up @@ -47,9 +47,9 @@
}
]
},
"url": "https://github.com/MangoFVTT/fvtt-ready-set-roll-5e",
"manifest": "https://raw.githubusercontent.com/MangoFVTT/fvtt-ready-set-roll-5e/master/module.json",
"download": "https://github.com/MangoFVTT/fvtt-ready-set-roll-5e/releases/download/release-1.3.13/rsr5e-release-1.3.13.zip",
"bugs": "https://github.com/MangoFVTT/fvtt-ready-set-roll-5e/issues",
"readme": "https://github.com/MangoFVTT/fvtt-ready-set-roll-5e/blob/master/README.md"
"url": "https://github.com/RainingDragon/fvtt-ready-set-roll-sw5e",
"manifest": "https://raw.githubusercontent.com/RainingDragon/fvtt-ready-set-roll-sw5e/working-sw5e/module.json",
"download": "https://github.com/RainingDragon/fvtt-ready-set-roll-sw5e/releases/download/release-1.0.0/ready-set-roll-sw5e-1.0.0.zip",
"bugs": "https://github.com/RainingDragon/fvtt-ready-set-roll-sw5e/issues",
"readme": "https://github.com/RainingDragon/fvtt-ready-set-roll-sw5e/blob/working-sw5e/README.md"
}

0 comments on commit 6d0f66a

Please sign in to comment.