Chat Portrait
A Foundry VTT module that displays the Actor's portrait images on the chat messages.
This is a upgrade of the project Chat Portrait by ShoyuVanilla ty to ShoyuVanilla
NOTE: If you are a javascript developer and not a typescript developer, you can just use the javascript files under the dist folder
Installation
It's always easiest to install modules from the in game add-on browser.
To install this module manually:
- Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules"
- Click "Install Module"
- In the "Manifest URL" field, paste the following url:
https://raw.githubusercontent.com/ShoyuVanilla/FoundryVTT-Chat-Portrait/master/src/module.json - Click 'Install' and wait for installation to complete
- Don't forget to enable the module in game using the "Manage Module" button
How help to make the Integration multisystem for my system ?
Since version 0.7.0, the module has been rewritten to allow for each system to have a css file to define the style and a description file of the mapping for the "ImageReplacer" feature.
Now the community can "come" to me a little, testing the css on their browser and help me understand which combination is the best, i file css si trovano nella directory degli styles, here a example for the dnd5e system
So the steps to follow to create or update a system are:
- Creation or update of the style file in the styles directory the file must respect the
chat-portrait-style-XXX.cssnomenclature where XXX is the system id e.g. "dnd5e". - Creation or update of the typescript file for the mapping of the "ImageReplacer" feature if you do not want to use this feature create the file as empty and I'll take care of integrating the version with the empty arrays. In the minimal case you just need to copy the contents of the file generic.ts and insert the id of your system in the property "SYSTEM_ID" remember that you have to rename the file with the system id.
- Insert the system if absent in the configuration file systems.ts
- Open a pr on contact me in some way, by open a issue ecc.
NOTE: You can use other modules like Custom CSS for manage the css classes, the module help you by defining two css classes you can customize for the purpose of this module chat-portrait-text-size-name for the text chat message (the 'Setup additional custom styling on the text chat message' setting) and chat-portrait-image-size-name for the image prepend the text chat message (the 'Setup additional custom styling on the image prepend the text chat message' setting)
The module will continue to allow the use of custom CSS if desired.
Known Issue\Limitation
-
Integration multisystem it's very hard to find the time for this, for now i'm supporting only the system i use or ask by issue request, but anyone can point out what system has problem. i have prepared a base code for support multysistem, i will not actively developing on the short term.
-
Better integration with midi-qol and CUB for their mechanism of Unknown creature, but there is no conflict because it's just css and html modification on the chat message so you can use without any issue beyween this modules
Hooks
ChatPortraitEnabled is called before the interaction with the chat is executed. When any of executed hooks return false the interaction is aborted with the default one of foundry.
ChatPortraitReplaceData is called like a replacement to the standard chat portrait recovery image, so any system or GM can use a customized version for a specific module.
Chat Portrait Custom Data
const chatPortraitCustomData = {
// url or file string reference to the image portrait path
customIconPortraitImage,
// [DEPRECATED use instead the 'customImageReplacerData'] Customize your own imageReplacer (Record<string,string>)
customImageReplacer,
// Customize your own imageReplacer ( array of { name: string; icon: string;})
customImageReplacerData: imageReplacerData,
}
/// WARNING: internal data - do not use if possible
// data schema is defined in: src/module/ChatPortraitModels.ts (or module/ChatPortraitModels.js)
Example
Use your own code to enable/disable the module chat-portrait...
Hooks.call('ChatPortraitEnabled');
// DO SOME CHECK 'BEFORE' APPLY THE CHAT PORTRAIT STYLING
How you can use this on your code....
Hooks.on('ChatPortraitEnabled', () => {
// DO SOMETHING AND RETURN OR TRUE OR FALSE FOR ENABLE THE MODULE CHAT PORTRAIT
})
Use your own code for give me a customized image reference to put on the portrait , if you want you can give me a specific image reference for the 'Image Replacer" feature.
const chatPortraitCustomData = {
customIconPortraitImage: "http://myimageurl/test.png", // url or file string reference to the image portrait path
customImageReplacer: imageReplacer, // [DEPRECATED use instead the 'customImageReplacerData'] Customize your own imageReplacer (Record<string,string>)
customImageReplacerData: imageReplacerData, // Customize your own imageReplacer ( array of { name: string; icon: string;})
};
Hooks.call('ChatPortraitReplaceData', chatPortraitCustomData, chatMessage);
// and then i'll do something with `chatPortraitCustomData`
const blabla = chatPortraitCustomData;
How you can use this on your code....
Hooks.on('ChatPortraitReplaceData', (chatPortraitCustomData, chatMessage) => {
// Set your own image
chatPortraitCustomData.customIconPortraitImage = ......
// DO SOMETHING AND RETURN A NEW chatPortraitCustomData
return chatPortraitCustomData; // this is blabla
})
Full Example
Hooks.on('ChatPortraitReplaceData', (chatPortraitCustomData, chatMessage) => {
const speaker = ChatMessage.getSpeakerActor(chatMessage.data.speaker);
if('KW_WarfareUnitSheet' === speaker?.sheet?.constructor.name) {
chatPortraitCustomData.iconMainCustomReplacer = {
"KW_WARFARE.Power": "systems/dnd5e/icons/skills/yellow_08.jpg",
"KW_WARFARE.Attack": "systems/dnd5e/icons/skills/red_31.jpg",
"KW_WARFARE.Morale": "systems/dnd5e/icons/skills/yellow_17.jpg",
"KW_WARFARE.Command": "systems/dnd5e/icons/skills/ice_16.jpg"
};
}
return chatPortraitCustomData;
});
Systems
For now the following system are the only one i tested
- Dnd5e system
- PF2
any other system need some fed back from the community
Features/Settings
-
Use Token Image: Use the actor's Token image instead of the actor's standard image. Note: In the event the token associated with a chat message no longer exists, it will use the actor's prototype token's name. In the event the actor no longer exists, it will try to get the avatar image of the player/GM, and the original chat message's alias (usually the actor's name) to the GM.
-
Do not use Token Image with the following type of actors : (e.g. character, npc, ecc. separate by character ','). Remember the actor type is case sensitive. Make sense only with the setting 'Use Token Image' set to true",
-
Use Token Name: Use the actor's Token name instead of the actor's standard name.
-
Use Avatar Player Image: Use the player's Avatar image instead of the token/actor standard image. if true ignore the first option if a avatar image is not found is going back to the standard actor/token image of the 'mistery man', this option is ignored if you are the GM or else because everything you click will have the avatar image of the GM expect for the OOC chat message. NOTE: Every OOC message by default activate this mode because make sense no token must be associated with a OOC message even for player.
-
Apply chat portrait on combat tracker: Apply the recovery of the image on the combat tracker.
- If you are a GM and the combatant is not owned from any player the 'Use token image' feature is enabled anyway.
- If you are a GM the 'Use Avatar Image feature' is ignored and the 'Use token image' feature is enabled anyway for all the tokens not owned from any player.
- If you are NOT a GM and is enable the 'Use avatar image' feature and the player owned more than a token in combat the image is the same (the avatar image of the player)
-
Shows the name of the player next to the name of the actor for any IC messages
-
Portrait Size (px): Configure portrait image size on the chat messages. Default is 36 px
-
Portrait Border Shape: Configure border shape of the portraits displayed on the chat messages. Setting this as None disables other border options
- Square
- Circle
- None
-
Use Player Color for Portrait Border
- Portrait Border Color
- Portrait Border Width (px)
-
Configure portrait border width. Default is 2 px
-
Change Color of Message Border: Use the actor's player's color for the border of the entire chat message
-
Change Color of Message Background: Use the actor's player's color for the background of the entire chat message
-
Display Chat Flavor Text next to Portrait
-
Force Name Search: If there is no Actor matching with chat message data, search for an actor of which name corresponds to the message speaker's alias. This option is needed for the compatibility with Theatre Insert module. This not work on the 'Combat Tracker feature'
-
Portrait Size for other images (px): Configure portrait image size for any other image on the chat message (other than the portrait one). Default is 36 px
-
Double Click on the image portrait or the name of the token "pan to token" on the current scene
-
Configure which chat message should receive custom styling, and which ones should be left as default. Changing this may require you to refresh your window:
- allCards : Affect every message.
- selfAndGM : Affect own messages and GM messages.
- self : Only affect own messages.
- gm : Only affect GM messages.
- player : Only affect player messages.
- none : Don't affect any messages.
-
Adds a textual tag to chat messages to easily identify whether the message is a whisper, blind roll, or self roll
-
Display chat message of type OTHER: Configure custom styling for message of type OTHER
-
Display chat message of type OOC: Configure custom styling for message of type OOC
-
Display chat message of type IC: Configure custom styling for message of type IC
-
Display chat message of type EMOTE: Configure custom styling for message of type EMOTE
-
Display chat message of type WHISPER: Configure custom styling for message of type WHISPER
-
Display chat message of type ROLL: Configure custom styling for message of type ROLL
-
Display chat message of whisper to other: Configure custom styling for message of whisper to other
-
Configure which cards should use the unknown custom styling, and which ones should be left as default. Changing this may require you to refresh your window:
- allCards : Affect every message.
- selfAndGM : Affect own messages and GM messages.
- self : Only affect own messages.
- gm : Only affect GM messages.
- player : Only affect player messages.
- none : Don't affect any messages.
- [DEVELOPING] onlyNpc: Affect any messages done from a NPC (need a compatible system with the 'npc' type like D&D5).
-
Placeholder for the label unknown Actor name: by default is 'Unknown Actor' depends on the 'Display Unknown' setting
-
Placeholder for the label unknown item name: by default is 'Unknown Item' depends on the 'Display Unknown' setting
-
Placeholder for the label unknown item icon: by default is '/modules/chat-portrait/assets/inv-unidentified.png' depends on the 'Display Unknown' setting
-
[CSS CUSTOM SETTING] Setup additional custom styling on the text chat message : Setup additional custom styling on the text chat message with CSS language (note override any other prior property)
NOTE: You can use other modules like Custom CSS for manage the css classes, the module help you by defining two css classes you can customize for the purpose of this module chat-portrait-text-size-name for the text chat message (the 'Setup additional custom styling on the text chat message' setting) and chat-portrait-image-size-name for the image prepend the text chat message (the 'Setup additional custom styling on the image prepend the text chat message' setting)
Example of css piece of code for the dnd5e system to load on your world
.chat-portrait-text-size-name-dnd5e .chat-portrait-system-dnd5e {
display: flex;
margin: auto;
}
- [CSS CUSTOM SETTING] Setup additional custom styling on the image prepend the text chat message: Setup additional custom styling on the image prepend the text chat message chat message with CSS language (note override any other prior property)
NOTE: You can use other modules like Custom CSS for manage the css classes, the module help you by defining two css classes you can customize for the purpose of this module chat-portrait-text-size-name for the text chat message (the 'Setup additional custom styling on the text chat message' setting) and chat-portrait-image-size-name for the image prepend the text chat message (the 'Setup additional custom styling on the image prepend the text chat message' setting)
Example of css piece of code for the dnd5e system to load on your world
.chat-portrait-image-size-name-dnd5e .chat-portrait-system-dnd5e {
display: flex;
margin: auto;
}
-
Image Replacer: This feature for avoid the double portrait when you roll Ability / Skills / Saving Throw / Tools, for now the support is limited to the following systems :
- Dnd5e system
- PF2
If you want to add your own system it's very simple!!! you can just give to me a map of strings key=value of label and image, for a live example check out what i have done for d&d5e with the english language here ImageReplacer. It's ugly but it's simple to integrated.
-
Disable the chat portrait if the alias of the chat message is from a GM: If enable every chat message done with a alias referenced to a GM will ot apply the chat portrait mechanism
-
Set up a specific image if the alias of the chat message is from a GM: If enable will use the image selected here for every chat message done with a alias referenced to a GM. If 'Disable the chat portrait if the alias of the chat message is from a GM' is enable this setting will be ignored
[ON DEVELOPING SO ANY SUGGESTION IS WELCOME]
-
Image Replacer Damage Types: Add some image for better identify the type of damage of the weapon, for now the support is limited to the following systems :
- Dnd5e system
- PF2
If you want to add your own system it's very simple!!! you can just give to me a map of strings key=value of label and image, for a live example check out what i have done for d&d5e with the english language here ImageReplacer. It's ugly but it's simple to integrated.
