Fixes for Foundry 0.8.x

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: cs96and
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/main.yml

@@ -1,38 +1,52 @@
-on:
-  push:
-    # Sequence of patterns matched against refs/tags
-    tags:
-    - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+name: Release Creation
 
-name: Upload Release Asset
+on:
+  release:
+    types: [published]
 
 jobs:
   build:
-    name: Upload Release Asset
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Build project # This would actually build your project, using zip for an example artifact
-        run: |
-          zip -r release.zip module/
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
-          draft: false
-          prerelease: false
-      - name: Upload Release Asset
-        id: upload-release-asset 
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps 
-          asset_path: ./release.zip
-          asset_name: release.zip
-          asset_content_type: application/zip
+    - uses: actions/checkout@v4
+
+    # Substitute the Manifest and Download URLs in the module.json
+    - name: Substitute Manifest and Download Links For Versioned Ones
+      id: sub_manifest_link_version
+      uses: cschleiden/replace-tokens@v1
+      with:
+        files: 'module/module.json'
+      env:
+        VERSION: ${{ github.event.release.tag_name }}
+        URL: https://github.com/${{ github.repository }}
+        MANIFEST: https://github.com/${{ github.repository }}/releases/latest/download/module.json
+        DOWNLOAD: https://github.com/${{ github.repository }}/releases/download/${{ github.event.release.tag_name }}/module.zip
+        CHANGELOG: https://github.com/${{ github.repository }}/releases/tag/${{ github.event.release.tag_name }}
+
+    # Create a zip file with all files required by the module to add to the release
+    - name: Zip Files
+      id: zip_files
+      run: zip -r ./module.zip module/ LICENSE
+
+    # Create a release for this specific version
+    - name: Update Release with Files
+      id: create_version_release
+      uses: ncipollo/release-action@v1
+      with:
+        allowUpdates: true # Set this to false if you want to prevent updating existing releases
+        omitNameDuringUpdate: true
+        omitBodyDuringUpdate: true
+        omitDraftDuringUpdate: true
+        omitPrereleaseDuringUpdate: true
+        token: ${{ secrets.GITHUB_TOKEN }}
+        artifacts: './module/module.json, ./module.zip'
+        tag: ${{ github.event.release.tag_name }}
+
+    # Publish the release to FoundryVTT's package repository.
+    - name: Publish Module to FoundryVTT Website
+      id: publish_to_foundry_website
+      if: ${{ !github.event.release.unpublished && !github.event.release.prerelease }}
+      uses: cs96and/FoundryVTT-release-package@v1
+      with:
+        package-token: ${{ secrets.FOUNDRY_PACKAGE_TOKEN }}
+        manifest-url: https://github.com/${{ github.repository }}/releases/download/${{ github.event.release.tag_name }}/module.json

.gitignore

@@ -0,0 +1 @@
+/module/CautiousGamemastersPack.lock

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2024 Alan Davies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,17 +1,46 @@
 # Cautious Gamemaster's Pack
 
+![GitHub Latest Release](https://img.shields.io/github/release/cs96and/FoundryVTT-CGMP?style=for-the-badge)
+![Foundry Version](https://img.shields.io/badge/dynamic/json?label=Foundry%20Version&prefix=v&query=%24.compatibleCoreVersion&url=https%3A%2F%2Fraw.githubusercontent.com%2Fcs96and%2FFoundryVTT-CGMP%2Fmaster%2Fmodule%2Fmodule.json&style=for-the-badge)
+![Latest Release Downloads](https://img.shields.io/github/downloads/cs96and/FoundryVTT-CGMP/latest/total?style=for-the-badge)
+![Forge Installs](https://img.shields.io/badge/dynamic/json?label=Forge%20Installs&query=package.installs&suffix=%25&url=https%3A%2F%2Fforge-vtt.com%2Fapi%2Fbazaar%2Fpackage%2FCautiousGamemastersPack&colorB=4aa94a&style=for-the-badge)
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/C0C057N35)
+
 Offers various simple handy options.
 
+Please note that v0.2.0 was called "Cautious Gamemaster's Pack 2", but since ownership of the original Foundry package has been transferred to me this has now been renamed back to "Cautious Gamemaster's Pack".  ***If you installed v0.2.0 and then upgrade to v0.2.1 you will find you have both "Cautious Gamemaster's Pack" and "Cautious Gamemaster's Pack 2" installed.  You will have to manually remove "Cautious Gamemaster's Pack 2".***
+
+## Settings
+
 ![](settings.png)
 
-* Disable GM from speaking as PC tokens (Toggle)
-* Blind chats and rolls made by hidden tokens (Toggle)
-* Disable using up/down arrow keys to recall previous chats so that they can be used to move the text cursor (Toggle)
+* **GM speaker mode / Player speaker mode**
+  * **Default**: Speakers are not altered.
+  * **Disable GM speaking as PC**: If the GM has a PC token selected and types a message in the chat box, this will prevent the message appearing as if it came from that PC.  It will be sent as an out-of-character message instead.
+  * **Force in-character**: Chat messages will come from assigned character regardless of whether that token is in the scene, or if `/ooc` chat is specified.
+  * **Always out-of-character**: Chat messages will always be sent as out-of-character messages.
+  * **Use assigned when in-character**: Chat messages will come from assigned character regardless of whether that token is in the scene, but `/ooc` messages will still be treated as out-of-character.
+* **Allow players to use /desc** - Usually only the GM can use the `/desc` command.  This settings also allows the players to use it.
+* **Blind rolls made by hidden tokens** - This turns all rolls made by hidden tokens into blind rolls.
+* **Notify typing** - Notify whether the other players are typing chat messages...<p>![](notify_typing.gif)</p>
+* **Allow players to see typing notification**: when typing notification is enabled, this settings allows players to see the notifications.  If disabled, only the GM can see the typing notifications.
+* **Hide scrolling damage text on NPC tokens**: Hides the scrolling text above a token when it takes damage.
+* **Hide scrolling healing text on NPC tokens**: Hides the scrolling text above a token when it receives healing.
+* **Disable flashing of Dynamic Token Rings**: Disables the Dynamic Token Ring flashing, e.g. when a token is damaged or healed.  Note this option only appears if you are using dnd5e v3.1, or Foundry v12.
+
+## Additional Chat Commands
+
+* Additional chat commands - `/desc` for description and `/as` for in-charactor without tokens...<p>![](additional_chat_commands.png)</p>
+
+---
+
+Version 2 is forked from [ShoyuVanilla's Cautious Gamemaster's Pack](https://github.com/ShoyuVanilla/FoundryVTT-CGMP) and contains a number of enhancements...
 
-![](notify_typing.gif)
+1. Added support for FoundryVTT v0.8.x
+2. When "Blind chats out of hidden tokens" is enabled, and the GM types a message while a hidden token is selected, this will be sent as a **visible** out-of-character message.  This assumes that the GM wants the message to appear, but forgot to deselect the token.  All rolls etc done by that token will still be hidden.
+3. Updated to use [libWrapper](https://foundryvtt.com/packages/lib-wrapper/).
+4. Added compatibility with the "[Tabbed Chatlog](https://foundryvtt.com/packages/tabbed-chatlog/)" module.
 
-* Notify whether the other players are typing chat messages (Toggle)
 
-![](additional_chat_commands.png)
 
-* Additional chat commands; /desc for description and /as for In Charactor without tokens

module/lang/cn.json

@@ -0,0 +1,22 @@
+{
+	"cgmp.gm-speaker-mode-s": "GM发言模式",
+	"cgmp.player-speaker-mode-s": "玩家发言模式",
+	"cgmp.speaker-mode.default-s": "默认",
+	"cgmp.speaker-mode.disable-gm-as-pc-s": "禁止GM使用PC身份发言",
+	"cgmp.speaker-mode.force-in-character-s": "强制以角色名发言",
+	"cgmp.speaker-mode.always-ooc-s": "固定为超游发言",
+	"cgmp.speaker-mode.in-character-always-assigned-s": "以角色名发言时使用已分配角色",
+	"cgmp.allow-players-to-use-desc-l": "允许玩家使用/desc聊天命令",
+	"cgmp.allow-players-to-use-desc-s": "允许玩家使用/desc",
+	"cgmp.blind-hidden-tokens-s": "隐藏指示物掷骰为暗骰",
+	"cgmp.blind-hidden-tokens-l": "隐藏指示物掷骰为暗骰，仅GM可见（聊天在超游中转为可见）",
+	"cgmp.notify-typing-s": "通知输入状态",
+	"cgmp.notify-typing-l": "其他玩家输入信息时进行通知",
+	"cgmp.allow-players-to-see-typing-notification-s": "允许玩家收到输入状态通知",
+	"cgmp.allow-players-to-see-typing-notification-l": "禁用时，仅GM可见输入状态通知",
+	"cgmp.typing-one": "{user} 正在输入...",
+	"cgmp.typing-two": "{user1} 和 {user2} 正在输入...",
+	"cgmp.typing-many": "{user1}、{user2} 和 {others} 正在输入...",
+	"cgmp.hide-npc-damage-text-s": "隐藏NPC指示物上的伤害数字",
+	"cgmp.hide-npc-healing-text-s": "隐藏NPC指示物上的治疗数字"
+}

module/lang/en.json

@@ -1,13 +1,24 @@
 {
-	"cgmp.disable-gm-as-pc-s": "Disable GM speaking as PC tokens",
-	"cgmp.disable-gm-as-pc-l": "Make all chats GM says as PC into Out of Character chats, except rolls",
-	"cgmp.blind-hidden-tokens-s": "Blind chats made by hidden tokens",
-	"cgmp.blind-hidden-tokens-l": "Blind all chats made by hidden tokens, including rolls. Only GM can see them",
-	"cgmp.disable-chat-recall-s": "Disable Chat Recalls",
-	"cgmp.disable-chat-recall-l": "Disable using up and down arrow keys to recall chats, so that they can be used to move the text cursor",
-	"cgmp.notify-typing-s": "Notify typings",
-	"cgmp.notify-typing-l": "Notify whether the other players are typing chat messages",
+	"cgmp.gm-speaker-mode-s": "GM Speaker mode",
+	"cgmp.gm-speaker-mode-l": "\"Default\": speakers are not altered.  \"Disable GM speaking as PC\": Make all chats GM says as PC into out-of-character chats, except rolls.  \"Force in-character\": Chat messages will come from assigned character regardless of whether that token is in the scene or if /ooc chat is specified.  \"Always out-of-character\": Make all messages out-of-character.  \"Use assigned when in-character\": Same as \"Force in-character\", but leaves out-of-character messages alone.",
+	"cgmp.player-speaker-mode-s": "Player Speaker mode",
+	"cgmp.speaker-mode.default-s": "Default",
+	"cgmp.speaker-mode.disable-gm-as-pc-s": "Disable GM speaking as PC",
+	"cgmp.speaker-mode.force-in-character-s": "Force in-character",
+	"cgmp.speaker-mode.always-ooc-s": "Always out-of-character",
+	"cgmp.speaker-mode.in-character-always-assigned-s": "Use assigned when in-character",
+	"cgmp.allow-players-to-use-desc-s": "Allow players to use /desc",
+	"cgmp.allow-players-to-use-desc-l": "Allow players to use the /desc chat command",
+	"cgmp.blind-hidden-tokens-s": "Blind rolls made by hidden tokens",
+	"cgmp.blind-hidden-tokens-l": "Blind all rolls made by hidden tokens, only the GM can see them (chats are converted into visible Out of Character chats)",
+	"cgmp.notify-typing-s": "Notify typing",
+	"cgmp.notify-typing-l": "Notify when other players are typing chat messages",
+	"cgmp.allow-players-to-see-typing-notification-s": "Allow players to see typing notification",
+	"cgmp.allow-players-to-see-typing-notification-l": "If disabled, only the GM can see typing notifications",
 	"cgmp.typing-one": "{user} is typing...", 
 	"cgmp.typing-two": "{user1} and {user2} are typing...",
-	"cgmp.typing-many": "{user1}, {user2} and other {others} players are typing..."
-}
+	"cgmp.typing-many": "{user1}, {user2} and {others} other players are typing...",
+	"cgmp.hide-npc-damage-text-s": "Hide scrolling damage text on NPC tokens from players",
+	"cgmp.hide-npc-healing-text-s": "Hide scrolling healing text on NPC token from players",
+	"cgmp.disable-dynamic-token-ring-flash-s": "Disable flashing of Dynamic Token Rings"
+}

module/lang/es-ES.json

@@ -1,13 +1,11 @@
 {
-	"cgmp.disable-gm-as-pc-s": "Disactivar que el DM hable como tokens de los PJs",
-	"cgmp.disable-gm-as-pc-l": "Hacer que todo lo que el DM diga como un PJ sea chat fuera del personaje (OOC), exceptuando las tiradas",
 	"cgmp.blind-hidden-tokens-s": "Ocultar los mensajes de chat hechos por tokens ocultos",
 	"cgmp.blind-hidden-tokens-l": "Ocultar todos los mensajes de chat hechos por tokens ocultos, incluyendo tiradas, solo los DM pueden verlos",
-	"cgmp.disable-chat-recall-s": "Desactivar el registro de chat",
-	"cgmp.disable-chat-recall-l": "Desactivar que las flechas arriba y abajo del teclado recuperen mensajes, para que pueden ser usuadas para recorrer el texto con el cursor",
 	"cgmp.notify-typing-s": "Avisar de los tecleos",
 	"cgmp.notify-typing-l": "Avisar cuando otros usuarios están escribiendo en el chat",
-	"cgmp.typing-one": "{user} está tecleando...", 
+	"cgmp.typing-one": "{user} está tecleando...",
 	"cgmp.typing-two": "{user1} y {user2} están tecleando...",
-	"cgmp.typing-many": "{user1}, {user2} y otros jugadores ({others}) están tecleando..."
+	"cgmp.typing-many": "{user1}, {user2} y otros jugadores ({others}) están tecleando...",
+	"cgmp.allow-players-to-use-desc-s": "Permitir a los jugadores utilizar /desc",
+	"cgmp.allow-players-to-use-desc-l": "Permite a los jugadores utilizar el comando de chat /desc"
 }

module/lang/fi.json

@@ -0,0 +1,23 @@
+{
+	"cgmp.player-speaker-mode-s": "Pelaajien puhujatila",
+	"cgmp.speaker-mode.default-s": "Oletus",
+	"cgmp.speaker-mode.force-in-character-s": "Pakota hahmona puhuminen",
+	"cgmp.speaker-mode.always-ooc-s": "Aina pelin-ulkopuolinen-puhe",
+	"cgmp.allow-players-to-use-desc-s": "Salli pelaajien käyttää /desc",
+	"cgmp.speaker-mode.in-character-always-assigned-s": "Käytä määritettyä, kun olet hahmossa",
+	"cgmp.blind-hidden-tokens-s": "Sokeuta piilotettujen pelinappuloiden heitot",
+	"cgmp.allow-players-to-see-typing-notification-s": "Salli pelaajien nähdä kirjoittamisilmoitus",
+	"cgmp.typing-one": "{user} kirjoittaa…",
+	"cgmp.typing-two": "{user1} ja {user2} kirjoittavat…",
+	"cgmp.typing-many": "{user1}, {user2} ja {others} muuta pelaajaa kirjoittavat…",
+	"cgmp.hide-npc-damage-text-s": "Piilota EPH-pelinappuloiden vierivä vahinkoteksti",
+	"cgmp.hide-npc-healing-text-s": "Piilota EPH-pelinappuloiden vierivä parannusteksti",
+	"cgmp.gm-speaker-mode-s": "PJ:n puhujatila",
+	"cgmp.speaker-mode.disable-gm-as-pc-s": "PJ ei voi puhua pelaajana",
+	"cgmp.allow-players-to-use-desc-l": "Salli pelaajien käyttää /desc-komentoa keskustelussa",
+	"cgmp.blind-hidden-tokens-l": "Kaikki piilotetut pelinappulat tekevät sokeita heittoja, jolloin vain PJ näkee ne (keskustelut muunnetaan näkyviksi pelin-ulkopuolinen-puhe-viesteiksi)",
+	"cgmp.notify-typing-s": "Ilmoita kirjoittamisesta",
+	"cgmp.notify-typing-l": "Ilmoita, kun muut pelaajat kirjoittavat keskusteluviestejä",
+	"cgmp.allow-players-to-see-typing-notification-l": "Jos pois päältä, vain PJ näkee kirjoittamisilmoitukset",
+	"cgmp.gm-speaker-mode-l": "\"Oletus\": puhujia ei muuteta. \"PJ ei voi puhua pelaajana\": \"Pakota hahmona puhuminen\": Tee kaikista keskusteluviesteistä (paitsi heitoista), joissa PJ puhuu pelaajana, pelin ulkopuolisia keskusteluviestejä. \"Pakota hahmona puhuminen\": Keskusteluviestit tulevat osoitetulta hahmolta riippumatta siitä, onko kyseinen pelinappula kohtauksessa tai onko /ooc-viesti määritetty. \"Aina pelin-ulkopuolinen-puhe\": Kaikki viestit ovat pelin ulkopuolisia viestejä. \"Käytä määritettyä, kun olet hahmossa\": Sama kuin \"Pakota hahmona puhuminen\", mutta jättää pelin ulkopuoliset viestit rauhaan."
+}

module/lang/fr-CA.json

@@ -0,0 +1,9 @@
+{
+	"cgmp.blind-hidden-tokens-s": "Aveugler les messages fait pas les personnages camouflés",
+	"cgmp.blind-hidden-tokens-l": "Aveugler les messages fait par des personnages camouflés, incluant les jets de dés. Seul le GM pourra les voir",
+	"cgmp.notify-typing-s": "Notifié lorsqu'on écrit",
+	"cgmp.notify-typing-l": "Notifié si les autres joueurs sont en train d'écrire des messages",
+	"cgmp.typing-one": "{user} est en train d'écrire...",
+	"cgmp.typing-two": "{user1} et {user2} sont en train d'écrire...",
+	"cgmp.typing-many": "{user1}, {user2} et les autres {others} joueurs sont en train d'écrire..."
+}