Chat Keywords
Quick sharing with automatic chat keyword replacement
Chat Keywords
Chat keywords allow players to quickly share content by typing special keywords in square brackets during normal chat conversation. These keywords are automatically replaced with clickable share links.
How It Works
When a player types a chat keyword in square brackets, Showcase automatically:
- Detects the keyword in the chat message
- Creates a temporary share of the specified content
- Replaces the keyword with a clickable link
- Preserves the rest of the chat message
Example: Typing Check out my [item]!
becomes Check out my
[🗡️ Diamond Sword]
!
where the item name is a clickable link.
Default Keywords
Item Keywords
[item]
- Share your currently held item[i]
- Short alias for[item]
Inventory Keywords
[inventory]
- Share your full inventory[inv]
- Short alias for[inventory]
[hotbar]
- Share only your hotbar[hb]
- Short alias for[hotbar]
Storage Keywords
[ender_chest]
- Share your ender chest contents[ec]
- Short alias for[ender_chest]
Statistics Keywords
[stats]
- Share your player statistics[stat]
- Short alias for[stats]
Container Keywords
[container]
- Share recently opened container[chest]
- Alias for[container]
Trading Keywords
[merchant]
- Share recently opened villager trades[villager]
- Alias for[merchant]
[trades]
- Alias for[merchant]
Most keywords have multiple aliases for convenience:
Primary Keyword | Aliases |
---|---|
[item] | [i] , [hand] , [held] |
[inventory] | [inv] , [items] |
[hotbar] | [hb] , [bar] |
[ender_chest] | [ec] , [enderchest] |
[stats] | [stat] , [statistics] |
[container] | [chest] , [box] |
[merchant] | [villager] , [trades] |
Usage Examples
Basic Usage
Simple keyword replacement:
Player: Look at my [item]!
Output: Look at my [🗡️ Diamond Sword]!
Player: My [inv] is full of diamonds!
Output: My [📦 Steve's Inventory] is full of diamonds!
Multiple Keywords
Use multiple keywords in one message:
Player: Compare my [item] with my [hotbar] setup!
Output: Compare my [🗡️ Diamond Sword] with my [📦 Steve's Hotbar] setup!
Mixed Content
Keywords work alongside normal chat:
Player: Hey @everyone check this [item] I found in the [chest] upstairs!
Output: Hey @everyone check this [⚔️ Netherite Sword] I found in the [📦 Double Chest] upstairs!
Advanced Features
Context-Aware Sharing
Keywords automatically adapt to your current situation:
Smart Detection:
[item]
only works if you're holding an item[container]
only works if you recently opened a container[merchant]
only works if you recently opened a villager interface
Permission Integration
Keywords respect the same permissions as manual commands:
showcase.chat.item
Use [item] keyword in chat
showcase.chat.inventory
Use [inventory] and [inv] keywords
showcase.chat.stats
Use [stats] and [stat] keywords
Failure Handling
When a keyword can't be processed:
- No Item Held:
[item]
keywords are ignored - No Recent Container:
[container]
keywords are ignored - No Permissions: Keywords are silently ignored
- Invalid Context: Keywords remain as plain text
Configuration
Enable/Disable Keywords
In config/showcase/config.yml
:
chatKeywords:
enabled: true
caseSensitive: false
# Individual keyword control
keywords:
item:
enabled: true
aliases: ["i", "hand", "held"]
inventory:
enabled: true
aliases: ["inv", "items"]
stats:
enabled: true
aliases: ["stat", "statistics"]
Custom Keywords
Add your own keywords:
chatKeywords:
keywords:
# Custom keyword for sharing ender chest
ec:
enabled: true
command: "enderchest"
aliases: ["enderchest", "ender"]
# Custom keyword for sharing with specific duration
quickitem:
enabled: true
command: "item"
duration: "5m"
aliases: ["qi"]
Default Durations
Set different durations for different keywords:
chatKeywords:
defaultDurations:
item: "10m"
inventory: "30m"
stats: "1h"
container: "20m"
Performance & Limits
Rate Limiting
To prevent spam, keywords have built-in rate limiting:
- Per-Player Limit: 5 keywords per minute by default
- Global Limit: Configurable server-wide limits
- Cooldown: Brief cooldown between identical keywords
Message Processing
Performance Notes:
- Keywords are processed after chat event
- Complex inventories may cause brief delays
- Large statistics take more time to generate
- Network lag affects link generation
Memory Management
- Keyword shares use same expiration as manual shares
- Automatic cleanup prevents memory buildup
- Failed keywords don't create database entries
Troubleshooting
Common Issues
Keywords Not Working
- Check if chat keywords are enabled in config
- Verify player has required permissions
- Ensure proper keyword syntax
[keyword]
- Check server logs for error messages
Keywords Ignored
- Make sure you're holding an item for
[item]
- Open a container recently for
[container]
- Check case sensitivity settings
- Verify keyword is properly spelled
Performance Issues
- Reduce keyword rate limits
- Increase share expiration times
- Monitor server resource usage
- Check for conflicting chat plugins
Debug Mode
Enable debug logging in config:
debug:
chatKeywords: true
logFailedKeywords: true
showProcessingTime: true
Best Practices
For Players
Player Tips:
- Use keywords naturally in conversation
- Don't spam keywords to avoid rate limits
- Check permissions before using advanced keywords
- Use descriptive context around keywords
For Server Admins
- Set Reasonable Limits: Balance functionality with performance
- Monitor Usage: Watch for keyword spam or abuse
- Configure Permissions: Grant appropriate access levels
- Regular Maintenance: Clean up expired shares periodically
Integration with Other Features
Keywords work seamlessly with:
- Manual Commands: Can be used alongside
/showcase
commands - Permissions: Same permission system as commands
- Multi-Language: Respects player language settings
- Statistics: Keyword usage tracked in mod statistics
Related Topics
- Player Commands - Manual sharing commands
- Configuration - Customize keyword behavior
- Permissions - Set up keyword permissions