generated from League-of-Foundry-Developers/FoundryVTT-Module-Template
-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
057cc47
commit e156007
Showing
6 changed files
with
117 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,14 @@ | ||
|  | ||
| <!--- Downloads @ Latest Badge --> | ||
| <!--- replace <user>/<repo> with your username/repository --> | ||
| <!---  --> | ||
|  | ||
|
|
||
| <!--- Forge Bazaar Install % Badge --> | ||
| <!--- replace <your-module-name> with the `name` in your manifest --> | ||
| <!---  --> | ||
|
|
||
|
|
||
| # How to use this Template to create a versioned Release | ||
| # PF2e Reactive Token Ring | ||
| Adds some reaction for the pf2e system for dynamic token rings | ||
|
|
||
| 1. Open your repository's releases page. | ||
|
|
||
|  | ||
|
|
||
| 2. Click "Draft a new release" | ||
|
|
||
|  | ||
|
|
||
| 3. Fill out the release version as the tag name. | ||
|
|
||
| If you want to add details at this stage you can, or you can always come back later and edit them. | ||
|
|
||
|  | ||
|
|
||
| 4. Hit submit. | ||
|
|
||
| 5. Wait a few minutes. | ||
|
|
||
| A Github Action will run to populate the `module.json` and `module.zip` with the correct urls that you can then use to distribute this release. You can check on its status in the "Actions" tab. | ||
|
|
||
|  | ||
|
|
||
| 6. Grab the module.json url from the release's details page. | ||
|
|
||
|  | ||
|
|
||
| This `module.json` will only ever point at this release's `module.zip`, making it useful for sharing a specific version for compatibility purposes. | ||
|
|
||
| 7. You can use the url `https://github.com/<user>/<repo>/releases/latest/download/module.json` to refer to the manifest. | ||
|
|
||
| This is the url you want to use to install the module typically, as it will get updated automatically. | ||
|
|
||
| # How to List Your Releases on Package Admin | ||
|
|
||
| To request a package listing for your first release, go to the [Package Submission Form](https://foundryvtt.com/packages/submit) (accessible via a link at the bottom of the "[Systems and Modules](https://foundryvtt.com/packages/)" page on the Foundry website). | ||
|
|
||
| Fill in the form. "Package Name" must match the name in the module manifest. Package Title will be the display name for the package. Package URL should be your repo URL. | ||
|  | ||
|
|
||
|
|
||
| One of the Foundry staff will typically get back to you with an approval or any further questions within a few days, and give you access to the package admin pages. | ||
|
|
||
| Once you have access to the [module admin page](https://foundryvtt.com/admin/packages/package/), you can release a new version by going into the page for your module, scrolling to the bottom, and filling in a new Package Version. | ||
|
|
||
| When listing a new version, Version should be the version number you set above, and the Manifest URL should be the manifest __for that specific version__ (do not use /latest/ here). | ||
|  | ||
|
|
||
| > ### :warning: Important :warning: | ||
| > | ||
| > It is very important that you use the specific release manifest url, and not the `/latest` url here. For more details about why this is important and how Foundry Installs/Updates packages, read [this wiki article](https://foundryvtt.wiki/en/development/guides/releases-and-history). | ||
| Clicking "Save" in the bottom right will save the new version, which means that anyone installing your module from within Foundry will get that version, and a post will be generated in the #release-announcements channel on the official Foundry VTT Discord. | ||
|
|
||
|
|
||
| # FoundryVTT Module | ||
|
|
||
| Does something, probably | ||
|
|
||
| ## Changelog | ||
| ## Features | ||
| - Flashes red on damage taken | ||
| - Flashes green on heal | ||
| - Flashes white when targetted |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,87 @@ | ||
| Hooks.once('init', async function() { | ||
| Hooks.once("init", async function () {}); | ||
|
|
||
| const COLORS = { | ||
| GREEN: "#ADFF2F", | ||
| RED: "#ff0000", | ||
| WHITE: "#FFFFFF", | ||
| }; | ||
| Hooks.once("ready", async function () { | ||
| Hooks.on("updateActor", async (actor, update, status, userID) => { | ||
| if (userID == game.user.id) { | ||
| if (status.diff) { | ||
| const hpChanged = update.system.attributes.hp.value; | ||
| const dmgTaken = status.damageTaken; | ||
| const tok = canvas.tokens.placeables.find( | ||
| (token) => token.actor.id === actor.id | ||
| ); | ||
| if (hpChanged) { | ||
| if (dmgTaken) { | ||
| //Dealt Damage | ||
| flashColor(tok, COLORS.RED); | ||
| } else { | ||
| //Heal | ||
| flashColor(tok, COLORS.GREEN); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }); | ||
| Hooks.on("targetToken", async (user, token) => { | ||
| if (user.id === game.user.id) { | ||
| flashColor(token, COLORS.WHITE); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| Hooks.once('ready', async function() { | ||
| const defaultAnimationOptions = { | ||
| duration: 500, | ||
| easing: CONFIG.Token.ringClass.easeTwoPeaks, | ||
| }; | ||
|
|
||
| /** | ||
| * flash color of token | ||
| * @param {Token} token Token to flash | ||
| * @param {string} color Color as hex aka '#0000FF' | ||
| * @param {AnimationOptions} animationOverride Override to animation options | ||
| */ | ||
| async function flashColor(token, color, animationOverride = {}) { | ||
| //if ring enabled flash it | ||
| if (token?.document?.ring?.enabled) { | ||
| const options = foundry.utils.mergeObject( | ||
| defaultAnimationOptions, | ||
| animationOverride | ||
| ); | ||
| const colorNum = Color.fromString(color); | ||
| return token.ring.flashColor(colorNum, options); | ||
| } | ||
| //return Promise.resolve(); | ||
| } | ||
|
|
||
| // Code Borrowed from DND 5e system implementation of color flash | ||
|
|
||
| /** | ||
| * Easing function that produces two peaks before returning to the original value. Ideal duration is around 500ms. | ||
| * @param {number} pt The proportional animation timing on [0,1]. | ||
| * @returns {number} The eased animation progress on [0,1]. | ||
| */ | ||
| function easeTwoPeaks(pt) { | ||
| return (Math.sin(4 * Math.PI * pt - Math.PI / 2) + 1) / 2; | ||
| } | ||
|
|
||
| /* -------------------------------------------- */ | ||
| /* Rings System */ | ||
| /* -------------------------------------------- */ | ||
|
|
||
| /** | ||
| * The effects which could be applied to a token ring (using bitwise operations.) | ||
| * @enum {number} | ||
| * @readonly | ||
| */ | ||
| const effects = Object.freeze({ | ||
| DISABLED: 0x00, | ||
| ENABLED: 0x01, | ||
| RING_PULSE: 0x02, | ||
| RING_GRADIENT: 0x04, | ||
| BKG_WAVE: 0x08, | ||
| INVISIBILITY: 0x10, | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| export function registerSettings() { | ||
| game.settings.register("pf2e-reactive-token-ring", "enabled", { | ||
| name: game.i18n.localize("pf2e-reactive-token-ring.module-settings.enabled.name"), | ||
| hint: game.i18n.localize("pf2e-reactive-token-ring.module-settings.enabled.hint"), | ||
| scope: "world", | ||
| config: true, | ||
| default: true, | ||
| type: Boolean, | ||
| }); | ||
| } |