Server Tutorial Plus 1.23.4

Introduce players to your server with unlimited tutorials! Many customisations! Free!

  1. MartenM
    Native Minecraft Version:
    Legacy (< 1.13)
    Tested Minecraft Versions:
    • 1.9
    • 1.10
    • 1.11
    • 1.12
    • 1.13
    • 1.14
    • 1.15
    • 1.16
    • 1.17
    • 1.18
    Source Code:
    https://github.com/MartenM/ServerTutorialPlus
    [​IMG]
    [​IMG][​IMG]

    The plugin to introduce new players to your server with unlimited tutorials!

    [​IMG]
    • Create unlimited custom server tutorials.
    • Unlimited points per tutorial.
    • Unique settings for every tutorial point.
    • Give players a reward for completing the tutorial first time. (MySql supported)
    • Start a tutorial when a player joins for the first time.
    • Start a tutorial when right clicking a block.
    • Start a tutorial when right clicking an NPC.
    • In game editor (commands)
    • Stats for every tutorial.
    • Permissions per tutorial possible.
    • Block commands while in a tutorial.
    • Easy to use.
    • Lightweight. No tasks running on the background.
    • Supports the PlaceholderAPI
    Options per point
    • Send a title
    • Send a chat message
    • Send an action bar message
    • Play a sound
    • Set a players fly mode
    • Lock a player
    • Execute a command
    • Spawn fireworks
    • Add potioneffects
    • And more!
    Supported placeholders without the PlaceholderAPI: {player_name}

    Point types:
    • Timed - Proceed after a set time interval.
    • Check point - Proceed after walking into the checkpoint.
    • Click block - Proceed after clicking a block (can be a sign).
    • Command point - Proceed after the player executes the command /st next. Useful if you want other plugins to perform actions on a certain point.
    All these points offer custom settings as well to make them more unique.

    [​IMG]
    Tutorial / showcase video


    Tutorial by Soulstriker


    Tutorial by BrandsPickled


    English


    Spanish
    This showcase lacks new features that have been added!

    [​IMG]
    //Command permissions
    servertutorialplus.command.help
    servertutorialplus.command.create
    servertutorialplus.command.remove
    servertutorialplus.command.addpoint
    servertutorialplus.command.removepoint
    servertutorialplus.command.play
    servertutorialplus.command.player
    servertutorialplus.command.quit
    servertutorialplus.command.playpoint
    servertutorialplus.command.setblock
    servertutorialplus.command.edit
    servertutorialplus.command.npc
    servertutorialplus.command.info
    servertutorialplus.command.reload
    servertutorialplus.command.save

    //Action permissions
    servertutorial.action.removeblock


    //Permissions for tutorials
    servertutorialplus.tutorials.<Server tutorial id here>
    servertutorial.tutorial.bypass - Allows to bypass any restrictions (like blocked commands).

    [​IMG]
    /st help - Shows a help with all the commands (that you have permission for).
    /st create <id> - Create a new server tutorial.
    /st remove <id> - Remove a server tutorial.
    /st addpoint <id> - Add a point to a tutorial.
    /st removepoint <id> <point index> - Remove a point from a tutorial.
    /st info <optional: id> - Show a list of all the server tutorials or info about a specific one.
    /st gui - Show GUI to see all the servertutorials and points.
    /st player <username> - Shows stats of a player in chat.
    /st play <id> (playername) - Play a server tutorial. (Playername is optional)
    /st quit - Quit your current tutorial
    /st playpoint <id> <point> - Play only 1 point of a server tutorial.
    /st setblock <id> - Set a interactive block that starts a tutorial when clicked.
    /st reload - Reload the plugin from the configs. (without saving first!)
    /st save - Save the current data to the configs. (without loading first!)
    /st npc <add/remove/bind/text/height> <value>
    /st edit <id> <invisible/rewards/permission/
    blockcommands/commands/chatblock> - Set settings for a tutorial as whole.
    /st editpoint <id> <point> <args> - Edit all the points at once.
    /st editpoint <id> <point> <args>

    Default args: (Applied to every point)
    time <seconds>
    Sets for how long it takes untill the next point.

    fly <true / false>
    Set fly mode to true or false.

    lockplayer <true / false>
    Prevent the player from moving.

    lockview <true / false>
    Lock the players view.

    messages <add / remove / list / clear>
    Add and remove chat messages for a point.

    commands <add / remove / list / clear>
    Add and remove commands that get executed as soon as the point is played.
    [!] NOTE: Commands should be entered without the / !

    actionbar <set / clear>
    Set a new action bar that gets played at the point or reset the current one.

    firework (Hold a firework in your hand)
    Spawns a firework at the location you stood when adding it when the point is played.

    location
    Sets your current location as the new location for the point.

    title <title / subtitle / fadein / fadeout / stay / reset>
    Set a title or subtitle to play on a point.

    sound <set / clear> (set args: <sound> <volume> <pitch>)
    Set a sound that is played on the point.
    You can find a list of all sounds here.


    potion <add / remove / list / clear>

    Adds a potion effect to the player.
    If the user holds a potion that potion effect will be added.
    Otherwise the args are like this: <potioneffect> <time (in S)> <level>

    switch <point index>
    Switch the point with the point given.

    infront <point index>
    Move a point infront of an other one.

    Optional args: (only applied to specific points)
    Checkpoint:
    distance <value (blocks)>
    The minimal amount of distance between the checkpoint and the player before completing it.


    repeatActionbar <true/false>
    If enabled, the actionbar will stay. Usefull for keeping the hint to move to the checkpoint.

    colour <red> <green> <blue>
    The colour for the checkpoint.
    [TIP]: When using values higher then 255 it will start randomizing!

    ClickBlock point:

    colour <red> <green> <blue>
    The colour for the checkpoint.
    [TIP]: When using values higher then 255 it will start randomizing!

    setblock
    Allows you to set the block.


    repeatActionbar <true/false>
    If particles should be displayed.

    teleport <true/false>
    If the player should be teleported to the point.

    [​IMG]
    Server Tutorial Plus offers a small but useful API for developers.
    For more info about the API, expand this spoiler:

    ServerTutorialApi
    Code (Text):

    public class ServerTutorialApi {
        /**
        * Starts a server tutorial for the defined player.
        * Returns true if the tutorial has been started. False in all other cases
        * @param id     Id of the server tutorial.
        * @param player The player.
        * @return       A boolean that represents if the tutorial has been started.
         */
        public boolean startTutorial(String id, Player player){

        }

        /**
        * Returns if the player is currently in a server tutorial.
        * @param uuid  The players UUID
        * @return      A boolean
         */
        public boolean isInTutorial(UUID uuid){

        }

        /**
        * Get the current servertutorial of a player.
        * @param uuid  The UUID of the player
        * @return      The servertutorial or null if not in one.
         */
        public ServerTutorial getCurrentTutorial(UUID uuid){

        }

        /**
         * Gets the controller object that manges the players tutorial.
         * @param uuid
         * @return The controller object. Null if not in a tutorial.
         */
        public TutorialController getController(UUID uuid){

        }

        /**
         * This method is used to fetch the API with ease.
         * @return An Api Object
         */
        public static ServerTutorialApi getApi(){

        }
    }
     
    To get this class simple use this piece of code:
    Code (Text):
    ServerTutorialApi stApi = ServerTutorialApi.getApi();
    //TODO: Store this somewhere for easy acces.
    Events
    The API also provides some events you can listen for.
    Code (Text):

    @EventHandler
    public void handlestart(TutorialStartEvent event){

    }

    @EventHandler
    public void handlestop(TutorialEndEvent event){

    }

    @EventHandler
    void handlePlayPoint(TutorialPlayPointEvent event){

    }
     
    Javadocs: http://servertutorialplus.martenm.nl/index
    (Note: Only contains objects you should be using when using the API)

    [​IMG]
    ☐ New point types
    ☑ Block certain commands when in a tutorial.
    Language files
    Support for more custom points. (Priority)
    Rework the edit commands.
    Bind any mob to play a tutorial (good for citizens etc)
    Add placeholder API
    NPC's that can be right clicked to play a tutorial


    [​IMG]

    Stats provided by Bstats.org. You can opt out this service at any time.

    Checkout another plugin by me
    [​IMG]

    If you enjoy the plugin: Please leave a review or consider donating to help me pay my bills :D

    I work on this plugin in my free time. I do not get paid for it any way, just so everybody can use it, but if you want to support me, and already left a review, than you can donate here:

    [​IMG]

Recent Updates

  1. 1.23.4 > 1.18 Compatability
  2. 1.23.3
  3. 1.23.2

Recent Reviews

  1. pucci
    pucci
    3/5,
    Version: 1.23.2
    Hi !! I loved this plugin but 1.8 working or not? Thanks for plugin. Good luck..
    1. MartenM
      Author's Response
      Leaving a 3-star review with your question really doesn't help me :(
      The supported Minecraft versions are shown in the header of the resource page. You have to test for yourself how well it works on other Minecraft versions.
  2. DrWurzeli
    DrWurzeli
    5/5,
    Version: 1.23.2
    With all the negative reviews, I just wanted to say: Thanks for making this plugin. I just updated to 1.18 and everything still works great.
    Not only is it super easy to add points but also to edit them and adjust stuff afterwards. simplest way for anyone to add tutorials to a server by far. thanks!
    1. MartenM
      Author's Response
      Thanks for the review :)
  3. HenrikoMagnifico
    HenrikoMagnifico
    5/5,
    Version: 1.22.1
    Excellent plugin! The only suggestion I have is to add the option to start a tutorial when using an item / reading a book. That way you can have a "Guide book" that the player starts with! Keep up the great work!
  4. Lions_lmao
    Lions_lmao
    3/5,
    Version: 1.22.1
    its good but i cant use the titles or add commands for some reason
    please fix it i can send logs
    1. MartenM
      Author's Response
      Please do bug reports in the discussion section.
  5. jeeingsama
    jeeingsama
    5/5,
    Version: 1.22.1
    Strongly required to be able to run on version 1.8!!!Please the author to update a version that can also be used in version 1.8
  6. coquetteish
    coquetteish
    1/5,
    Version: 1.22.1
    It was good at first, then everything deleted itself after I restarted the server one time. I like everything it does, it just bugs out when you add npc heights. I'm not tryna make the tutorial every time the server restarts.
    1. MartenM
      Author's Response
      Could you please show any logs. I am unable to reproduce this error.
  7. DixelCA
    DixelCA
    1/5,
    Version: 1.22.1
    2 horas, 2 horas de mi vida creando un tutorial para qué?
    Para que el /st npc estuviera bugeado y por si fuera poco me eliminara la misión, los odio
    1. MartenM
      Author's Response
      If you have any suggestions, be sure to post them in the discussion.
      If you experience any issues do so too!
  8. craciu25_yt
    craciu25_yt
    5/5,
    Version: 1.22.1
    Good plugin! Is very good for new players in your server!
    I can make the player stay flying in the middle of the tutorial!
  9. RedstoneSam
    RedstoneSam
    5/5,
    Version: 1.22.0
    Works great on 1.16.5, but for some reason the titles break in 1.17 (but I can't expect anything less since the official 1.17 release isn't out yet :) )
  10. adoiek320
    adoiek320
    4/5,
    Version: 1.22.0