S-Turorials

Overview

S-Tutorials is a simple plugin wich allows you to create Tutorials for your players.

Features

• Reload the plugin directly in-game
• Customizable messages
• Update-Checker (Automatically checks for updates on startup and when an admin joins.)
• Option to skip the tutorial.
• Alsways show progress in a BossBar.
• Automatically start a tutorial for new players.
• More features in development ...

Commands

• /s-tutorials about - Displays information about the plugin
• /s-tutorials reload - Reloads the plugin in-game
• /tutorial start - Start a tutorial
• /tutorial skip - Skip the current tutorial
• /tutorial startFor - Start a tutorial for a player
• /tutorial skipFor - Skip a tutorial for a player

Permissions

• sTutorials.admin.about
• sTutorials.admin.reload
• sTutorials.admin.update
• sTutorials.use
• sTutorials.start
• sTutorials.startFor
• sTutorials.skip
• sTutorials.skipFor

Configs

# This plugin utilizes MiniMessage for messages.
# For more information, visit https://docs.adventure.kyori.net/minimessage.html

file-version: 1

# The prefix before every message
prefix: "<#27D699><b>S-Tutorials</b> <dark_gray>⚡ <gray>"

# The messages file to use
langFile: 'english'

# Settings for the update checker
updateChecker:
  # Send a message to the console when a new version is available
  consoleMessage: true
  # Send a message to the player when a new version is available
  # This requires the permission 'sTutorials.admin.update' or to be an OP
  playerMessage: true

# The tutorial which is automatically started for new players
# Set to null to disable the auto tutorial
autoTutorial: 'newbie'

# Settings for the sound effects
sounds:
  startTutorial:
    # Enable sound effect for starting a tutorial
    enabled: true
    # The sound to play when a tutorial is started
    sound: 'minecraft:entity.player.levelup'
    # The volume of the sound
    volume: 1.0
    # The pitch of the sound
    pitch: 1.0
  skipTutorial:
    enabled: true
    sound: 'minecraft:block.anvil.place'
    volume: 1.0
    pitch: 1.0
  nextStep:
    enabled: true
    sound: 'minecraft:entity.experience_orb.pickup'
    volume: 1.0
    pitch: 1.0
  completeTutorial:
    enabled: true
    sound: 'minecraft:entity.player.levelup'
    volume: 1.0
    pitch: 1.0

bossBar:
  # Enable the boss bar feature
  enabled: true
  # The color of the boss bar
  # Available colors: PINK, BLUE, RED, GREEN, YELLOW, PURPLE
  color: WHITE
  # The loading title for the boss bar
  loadingTitle: "<gray>Loading tutorial steps..."

# This plugin utilizes MiniMessage for messages.
# For more information, visit https://docs.adventure.kyori.net/minimessage.html

file-version: 1

# General messages
general:
  noPlayer: "<gray>You <red>must be a player<gray> to execute this command!"
  noPerms: "<gray>You <red>do not have permission<gray> to execute this command!"
  playerNotFound: "<gray>Player <white>%player% <red>not found<gray>!"

# Other messages
other:
  updateChecker: "<gray>An <yellow>update <gray>is available! You are using version <red>v%current-version%<gray>, the latest version is <green>%latest-version%<gray>!"

# Command messages
commands:
  # Messages for the /sTutorials command (main plugin command)
  stutorials:
    usage: "<gray>Please use <red>/sTutorials <about/reload><gray>!"
    about: "<gray>S-Tutorials v%version% <dark_gray>- <gray>%author%"
    reload:
      reloading: "<yellow>Reloading <gray>S-Tutorials..."
      reloaded: "<green>Successfully reloaded <gray>S-Tutorials! <dark_gray>(%time%ms)"
      error: "<gray>An <red>error occurred <gray>while reloading S-Tutorials! Check the console for details."
  tutorial:
    usage: "<gray>Please use <red>/tutorial <start/skip/startFor/skipFor> <?player><gray>!"
    start:
      tutorialNotFound: "<gray>Tutorial <red>%tutorial% <gray>not found!"
      startedFor: "<gray>Tutorial <white>%tutorial% <gray>has been started for player <white>%player%<gray>!"
      started: "<gray>Tutorial <white>%tutorial% <gray>has been started!"
      alreadyStartedFor: "<gray>Player <white>%player%<gray> has already started a tutorial<gray>!"
      alreadyStarted: "<gray>You have already started a tutorial!"
    skip:
      skippedFor: "<gray>Tutorial has been skipped for player <white>%player%<gray>!"
      skipped: "<gray>Tutorial has been skipped!"
      notStartedFor: "<gray>Player <white>%player%<gray> has not started a tutorial yet!"
      notStarted: "<gray>You have not started the a tutorial yet!"

events:
  tutorialCompleted: "<gray>You have completed the tutorial <white>%tutorial%<gray>! <yellow><b>Congratulations!</b>"
  nextStep: "<yellow>Next step: <white>%step_title% <dark_gray>- <gray>%step_description%"
  coordinatesWorldNotFound: "<gray>World <red>%world% <gray>not found! Please check the coordinates."

# Dieses Plugin verwendet MiniMessage für Nachrichten.
# Weitere Informationen findest du unter https://docs.adventure.kyori.net/minimessage.html

file-version: 1

# Generelle Nachrichten
general:
  noPlayer: "<gray>Dies können <red>nur Spieler<gray> ausführen!"
  noPerms: "<gray>Du hast <red>keine Berechtigung<gray> für diesen Befehl!"
  playerNotFound: "<gray>Der Spieler <white>%player% <gray>konnte <red>nicht gefunden <gray>werden!"

# Other messages
other:
  updateChecker: "<gray>Es ist ein <yellow>Update verfügbar<gray>! Die momentane Version ist die <red>v%current-version%<gray>, die neuste Version ist die <green>%latest-version%<gray>!"

# Befehlsnachrichten
commands:
  # Nachrichten für den /sTutorials Befehl (Hauptbefehl des Plugins)
  stutorials:
    usage: "<gray>Bitte nutze <red>/stimber <about/reload><gray>!"
    about: "<gray>S-Tutorials v%version% <dark_gray>- <gray>%author%"
    reload:
      reloading: "<yellow>S-Tutorials <gray>wird neugeladen<gray>..."
      reloaded: "<green>S-Tutorials wurde <gray>erfolgreich neugeladen! <dark_gray>(%time%ms)"
      error: "<gray>Ein <red>Fehler ist aufgetreten<gray> beim Neuladen von S-Tutorials! Überprüfe die Konsole für Details."
  tutorial:
    usage: "<gray>Bitte nutze <red>/tutorial <start/skip/startFor/skipFor> <?Spieler> <?Tutorial><gray>!"
    start:
      tutorialNotFount: "<gray>Das Tutorial <red>%tutorial% <gray>wurde <red>nicht gefunden<gray>!"
      startedFor: "<gray>Das Tutorial <white>%tutorial% <gray>wurde für den Spieler <white>%player% <gray>gestartet!"
      started: "<gray>Das Tutorial <white>%tutorial% <gray>wurde gestartet!"
      alreadyStartedFor: "<gray>Der Spieler <white>%player%<gray> hat <red>bereits ein Tutorial gestartet<gray>!"
      alreadyStarted: "<gray>Du hast <red>bereits ein Tutorial gestartet<gray>!"
    skip:
      skippedFor: "<gray>Das Tutorial wurde für den Spieler <white>%player% <gray>übersprungen!"
      skipped: "<gray>Du hast das Tutorial übersprungen!"
      notStartedFor: "<gray>Der Spieler <white>%player%<gray> hat <red>kein Tutorial <gray>gestartet!"
      notStarted: "<gray>Du hast <red>kein Tutorial <gray>gestartet!"

events:
  tutorialCompleted: "<gray>Du hast das Tutorial <white>%tutorial%<gray> abgeschlossen! <yellow><b>Herzlichen Glückwunsch!</b>"
  nextStep: "<yellow>Nächster Schritt: <white>%step_title% <dark_gray>- <gray>%step_description%"
  coordinatesWorldNotFound: "<gray>Die Welt <red>%world% <gray>wurde nicht gefunden! Bitte überprüfe die Koordinaten."

Contact

If you encounter any issues or bugs, or have a request for a new feature, please contact me via Discord or join my Discord-Server.

My discord-name is Losterixx.

My Discord-Server: Link