MYTHICGHOULPLUGIN FORGE
Home / Resources / WelcomePlayer
WelcomePlayer icon
Server Exclusive

WelcomePlayer

Reward genuine welcomes and support a simple new-player referral loop.

Server exclusive
—Spigot downloads
—Modrinth downloads
Private buildRelease status
1.1Current version
—Last public update

Full overview

Reward genuine welcomes and support a simple new-player referral loop.

WelcomePlayer rewards the social actions that help a server feel alive. When someone joins, other players have a short opportunity to send an accepted welcome phrase and receive a reward.

A separate referral flow lets eligible new players credit the person who invited them.

Best suited toCommunity servers that want onboarding and positive chat behaviour to have a meaningful reward loop.

How it works

Open a welcome window, detect valid greetings and prevent duplicate claims

Join listeners classify the player and open the configured welcome window. Chat listeners validate greeting phrases, cooldowns and duplicate protections before dispatching rewards.

The referral command verifies playtime eligibility, previous claims and self-referral rules before rewarding both accounts.

Administration

Configuration and live-server use

Commands, permissions, configuration files and architecture are documented below from the supplied project.

CompatibilityPaper/Spigot 1.21+IntegrationsEconomy reward commandsVersion1.1

Feature breakdown

Everything included in WelcomePlayer

Feature coverage is backed by the supplied project source.

✓

Welcome detection

Implemented by the supplied source project and expanded in the source reference below.

✓

New and returning rewards

Implemented by the supplied source project and expanded in the source reference below.

✓

Duplicate protection

Implemented by the supplied source project and expanded in the source reference below.

✓

Time window and cooldown

Implemented by the supplied source project and expanded in the source reference below.

✓

Referral claims

Implemented by the supplied source project and expanded in the source reference below.

✓

Command rewards

Implemented by the supplied source project and expanded in the source reference below.

Getting started

Installation and rollout

Review the source-verified reference before production deployment.

  1. 1

    Configure welcome timing and phrase lists.

  2. 2

    Set first-time and returning reward commands.

  3. 3

    Configure referral eligibility and rewards.

  4. 4

    Use /wp reload after changes.

Source-verified reference

Checked against WelcomePlayer 1.1

This static reference is built from the supplied plugin.yml, YAML resources and Java source. No browser-generated documentation is used.

Main classme.Ghoul.WelcomePlayer.MainAPI version1.21Java classes8 Hard dependenciesNoneSoft dependenciesNoneLoad beforeNone

Commands

2 declared commands

Aliases, usage and permissions come directly from plugin.yml.

/

/wp

WelcomePlayer main command

Usage: /wp reload · Permission: None declared

/

/referral

Claim a referral reward

Usage: /referral <player> · Permission: None declared

Permissions

1 declared permission node

Defaults and descriptions come directly from plugin.yml.

✓

welcomeplayer.admin

Allows reloading WelcomePlayer

Default: op

Configuration reference

1 bundled YAML file

Top-level sections and defaults are summarised from the supplied resources.

⚙

config.yml

  • Settings — 3 nested settings: Welcome-Time-Window-Seconds, Greeter-Cooldown-Seconds, Require-Player-Name
  • Messages — 10 nested settings: Prefix, Rewarded, Already-Rewarded, No-Self-Welcome, Success, Referrer-Rewarded, Already-Referred…
  • Referral — 5 nested settings: Enabled, Only-New-Players, New-Player-Max-Playtime-Minutes, Prevent-Self-Referral, Rewards
  • Rewards — 2 nested settings: Returning-Player, First-Time-Player
  • Words — 2 nested settings: Returning, First-Time

Source architecture

8 Java classes across 2 packages

me.Ghoul.WelcomePlayer (5), ReferralSystem (3)

◆

Core systems

ReferralData, Main, Rewards

◆

Commands

ReferralCommand, WelcomeCommand

◆

Listeners & events

ChatListener, JoinListener

◆

Managers & services

ReferralManager

Tokens & placeholders

Text tokens found in the source

Availability depends on the feature that references each token.

%amount%%greeter%%player%%referred_player%%referred_uuid%%referrer%%uuid%%welcomed%

Related projects

Continue exploring