Описание
# Showcase Mod
> The current description is for V2. For V1, please [click here](https://modrinth.com/mod/showcase/version/1.1.0+mc1.21.6).
A server-side Minecraft mod that allows players to share links in chat to showcase items, inventories, containers, villager trades, and statistics through commands or chat keywords.
📖 **[Complete Documentation](https://showcase-fabric.vercel.app)**
## ✨ Features
- **Comprehensive Sharing**: Items, inventories, containers, and villager trades
- **Server-Side**: No client installation required
- **Interactive Previews**: Auto-unpack containers, view books and maps
- **Multi-Language**: Support for 17+ languages
- **Persistent Storage**: Shares saved until expiration
- **Permission System**: LuckPerms integration
- **Configurable Chat Keywords**: Customizable trigger words for quick sharing
- **Statistics Tracking**: Player statistics with detailed categorization
- **Developer Placeholders**: PlaceholderAPI integration for other plugins
- **Chat Item Icons**: Customizable item icons in chat messages (Experimental)
About Chat Item Icons (Experimental)
Displays item icons in chat messages for shared items.
**Why Resource Pack?** As a server-side mod, we use Minecraft's custom font system to render icons.
**Setup**:
1. Generate resource pack at [IconifyCraft](https://iconifycraft.vercel.app/)
2. Host the pack on a web server
3. Enable in `config/showcase/config.yml`: `itemIcons.enabled = true`
4. Add to `server.properties`:
```properties
resource-pack=
resource-pack-sha1=
require-resource-pack=true
```
**Config Options**:
```yaml
itemIcons:
enabled: false # Enable/disable icons
fontNamespace: "iconifycraft" # Resource pack namespace
includeInItemNames: true # Show icons in item names
```
⚠Warning: Experimental feature. Current support for displaying blocks, including chests and ender chests, is incomplete.
## ⌨️ Commands
> 💡 **[View detailed command reference](https://showcase-fabric.vercel.app/docs/commands/player-commands)** with examples and permissions
### Player Commands
```
/showcase [player] [duration] [description]
```
**Types**: `item`, `inventory`, `hotbar`, `enderchest`, `container`, `merchant`, `stats`
**Duration formats**: `30s`, `5m`, `1h`, `1h30m` or raw seconds (e.g. `300`)
**Other Commands**:
- `/showcase cancel ` - Cancel your share
- `/showcase-view ` - View shared content
### Admin Commands
```
/admin-showcase [receiver] [duration] [description]
/showcase-manage [args]
```
**Actions**: `reload`, `list [page]`, `cancel `
### Chat Keywords
Players can type keywords in square brackets to quickly share content:
**Default Keywords** (configurable in `config.yml`):
- `[item]` or `[i]` - Share held item
- `[inventory]` or `[inv]` - Share inventory
- `[hotbar]` or `[hb]` - Share hotbar
- `[ender_chest]` or `[ec]` - Share ender chest
- `[stats]` or `[stat]` - Share statistics
Example: `Check out my [item]!` → automatically replaced with clickable share link
## 🔌 Developer API
> 🔗 **[Full API Documentation](https://showcase-fabric.vercel.app/docs/developers/api-overview)** - Integration guides and examples
### PlaceholdersAPI Integration
**Basic Sharing**:
```
%showcase:item% - Share held item
%showcase:inventory% - Share inventory
%showcase:hotbar% - Share hotbar
%showcase:ender_chest% - Share ender chest
%showcase:stats% - Share statistics
```
**Essential Statistics**:
```
%showcase:shares_count% - Number of active shares
%showcase:total_views% - Total views received
%showcase:can_share_item% - Permission check (true/false)
%showcase:has_admin_perms% - Admin check (true/false)
```
📚 **[View all placeholders](https://showcase-fabric.vercel.app/docs/developers/placeholderapi)**
## ⚙️ Configuration
> ⚙️ **[Configuration Reference](https://showcase-fabric.vercel.app/docs/configuration/config-file)** - Complete settings guide
Main configuration file: `config/showcase/config.yml` (YAML format)
**Key Settings**:
- Share cooldowns and permissions
- Chat keywords and triggers
- Statistics tracking options
- Performance optimization
- Multi-language support
📖 **[View example config](https://showcase-fabric.vercel.app/docs/configuration/config-file)** | 🔐 **[Permission setup](https://showcase-fabric.vercel.app/docs/configuration/permissions)**
## 📚 Documentation & Resources
- **[Complete Documentation](https://showcase-fabric.vercel.app)** - Full feature documentation
- **[Getting Started](https://showcase-fabric.vercel.app/docs/getting-started/installation)** - Installation and setup guide
- **[Command Reference](https://showcase-fabric.vercel.app/docs/commands/player-commands)** - All commands with examples
- **[Configuration Guide](https://showcase-fabric.vercel.app/docs/configuration/config-file)** - Settings and customization
- **[Developer API](https://showcase-fabric.vercel.app/docs/developers/api-overview)** - PlaceholderAPI integration
- **[FAQ & Troubleshooting](https://showcase-fabric.vercel.app/docs/support/faq)** - Common issues and solutions
## 📝 License
[MIT](./LICENSE)