Detailed Documentation
Configuration Guide
Task Configuration:
Code (YAML):
tasks:
playtime_task:
enabled
: true
required_value
: 60
# 60 minutes
reward_commands
:
-
"give %inviter% diamond 3"
-
"eco give %inviter% 1000"
message
:
"&a%invited% played for 1 hour! %inviter% earned reward."
placeholder
:
"%nitinvite_playtime_%invited%"
custom_placeholder
: true
Database Configuration:
Code (YAML):
database:
storage_type
:
"flatfile"
# or "mysql", "redis"
mysql:
enabled
: false
host
:
"localhost"
port
: 3306
database
:
"nitinvite"
username
:
"root"
password
:
"password"
Message Configuration:
Code (YAML):
messages:
prefix
:
"&8[&bNitInvite&8] &r"
invite_code_created
:
"&aYour invitation code: &e%code%"
invite_code_success
:
"&aSuccessfully invited!"
PlaceholderAPI Usage
Core Placeholders:
• %nitinvite_invites% - Total invitation count
• %nitinvite_invite_code% - Player's invitation code
• %nitinvite_completed_tasks% - Completed task count
• %nitinvite_pending_rewards% - Pending reward count
Task Placeholders:
• %nitinvite_task_1_<player>% - Task 1 value for specific player
• %nitinvite_task_2_<player>% - Task 2 value for specific player
Leaderboard Placeholders:
• %nitinvite_liderlik_1_oyuncu% - 1st place player name
• %nitinvite_liderlik_1_davet% - 1st place player's invite count
Advanced Use Cases
VIP System Integration:
Code (YAML):
tasks:
vip_requirement:
enabled
: true
required_value
: 10
reward_commands
:
-
"lp user %inviter% permission set vip"
-
"eco give %inviter% 5000"
message
:
"&a%inviter% became VIP! Completed 10 invites."
Seasonal Events:
Code (YAML):
tasks:
seasonal_event:
enabled
: true
required_value
: 50
reward_commands
:
-
"give %inviter% netherite_ingot 5"
-
"eco give %inviter% 10000"
message
:
"&a%inviter% completed seasonal task!"
Permissions
•
nitinvite.use - Basic usage permission (default: true)
•
nitinvite.admin - Admin commands (default: op)
️ Troubleshooting
Common Issues:
1. Plugin not loading: Check Java version (requires Java 8+)
2. Placeholders not working: Install PlaceholderAPI
3. Database connection failed: Plugin automatically falls back to flatfile
4. Commands not working: Check permissions in config.yml
Performance Tips:
• Use flatfile for single servers
• Use MySQL for multi-server networks
• Use Redis for high-performance caching
• Set appropriate save intervals
Monitoring:
• Check server logs for any errors
• Monitor database performance
• Track invitation statistics through placeholders
• Use debug mode during development
Quick Start Guide
Step 1: Download and install NitInvite.jar
Step 2: Start your server to generate config.yml
Step 3: Configure your tasks in plugins/NitInvite/config.yml
Step 4: Players can start using /davet to create invitation codes
Step 5: New players use /davet <code> to join with invitation
Step 6: Monitor progress and rewards through placeholders
Pro Tips
• Start with simple tasks like playtime before adding complex requirements
• Use placeholders in scoreboard or chat plugins to display progress
• Set up automatic rewards for VIP ranks or special permissions
• Create seasonal events with limited-time tasks
• Monitor your server's growth through invitation statistics
Performance Optimization
For Small Servers (1-50 players):
• Use flatfile storage
• Set save_interval to 10 minutes
• Keep debug mode off
For Medium Servers (50-200 players):
• Consider MySQL for better performance
• Set save_interval to 5 minutes
• Monitor database connections
For Large Networks (200+ players):
• Use Redis for caching
• Set save_interval to 2 minutes
• Monitor server resources closely
Analytics & Monitoring
Key Metrics to Track:
• Total invitations per day/week
• Task completion rates
• Most popular invitation codes
• Player retention after invitation
Placeholder Examples for Scoreboards:
Code (Text):
%nitinvite_invites% - Show total invites
%nitinvite_completed_tasks% - Show completed tasks
%nitinvite_liderlik_1_oyuncu% - Show top inviter
Advanced Configuration
Custom Task Example:
Code (YAML):
tasks:
custom_achievement:
enabled
: true
required_value
: 100
reward_commands
:
-
"give %inviter% netherite_sword 1"
-
"eco give %inviter% 5000"
-
"broadcast &a%inviter% earned custom achievement!"
message
:
"&a%invited% completed custom achievement! %inviter% earned reward."
placeholder
:
"%nitinvite_custom_%invited%"
custom_placeholder
: true
description
:
"Custom achievement task"
Multi-Server Setup:
Code (YAML):
database:
storage_type
:
"mysql"
mysql:
enabled
: true
host
:
"your-mysql-server.com"
port
: 3306
database
:
"nitinvite"
username
:
"nitinvite_user"
password
:
"secure_password"
connection_pool_size
: 10
connection_timeout
: 30
Success Stories
Server Growth Examples:
• Survival server increased player count by 300% in 3 months
• Minigame network saw 500% increase in daily active players
• Faction server achieved 1000+ concurrent players through referrals
Best Practices:
• Offer valuable rewards for completing tasks
• Create engaging task requirements
• Promote the invitation system actively
• Monitor and adjust rewards based on player feedback
• Use seasonal events to boost engagement
Ready to Grow Your Server?
NitInvite is the ultimate solution for server growth through player referrals. With its flexible task system, comprehensive placeholder support, and multi-database architecture, it's designed to scale with your server's success.
Download NitInvite today and start growing your Minecraft community! ✨