Skip to content

Commit 0190e57

Browse files
1.2.5 Update OMG :D
1 parent d4e4b42 commit 0190e57

38 files changed

+1421
-15
lines changed

CURSEFORGE_DESCRIPTION.md

Lines changed: 240 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,240 @@
1+
# WelcomeMessages v1.2.5
2+
3+
> **CurseForge Compatible** - This description is optimized for CurseForge's markdown renderer
4+
5+
<div align="center">
6+
7+
![WelcomeMessages Logo](https://img.shields.io/badge/WelcomeMessages-v1.2.5-blue?style=for-the-badge)
8+
9+
**The Ultimate Welcome Plugin for Minecraft Servers**
10+
11+
*Clean, lightweight, and packed with features that actually work!*
12+
13+
[![Minecraft Version](https://img.shields.io/badge/Minecraft-1.21.x-green?style=flat-square)](https://minecraft.net)
14+
[![Java Version](https://img.shields.io/badge/Java-21-orange?style=flat-square)](https://openjdk.java.net)
15+
[![Spigot Compatible](https://img.shields.io/badge/Spigot-Compatible-yellow?style=flat-square)](https://spigotmc.org)
16+
[![Paper Compatible](https://img.shields.io/badge/Paper-Compatible-red?style=flat-square)](https://papermc.io)
17+
18+
</div>
19+
20+
---
21+
22+
## 🎉 What's New in v1.2.5
23+
24+
### **12 Amazing Text Animations**
25+
WelcomeMessages now includes a complete animation system with 12 different effects:
26+
27+
- **Typing** - Character-by-character reveal with perfect color handling
28+
- **Typewriter** - Classic typewriter effect with blinking cursor
29+
- **Fade** - Smooth fade-in effect with opacity changes
30+
- **Slide** - Text slides in from the side
31+
- **Wave** - Text waves up and down like ocean waves
32+
- **Rainbow** - Colors cycle through rainbow spectrum
33+
- **Glitch** - Random characters appear and disappear
34+
- **Bounce** - Text bounces up and down with varying heights
35+
- **Shake** - Text shakes left and right randomly
36+
- **Pulse** - Text pulses in brightness (bright → yellow → gray)
37+
- **Matrix** - Matrix-style falling characters with green color
38+
- **Scramble** - Text scrambles with random characters, then reveals correctly
39+
40+
### 🎯 **Action Bar Display**
41+
- Animations are **private to the target player** (no chat spam!)
42+
- Configurable duration for each animation
43+
- Different animations for join, quit, and first-join messages
44+
- Perfect color code preservation
45+
- Smooth performance optimization
46+
47+
### 🛠️ **Bug Fixes & Improvements**
48+
- **FIXED:** Typing animations now work perfectly with color codes
49+
- **FIXED:** Typewriter animation with proper blinking cursor
50+
- **FIXED:** All linter errors and warnings (zero errors!)
51+
- **IMPROVED:** Performance and compatibility across all server types
52+
53+
---
54+
55+
## 🚀 Key Features
56+
57+
### 🎨 **Visual Excellence**
58+
- **RGB & Gradient Support** - Modern color codes and rainbow text
59+
- **12 Text Animations** - Make your messages truly special
60+
- **Custom Rank System** - Unlimited custom ranks with any names
61+
- **Smart Effects** - Particles, sounds, titles, fireworks (all optional)
62+
63+
### 🔧 **Admin-Friendly**
64+
- **Config Validation** - Won't crash your server with bad settings
65+
- **PlaceholderAPI Support** - 13+ placeholders for other plugins
66+
- **Full Spigot/Paper Compatibility** - Works on both server types
67+
- **Async Performance** - Your TPS will thank you
68+
- **Smart Caching** - Optimized for server performance
69+
70+
### 👥 **Player Experience**
71+
- **Personal Toggle** - Players can turn messages on/off
72+
- **Join Counter** - Tracks player visits and saves data
73+
- **First Join Detection** - Special messages for new players
74+
- **Rank-Based Messages** - VIPs get VIP treatment
75+
- **Private Animations** - No chat spam, just beautiful effects
76+
77+
---
78+
79+
## 📋 Commands
80+
81+
| Command | Description | Permission |
82+
|---------|-------------|------------|
83+
| `/welcome` | Show help menu | `welcome.use` |
84+
| `/welcome reload` | Reload configuration | `welcome.reload` |
85+
| `/welcome test` | Preview your join message | `welcome.test` |
86+
| `/welcome testall` | Test all features including animations | `welcome.testall` |
87+
| `/welcome testanim <type> [player]` | Test specific animation types | `welcome.testanim` |
88+
| `/welcome toggle` | Turn your messages on/off | `welcome.toggle` |
89+
| `/welcome stats [player]` | Check join count statistics | `welcome.stats` |
90+
| `/welcome reset [player]` | Reset player data | `welcome.reset` |
91+
| `/welcome version` | Show plugin version | `welcome.use` |
92+
93+
---
94+
95+
## 🎮 Animation Testing
96+
97+
Test all the amazing animations with these commands:
98+
99+
```bash
100+
# Test all features including animations
101+
/welcome testall
102+
103+
# Test specific animation types
104+
/welcome testanim typing # Character-by-character reveal
105+
/welcome testanim typewriter # Typewriter with blinking cursor
106+
/welcome testanim bounce # Bouncy text effect
107+
/welcome testanim matrix # Matrix-style falling characters
108+
/welcome testanim scramble # Scramble and reveal effect
109+
# ... and 7 more animation types!
110+
```
111+
112+
---
113+
114+
## ⚙️ Configuration
115+
116+
### Animation Settings
117+
```yaml
118+
animations:
119+
enabled: true
120+
default-duration: 60
121+
default-type: "typing"
122+
use-action-bar: true
123+
show-final-in-chat: true
124+
125+
join:
126+
enabled: false # Disabled by default to prevent chat spam
127+
type: "typing"
128+
duration: 60
129+
quit:
130+
enabled: false # Disabled by default to prevent chat spam
131+
type: "fade"
132+
duration: 40
133+
first-join:
134+
enabled: true # First join animations are special
135+
type: "rainbow"
136+
duration: 80
137+
```
138+
139+
### Custom Rank System
140+
```yaml
141+
custom-ranks:
142+
enabled: true
143+
ranks:
144+
- "owner" # Server owner
145+
- "admin" # Administrator
146+
- "moderator" # Moderator
147+
- "mvp" # MVP rank
148+
- "vip" # VIP rank
149+
- "premium" # Premium rank
150+
- "donator" # Donator rank
151+
- "member" # Member rank
152+
```
153+
154+
---
155+
156+
## 🔗 PlaceholderAPI Support
157+
158+
If you have PlaceholderAPI installed, you can use these placeholders:
159+
160+
| Placeholder | Description |
161+
|-------------|-------------|
162+
| `%welcome_join_count%` | Player's join count |
163+
| `%welcome_first_join%` | Whether it's player's first join |
164+
| `%welcome_messages_disabled%` | Whether player has messages disabled |
165+
| `%welcome_last_seen%` | Time since player was last seen |
166+
| `%welcome_first_join_time%` | When player first joined |
167+
| `%welcome_time_since_last_seen%` | Time since last seen |
168+
| `%welcome_time_since_first_join%` | Time since first join |
169+
| `%welcome_total_unique_joins%` | Total unique players who joined |
170+
| `%welcome_join_ordinal%` | Player's join order (1st, 2nd, etc.) |
171+
| `%welcome_player_ordinal%` | Player's current position |
172+
| `%welcome_status%` | Player status (New/Returning) |
173+
| `%welcome_rank%` | Player's highest rank |
174+
| `%welcome_time_greeting%` | Time-based greeting |
175+
| `%welcome_server_uptime%` | Server uptime |
176+
177+
---
178+
179+
## 📊 Performance
180+
181+
- **Async Everything** - Your TPS will thank you
182+
- **Smart Caching** - Not the dumb kind
183+
- **Optional Metrics** - Off by default for privacy
184+
- **Works on Potato Servers** - Optimized for all server sizes
185+
- **Zero Linter Errors** - Perfect code quality
186+
187+
---
188+
189+
## 🛡️ Compatibility
190+
191+
- **Minecraft:** 1.21.x
192+
- **Java:** 21 (required by Minecraft)
193+
- **Server Software:** Spigot, Paper, Purpur, Pufferfish
194+
- **Permission Plugins:** LuckPerms, PEX, GroupManager, etc.
195+
- **Other Plugins:** PlaceholderAPI, bStats
196+
197+
---
198+
199+
## 📥 Installation
200+
201+
1. Download the `WelcomeMessages-1.2.5.jar` file
202+
2. Place it in your server's `/plugins` folder
203+
3. Restart your server
204+
4. Edit the configuration files to your liking
205+
5. Enjoy your new welcome system!
206+
207+
---
208+
209+
## 🎯 Why Choose WelcomeMessages?
210+
211+
- **No Bloat** - Does one thing and does it well
212+
- **No Premium Features** - Everything is included
213+
- **Actually Works** - No crashes, no broken updates
214+
- **Modern Features** - RGB colors, animations, PlaceholderAPI
215+
- **Admin Friendly** - Config validation, easy setup
216+
- **Player Friendly** - Personal toggles, beautiful effects
217+
- **Performance Focused** - Async, caching, optimization
218+
- **Community Driven** - Open source, active development
219+
220+
---
221+
222+
## 🐛 Support & Feedback
223+
224+
- **GitHub Issues:** Report bugs and request features
225+
- **Discord:** Join our community for support
226+
- **Wiki:** Comprehensive documentation available
227+
- **Updates:** Regular updates with new features and fixes
228+
229+
---
230+
231+
<div align="center">
232+
233+
**Made with ❤️ by FiveDollaGobby**
234+
235+
*The welcome plugin that actually works!*
236+
237+
[![GitHub](https://img.shields.io/badge/GitHub-Repository-black?style=for-the-badge&logo=github)](https://github.com/FiveDollaGobby/WelcomeMessages)
238+
[![Download](https://img.shields.io/badge/Download-Latest-green?style=for-the-badge)](https://github.com/FiveDollaGobby/WelcomeMessages/releases)
239+
240+
</div>

0 commit comments

Comments
 (0)