StartFlow

StartFlow

New players often decide whether to stay on a server during their first few minutes. When they disconnect and never return, administrators are usually left without answers.

StartFlow guides newcomers through customizable onboarding steps and provides administrators with a clear funnel drop-off report showing exactly where players leave.

Why StartFlow?

• Identify Drop-Off Points: The /sf report command highlights completion percentages across every step, pointing out where newcomers get stuck.

• Automatic Step Tracking: Automatically monitors player actions including setting home with beds, selling items, trading with villagers, claiming land, placing chests, entering regions, and running commands.

• Idempotent Rewards: Grant rewards via console commands on step completion and guide finish. Protected by SQLite transactions against duplicate claims on server restart or reconnect.

• Zero Mandatory Dependencies: Runs natively on Paper 1.21.x. Soft dependencies (Vault, GriefPrevention, PlaceholderAPI) activate automatically when present.

• Native Multi-Language: Built-in translations for English, Turkish, German, Spanish, Russian, and Portuguese, served according to each player's client language.

  • English
  • Turkish
  • German
  • Spanish
  • Russian
  • Portuguese

Key Features

• Step Guide Menu (/guide): Clear chest GUI displaying active steps, descriptions, and practical hints.
• Funnel Analytics: View completion rates in chat, in an admin GUI, or export them directly to a CSV file.
• Ready-Made Templates: Instantly set up Survival, Skyblock, or Anarchy workflows with /sf template.
• Player Management: View, complete, or reset onboarding progress for online and cached offline players.
• Optional Login Rewards: Daily login streaks with milestone rewards (off by default).
• Optional Playtime Milestones: Configurable playtime milestones with automatic AFK protection (off by default).
• Optional Server Essentials: Rules acceptance gate, starter kit delivery, and custom join/quit broadcasts (off by default).
• Folia Support: Tested on Folia 1.21.11 alongside Paper.
• Update Checks & bStats: Integrated Modrinth version notifications and anonymous bStats metrics.

Quick Start

1. Install StartFlow-1.0.0.jar into your plugins/ directory and start your server.
2. Select and apply a starter template:
   • /sf template survival confirm
   • /sf template skyblock confirm
   • /sf template anarsi confirm
3. Test the onboarding flow in-game using /guide.
4. Adjust region coordinates and rewards in plugins/StartFlow/config.yml and run /sf reload.
5. Run /sf report to monitor player onboarding and track drop-off steps.

Commands & Permissions

Player (startflow.use)

• /guide (aliases: /rehber, /basla): Open the starter guide.
• /guide daily: View current login streak and claim status.
• /guide playtime: View tracked active playtime.
• /guide rules / /guide rules accept: View or accept server rules.
• /guide skip: Skip remaining guide steps.
• /guide reset: Reset personal guide progress.

Administrator (startflow.admin)

• /sf menu: Open the admin GUI menu.
• /sf report: View the drop-off funnel summary in chat.
• /sf report csv: Export the funnel report to a CSV file.
• /sf template <survival|skyblock|anarsi> [confirm]: Apply a starter template.
• /sf player <name> info: View completed steps for a player.
• /sf player <name> step <id>: Complete a specific step for a player.
• /sf player <name> reset [id]: Reset a player's steps.
• /sf player <name> reset-daily: Reset a player's daily streak.
• /sf player <name> reset-playtime: Reset a player's playtime milestones.
• /sf reload: Reload settings and language files.

PlaceholderAPI Placeholders

• %startflow_progress% - Steps completed ratio (e.g. 3/5)
• %startflow_progress_percent% - Completion percentage (e.g. 60)
• %startflow_step% - Current step name or Complete
• %startflow_completed% - Guide finished status (Yes / No)
• %startflow_bar% - MiniMessage formatted progress bar
• %startflow_streak% - Current daily streak count
• %startflow_best_streak% - Highest daily streak count
• %startflow_playtime% - Tracked active playtime (e.g. 1h 45m)
• %startflow_next_milestone% - Next milestone name or status

System Requirements

• Platform: Paper 1.21.x (or compatible fork)
• Runtime: Java 21 or newer
• Soft Dependencies: PlaceholderAPI, Vault, GriefPrevention
• License: StartFlow License (free to use, source available)

Support

StartFlow is developed and maintained by Clodo. Source and issues: https://github.com/clodonet/StartFlow Visit https://clodo.net for guides and support.