🧊 IceReferrals

Turn your community into your best marketing team.

IceReferrals is a powerful referral system that lets every player generate their own unique server address (subdomain) to invite friends. Whenever someone joins through a player's custom IP, the invitation is automatically tracked and rewards can be granted based on configurable milestones.

Whether you run a small SMP or a large Velocity network, IceReferrals makes growing your player base simple, automatic, and rewarding.

---

✨ Features

🌐 Custom Referral IPs

Every player receives their own unique subdomain (e.g. notch.example.net) that they can share with friends.

🎁 Automatic Rewards

Reward players for successfully inviting new members. Configure milestones, commands, permissions, items, money, or anything else your server supports.

⚡ Velocity Network Support

Built with Velocity in mind. Track referrals across your entire network with secure backend synchronization.

📊 Referral Statistics

Players can easily view:

• Total referrals
• Active referrals
• Pending rewards
• Claimed rewards
• Personal referral IP

🖥️ Clean In-Game GUI

A modern and easy-to-use interface lets players manage everything without complicated commands.

🔒 Secure Token Authentication

Velocity and backend servers communicate using secure authentication tokens to prevent unauthorized connections.

🚀 Lightweight & Fast

Designed for high performance with minimal resource usage.

---

🛠️ Installation

1️⃣ Configure Wildcard DNS (Required)

For custom referral subdomains to work correctly, create a wildcard DNS record.

Example (Cloudflare):

Type: A
Name: *
Content: <Your Server IP>
Proxy Status: DNS Only (Gray Cloud)

Important: Do not enable Cloudflare Proxy. The wildcard record must remain DNS Only.

---

2️⃣ Standalone Server (Paper/Spigot)

1. Place IceReferrals.jar inside your plugins folder.
2. Start or restart the server.
3. Configuration files will be generated automatically.
4. You're ready to go!

Players can now use:

/referral

---

3️⃣ Velocity Network Setup

If you're using Velocity, install the plugin on both the proxy and backend server.

Backend Server

• Place IceReferrals.jar inside the backend plugins folder.
• Start the server.
• Open:

plugins/IceReferrals/token.yml

• Copy the generated token.

Velocity Proxy

• Place IceReferrals.jar inside the Velocity plugins folder.
• Open:

plugins/IceReferrals/config.yml

• Paste the copied token into:

token: your-generated-token

Restart both the proxy and backend server.

Your referral tracking is now synchronized across the entire network.

---

🎮 Commands

| Command | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------ |
| /referral | Opens the referral menu where players can generate their personal referral IP, view statistics, and claim rewards. |

---

💡 How It Works

1. A player runs /referral.
2. They receive a unique referral address.
3. They share it with friends.
4. New players join using that address.
5. IceReferrals automatically records the referral.
6. The inviter progresses toward configurable reward milestones.

Simple for players. Powerful for server owners.

---

❤️ Perfect For

• SMP Servers
• Survival Networks
• Lifesteal Servers
• Skyblock
• Prison
• Minigame Networks
• Velocity Networks
• BungeeCord Replacements
• Growing Communities

---

Grow your server naturally by rewarding the players who help build your community.