commit 6c3ce5310129c773b4db817c686b51d19fc25147 Author: trotFunky Date: Mon May 12 22:55:13 2025 +0100 Initial commit - v0.1.0 This initial version adds a custom compendium with a macro for the tinkerer, and a dynamic token border to track player turn status. It has a couple of known major bugs but is needed for an upcoming game, with fixes hopefully later. It is only compatible with Foundry v12 at this time. diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..4ee706a --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +packs/** binary diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6d1767f --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +**/.idea/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a06a054 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" +means each individual or legal entity that creates, contributes to +the creation of, or owns Covered Software. + +1.2. "Contributor Version" +means the combination of the Contributions of others (if any) used +by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" +means Covered Software of a particular Contributor. + +1.4. "Covered Software" +means Source Code Form to which the initial Contributor has attached +the notice in Exhibit A, the Executable Form of such Source Code +Form, and Modifications of such Source Code Form, in each case +including portions thereof. + +1.5. "Incompatible With Secondary Licenses" +means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" +means any form of the work other than Source Code Form. + +1.7. "Larger Work" +means a work that combines Covered Software with other material, in +a separate file or files, that is not Covered Software. + +1.8. "License" +means this document. + +1.9. "Licensable" +means having the right to grant, to the maximum extent possible, +whether at the time of the initial grant or subsequently, any and +all of the rights conveyed by this License. + +1.10. "Modifications" +means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor +means any patent claim(s), including without limitation, method, +process, and apparatus claims, in any patent Licensable by such +Contributor that would be infringed, but for the grant of the +License, by the making, using, selling, offering for sale, having +made, import, or transfer of either its Contributions or its +Contributor Version. + +1.12. "Secondary License" +means either the GNU General Public License, Version 2.0, the GNU +Lesser General Public License, Version 2.1, the GNU Affero General +Public License, Version 3.0, or any later versions of those +licenses. + +1.13. "Source Code Form" +means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") +means an individual or a legal entity exercising rights under this +License. For legal entities, "You" includes any entity that +controls, is controlled by, or is under common control with You. For +purposes of this definition, "control" means (a) the power, direct +or indirect, to cause the direction or management of such entity, +whether by contract or otherwise, or (b) ownership of more than +fifty percent (50%) of the outstanding shares or beneficial +ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) +Licensable by such Contributor to use, reproduce, make available, +modify, display, perform, distribute, and otherwise exploit its +Contributions, either on an unmodified basis, with Modifications, or +as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer +for sale, have made, import, and otherwise transfer either its +Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; +or + +(b) for infringements caused by: (i) Your and any other third party's +modifications of Covered Software, or (ii) the combination of its +Contributions with other software (except as part of its Contributor +Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of +its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code +Form, as described in Section 3.1, and You must inform recipients of +the Executable Form how they can obtain a copy of such Source Code +Form by reasonable means in a timely manner, at a charge no more +than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this +License, or sublicense it under different terms, provided that the +license for the Executable Form does not attempt to limit or alter +the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + +This Source Code Form is subject to the terms of the Mozilla Public +License, v. 2.0. If a copy of the MPL was not distributed with this +file, You can obtain one at https://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + +This Source Code Form is "Incompatible With Secondary Licenses", as +defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..064c09a --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# The Mill's Fabula - v0.1.0 + +This little [FoundryVTT](https://foundryvtt.com/) module is a collection of compendiums and functionalities +to power our Fabula Ultima campaigns. + +# Compatibility + +This is *only* compatible with Foundry v12 currently. + +# Installation + +Currently, this can only be installed via manifest file, using the following URL : +``` +https://git.tfk-astrodome.net/trotFunky/TheMillsFabula/raw/branch/release/module.json +``` + +# Features + +This module is an aggregate of different things that are useful for us or that the GM wanted +to play with, so they don't necessarily connect with each other. + +They are described below in their own secions. + +## Combat border + +This part of the module adds a dynamic border around player tokens, which changes during combat. + +The border is always visible, but after a player has taken their turn it will switch to a different border, +highlighting the tokens that have played for this combat turn. + +The module supports going back and forth in the combat rounds, as well as going back in the turn order. +(Though because of limitations of the Fabula Ultima system, does not allow going *forward* in the turn order.) + +## Settings + +- An image to use for the default/idle border +- An image to use for the took turn/played/inactive border + +## Limitations + +There are currently two main issues that need to be fixed : +1. The tokens will not be updated when the GM is not on the scene. + - Indeed, the Fabula Ultima system seems to prevent players from receiving combat events, + so the GM is the only one that can receive them and update the tokens. That means they need to be in the active + combat scene for the changes to take effect. + - However, given that the module only uses the current state, if the GM comes back to the scene and a combat event is + triggered, the token borders will become correct. +2. The token borders will be incorrect when switching to a new scene + - It is unclear why, but apparently switching to another scene is very different from loading a new scene, + and the combat encounter of the scene is not available when tokens are created. This means that the combat status, + and thus the border type, cannot be properly determined on scene switch. + - This can be fixed by receiving a combat update, either from the players or the GM, on the scene. + +# Compendia + +- The only thing in the compendium pack is a macro automating the tinkerer's alchemy potions, + allowing to choose how many PIs to spend, how to allocate the results, previews and a final chat message + with the results. + +# Dependencies + +Modules: + - socketlib + +System: + - Fabula Ultima + +# License + +The code present in this repository is licensed under the Mozilla Public License 2.0. + +Assets that we created in this repository are licensed under +[CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), unless otherwise specified. diff --git a/assets/default-borders/base.webp b/assets/default-borders/base.webp new file mode 100644 index 0000000..a2ceb41 Binary files /dev/null and b/assets/default-borders/base.webp differ diff --git a/assets/default-borders/played.webp b/assets/default-borders/played.webp new file mode 100644 index 0000000..e508f9a Binary files /dev/null and b/assets/default-borders/played.webp differ diff --git a/lang/en.json b/lang/en.json new file mode 100644 index 0000000..c438434 --- /dev/null +++ b/lang/en.json @@ -0,0 +1,18 @@ +{ + "the-mills-fabula.title": "Fabula Moletrina", + "the-mills-fabula.description": "A module implementing our idiosyncratic ideas for the Mill's campaigns.", + "MF": { + "Border": { + "Settings": { + "BaseBorder": { + "Name": "Base border", + "Hint": "The image to use as a border for player tokens at all times." + }, + "PlayedBorder": { + "Name": "Turn taken border", + "Hint": "The image to use as a border for player tokens that have taken their turn." + } + } + } + } +} diff --git a/lang/fr.json b/lang/fr.json new file mode 100644 index 0000000..dd036a2 --- /dev/null +++ b/lang/fr.json @@ -0,0 +1,18 @@ +{ + "the-mills-fabula.title": "Fabula Moletrina", + "the-mills-fabula.description": "Un module implémentant nos idiosyncrasies et idées pour les campagnes du Moulin.", + "MF": { + "Border": { + "Settings": { + "BaseBorder": { + "Name": "Bordure par défaut", + "Hint": "L'image à utiliser comme bordure pour les jetons joueurs, présente en permanence." + }, + "PlayedBorder": { + "Name": "Bordure de tour joué", + "Hint": "L'image à utiliser comme bordure pour les jetons joueurs qui ont joué leur tour." + } + } + } + } +} diff --git a/module.json b/module.json new file mode 100644 index 0000000..5bc184b --- /dev/null +++ b/module.json @@ -0,0 +1,76 @@ +{ + "id": "the-mills-fabula", + "title": "Fabula Moletrina", + "description": "A module implementing our idiosyncratic ideas for the Mill's campaigns.", + "version": "0.1.0", + "compatibility": { + "minimum": "12", + "verified": "12", + "maximum": "12" + }, + "languages": [ + { + "lang": "en", + "name": "English", + "path": "lang/en.json" + }, + { + "lang": "fr", + "name": "Français", + "path": "lang/fr.json" + } + ], + "relationships": { + "systems": [ + { + "id": "projectfu", + "type": "system", + "compatibility": { + "verified": [ + "2.4.10", + "3.0.2" + ] + } + } + ], + "modules": [ + { + "id": "socketlib", + "type": "module", + "compatibility": { + "verified": "1.1.2" + } + } + ] + }, + "authors": [ + { + "name": "trotFunky Sparks", + "flags": {} + } + ], + "esmodules": [ + "scripts/token_combat_border.mjs" + ], + "socket": true, + "packs": [ + { + "name": "Macros", + "label": "The Mill's Macros", + "path": "packs/macros", + "type": "Macro", + "ownership": { + "PLAYER": "OBSERVER", + "ASSISTANT": "OWNER" + }, + "system": "projectfu", + "flags": {} + } + ], + + "license": "LICENSE", + "readme": "README.md", + "url": "https://git.tfk-astrodome.net/trotFunky/TheMillsFabula/src/branch/release", + "manifest": "https://git.tfk-astrodome.net/trotFunky/TheMillsFabula/raw/branch/release/module.json", + "download": "https://git.tfk-astrodome.net/trotFunky/TheMillsFabula/archive/v0.1.0.zip" +} diff --git a/packs/macros/000005.ldb b/packs/macros/000005.ldb new file mode 100644 index 0000000..c9f27f1 Binary files /dev/null and b/packs/macros/000005.ldb differ diff --git a/packs/macros/000013.ldb b/packs/macros/000013.ldb new file mode 100644 index 0000000..ff1a620 Binary files /dev/null and b/packs/macros/000013.ldb differ diff --git a/packs/macros/000069.log b/packs/macros/000069.log new file mode 100644 index 0000000..e69de29 diff --git a/packs/macros/CURRENT b/packs/macros/CURRENT new file mode 100644 index 0000000..284d53f --- /dev/null +++ b/packs/macros/CURRENT @@ -0,0 +1 @@ +MANIFEST-000068 diff --git a/packs/macros/LOCK b/packs/macros/LOCK new file mode 100644 index 0000000..e69de29 diff --git a/packs/macros/LOG b/packs/macros/LOG new file mode 100644 index 0000000..a1ba921 --- /dev/null +++ b/packs/macros/LOG @@ -0,0 +1,3 @@ +2025/05/09-18:11:40.073652 7253c0dec6c0 Recovering log #66 +2025/05/09-18:11:40.092496 7253c0dec6c0 Delete type=3 #64 +2025/05/09-18:11:40.092522 7253c0dec6c0 Delete type=0 #66 diff --git a/packs/macros/LOG.old b/packs/macros/LOG.old new file mode 100644 index 0000000..53e9bd4 --- /dev/null +++ b/packs/macros/LOG.old @@ -0,0 +1,7 @@ +2025/05/09-17:35:50.464775 7253c1dee6c0 Recovering log #62 +2025/05/09-17:35:50.483617 7253c1dee6c0 Delete type=3 #60 +2025/05/09-17:35:50.483640 7253c1dee6c0 Delete type=0 #62 +2025/05/09-18:11:37.487216 7253ae46b6c0 Level-0 table #67: started +2025/05/09-18:11:37.487234 7253ae46b6c0 Level-0 table #67: 0 bytes OK +2025/05/09-18:11:37.498365 7253ae46b6c0 Delete type=0 #65 +2025/05/09-18:11:37.548398 7253ae46b6c0 Manual compaction at level-0 from '!macros!AXWjXCoFJKa5KmSU' @ 72057594037927935 : 1 .. '!macros!AXWjXCoFJKa5KmSU' @ 0 : 0; will stop at (end) diff --git a/packs/macros/MANIFEST-000068 b/packs/macros/MANIFEST-000068 new file mode 100644 index 0000000..a1413e8 Binary files /dev/null and b/packs/macros/MANIFEST-000068 differ diff --git a/scripts/mills_fabula.mjs b/scripts/mills_fabula.mjs new file mode 100644 index 0000000..537f73a --- /dev/null +++ b/scripts/mills_fabula.mjs @@ -0,0 +1 @@ +export const id = "the-mills-fabula"; diff --git a/scripts/token_combat_border.mjs b/scripts/token_combat_border.mjs new file mode 100644 index 0000000..1ffa328 --- /dev/null +++ b/scripts/token_combat_border.mjs @@ -0,0 +1,234 @@ +import * as MillsFabula from "./mills_fabula.mjs"; +import { FUHooks } from "/systems/projectfu/module/hooks.mjs" +import { FU } from "/systems/projectfu/module/helpers/config.mjs" + +// NOTES +// Tokens are working PIXI.js objects, can .addChild() a sprite +// Get Token : game.scenes.active.collections.tokens.contents[0]._object +// Paths are relative to either the core data, or the base data. No need to do anything. +// https://pixijs.download/v4.8.0/docs/PIXI.Sprite.html + +/** + * Socket to use to execute things on clients, may be shared by other scripts of the module. + * @type {SocketlibSocket} + */ +let socket; +const SocketMessages = Object.freeze({ + UpdateBorder: "update-border", +}) + +const BorderSettings = Object.freeze({ + BaseBorderPath: "baseBorderPath", + PlayedBorderPath: "playedBorderPath", +}) + +/** + * The texture that will be used to create the base player token borders + * Will be created after fetching a path from the settings. + * @type {PIXI.BaseTexture} + */ +let base_border; +/** + * The texture that will be used to create the borders for player tokens that have taken their turns + * Will be created after fetching a path from the settings. + * @type {PIXI.BaseTexture} + */ +let played_border; + +// Enum for the border types. +const BorderTypes = Object.freeze({ + Active: "active", + Played: "played", +}); + +/** + * @param {BorderTypes} type The kind of border to create, deciding which texture to use + * @param {number} width Width of the final sprite on the canvas, in pixels + * @param {number} height Height of the final sprite on the canvas, in pixels + * @param {boolean} visible Should the new sprite be visible now ? + * @returns {PIXI.Sprite} A new sprite object corresponding to the border requested + */ +function create_new_border(type, width, height, visible) { + let border_texture; + switch (type) { + case BorderTypes.Active: + border_texture = base_border; + break; + case BorderTypes.Played: + border_texture = played_border; + break; + default: + throw new TypeError("Invalid BorderTypes Enum value: " + type); + } + /** @type {PIXI.Sprite} */ + let border = PIXI.Sprite.from(border_texture); + border.interactive = false; + border.width = width; + border.height = height; + border.visible = visible; + + /** + * Custom member, to be able to toggle border visibility dynamically + * @type {BorderTypes} + */ + border.borderType = type; + + return border; +} + +/** + * Toggle the borders of a token by ID, as we cannot pass the Token object via SocketLib (most objects being recursive). + * @param {string} token_id The ID of the token to update + * @param {boolean} played Status of the token to update + */ +function token_set_border_visibility(token_id, played) { + let token = canvas.scene?.tokens.get(token_id).object; + // Get the borders we manually added in the `drawToken` hook, if it has any. + let borders = token.children.filter((child) => child.borderType); + // console.debug("↓↓↓ set_border_visibility ↓↓↓"); + // console.debug(token) + for (let border of borders) { + if (border.borderType === BorderTypes.Active) { + border.visible = !played; + } else { + border.visible = played; + } + } + // console.debug("↑↑↑ set_border_visibility ↑↑↑"); +} + +/** + * Check if a token has played in a specific round, or the current combat round if it exists for the token. + * @param {Token} token The actual token object to check combat status + * @param {number} [round] The round to check the token's status in, will check the token's combat current turn otherwise + * @returns {boolean} If the token has played in the current or requested round + */ +function token_has_played(token, round = -1) { + // console.debug("↓↓↓ token_has_played ↓↓↓"); + // console.debug(token.inCombat) + if (!token.inCombat) { + return false; + } + + /** + * As we check beforehand, combat should always exist. + * @type {Combat} + */ + let combat = token.combatant.combat; + let round_turns_taken = combat?.flags.projectfu.CombatantsTurnTaken[round < 0 ? combat?.round : round] + // console.debug(`Testing played for round : ${combat?.round}`) + console.debug(round_turns_taken) + + // No token has taken a turn, or all turns were reverted. + if (!round_turns_taken || round_turns_taken.length === 0) { + return false; + } + + // console.debug("↑↑↑ token_has_played ↑↑↑"); + // Token might have played, let's search now. + return round_turns_taken.includes(token.combatant.id) +} + +/** + * Called by turn and round hooks, so the borders can be updated when going backwards as well as forwards. + * @param {Combat} combat The combat in which the token is active + * @param {{round: number, turn: number}} data The turn data for this update + */ +function combat_hook_update_token_borders(combat, data) { + // Turns is the array of *tokens having turns in this encounter*. + // console.debug("↓↓↓ combat_hook_update_token_borders ↓↓↓"); + // console.debug(combat) + // console.debug(data) + for (let combatant of combat.turns) { + // The combat passed by the hook still is on the previous round or turn, which would make the check + // use the previous round rather than the new one. Use the round contained in data instead, which is always + // the new one. + socket.executeForEveryone(SocketMessages.UpdateBorder, combatant.token.id, + token_has_played(combatant?.token.object, data.round)).then(); + } + // console.debug("↑↑↑ combat_hook_update_token_borders ↑↑↑"); +} + +function combat_border_main() { + Hooks.once("init", () => { + game.settings.register(MillsFabula.id, BorderSettings.BaseBorderPath, { + name: game.i18n.localize('MF.Border.Settings.BaseBorder.Name'), + hint: game.i18n.localize('MF.Border.Settings.BaseBorder.Hint'), + type: String, + config: true, + scope: 'world', + requiresReload: true, + filePicker: 'image', + default: 'modules/the-mills-fabula/assets/default-borders/base.webp' + }); + + game.settings.register(MillsFabula.id, BorderSettings.PlayedBorderPath, { + name: game.i18n.localize('MF.Border.Settings.PlayedBorder.Name'), + hint: game.i18n.localize('MF.Border.Settings.PlayedBorder.Hint'), + type: String, + config: true, + scope: 'world', + requiresReload: true, + filePicker: 'image', + default: 'modules/the-mills-fabula/assets/default-borders/played.webp' + }) + + // Create the border textures based on the image chose in the settings. + base_border = PIXI.BaseTexture.from(game.settings.get(MillsFabula.id, BorderSettings.BaseBorderPath)); + played_border = PIXI.BaseTexture.from(game.settings.get(MillsFabula.id, BorderSettings.PlayedBorderPath)); + }); + + Hooks.once("socketlib.ready", () => { + socket = socketlib.registerModule(MillsFabula.id); + socket.register(SocketMessages.UpdateBorder, token_set_border_visibility); + }) + + // Create the borders from defined textures and add them to the tokens when they are first created on canvas. + // FIXME: Does not work on scene change ! + Hooks.on("drawToken", (drawn_token) => { + // Only apply the borders to player tokens + if (drawn_token.actor?.type !== "character") + return; + + let has_played_turn = token_has_played(drawn_token); + // console.log(drawn_token) + // console.log(`Is in combat ? ${drawn_token.inCombat}`) + // console.log(`Combatant ? ${drawn_token.combatant}`) + // console.log(`Combat ?`) + // console.log(drawn_token.combatant.combat); + // console.log(game.combats.combats) + + const token_size = drawn_token.getSize(); + drawn_token.addChild(create_new_border(BorderTypes.Active, token_size.width, token_size.height, !has_played_turn)); + drawn_token.addChild(create_new_border(BorderTypes.Played, token_size.width, token_size.height, has_played_turn)); + + // console.log("============") + }) + + + Hooks.on("ready", () => { + // Players cannot run the combat hooks used here, which trigger for the GM no matter what. + // So register them for the GM only, who will execute the updates for players via SocketLib. + if (!game.user?.isGM) { + return; + } + + // console.debug("↓↓↓ Registering ↓↓↓") + Hooks.on("combatTurn", combat_hook_update_token_borders); + Hooks.on("combatRound", combat_hook_update_token_borders); + // console.debug("↑↑↑ Registering ↑↑↑") + + // No Foundry hook on end of combat, so use Fabula Ultima's. + // FIXME: Does not work when the GM is in another scene, as they don't receive the event. + Hooks.on(FUHooks.COMBAT_EVENT, (combat_event) => { + if (combat_event.type === FU.combatEvent.endOfCombat) { + for (let combatant of combat_event.combatants) { + // End of combat, clear all tokens. + socket.executeForEveryone(SocketMessages.UpdateBorder, combatant.token?.id, false).then(); + } + } + }) + }) +} + +combat_border_main()