![[IMG]](http://proxy.spigotmc.org/f1a95fc97a16e489db61874c92a35f6405e2788c?url=http%3A%2F%2Fmedia-curse.cursecdn.com%2Fattachments%2F125%2F410%2Ffbbe58db1c73a0d5291bc97e4dc2f544.jpg)
EzTutorial lets server owners easily make fun and informational server tutorials for their users!
--------------------------------------------------------------------------------------------------------------------------------------------------------
Back From Bukkit
The original EzTutorial plugin from dev.bukkit but revamped and ready for the Spigot community!
Original dev post: http://dev.bukkit.org/bukkit-plugins/eztutorial/
What's it all about?
Features
- Tutorials can be started by NPC interaction (check below), Signs, or Commands
- Server admins can put a specific player into a tutorial with a command
- You can restrict the type of movement during a tutorial (Walking, flying, floating, or none)
- Rewards of any kind and of any amount including economy money can be given as a reward for a tutorial (Requires Vault and any economy plugin)
- Post-tutorial messages can be sent
- Default tutorials can be set for new players on the server to automatically go through
- Permissions for each command/interaction in the plugin are available (If you don't have a permissions manager it defaults to OP).
- Messages can be sent as Titles (Requires BountifulAPI )
Commands
Permissions
Permissions:
- tutorial - Access to the main tutorial command
- tutorial.help - Access to the help command
- tutorial.list - Access to the list command
- tutorial.reload - Access to the reload command
- tutorial.new - Access to the new command
- tutorial.deltutorial - Accces to the deltutorial command
- tutorial.dellocation - Access to the dellocation command
- tutorial.setlocation - Access to the setlocation command
- tutorial.start - Access to the start yourself in a tutorial
- tutorial.start.player - Access to start others in a tutorial
- tutorial.start.sign - Access to start a tutorial with a sign
- tutorial.start.npc - Access to start a tutorial with a npc
Pre set classes:
tutorial.admin
- All permissions
tutorial.user
- tutorial
- tutorial.list
- tutorial.help
- tutorial.start
- tutorial.start.npc
- tutorial.start.sign
Usage
Creating a Tutorial
Code (Text):
Aliases: /tutorial /tut /t
list - Lists all the tutorials
help - Displays the help page for the plugin
reload - Reloads the config file
new <tutorial name> - Creates a new tutorial
start <tutorial name> - Puts you in a give tutorial
setlocation <tutorial name> <location number> - Creates a new location in a given tutorial
dellocation <tutorial name> <location number> - Deletes a location from the tutorial given
deltutorial <tutorial name> - Deletes the tutorial given
start <tutorial name> <target player> - Puts the target player through the tutorial given
list - Lists all the tutorials
help - Displays the help page for the plugin
reload - Reloads the config file
new <tutorial name> - Creates a new tutorial
start <tutorial name> - Puts you in a give tutorial
setlocation <tutorial name> <location number> - Creates a new location in a given tutorial
dellocation <tutorial name> <location number> - Deletes a location from the tutorial given
deltutorial <tutorial name> - Deletes the tutorial given
start <tutorial name> <target player> - Puts the target player through the tutorial given
Permissions
Code (Text):
Permissions:
- tutorial - Access to the main tutorial command
- tutorial.help - Access to the help command
- tutorial.list - Access to the list command
- tutorial.reload - Access to the reload command
- tutorial.new - Access to the new command
- tutorial.deltutorial - Accces to the deltutorial command
- tutorial.dellocation - Access to the dellocation command
- tutorial.setlocation - Access to the setlocation command
- tutorial.start - Access to the start yourself in a tutorial
- tutorial.start.player - Access to start others in a tutorial
- tutorial.start.sign - Access to start a tutorial with a sign
- tutorial.start.npc - Access to start a tutorial with a npc
Pre set classes:
tutorial.admin
- All permissions
tutorial.user
- tutorial
- tutorial.list
- tutorial.help
- tutorial.start
- tutorial.start.npc
- tutorial.start.sign
Usage
- Type /tutorial new <tutorial name>
- Take the sign and place it where ever you want and leave it blank (It will be the sign users will click to start the tutorial)
- Walk to where you want a location to be and type /tutorial setlocation <tutorial name> <location number>
- Repeat step 3 as many times as you want
- Edit the config to your liking
There are 3 ways to start tutorial: Using the start sign, startplayer command, and hitting a npc
- To start with a sign simply left click a start sign
- To start with the command simply type /tutorial start <tutorial name> <target player> (others) or /tutorial start <tutorial name> (yourself)
- To start with a npc there are a few simple steps
- 1) Get a npc spawning egg of your choice
- 2) Get an anvil
- 3) Put the egg into the anvil and rename it to the exact name of the tutorial you want to use it for (Caps and spaces count)
- 4) Now simply hit the npc and you will go on that tutorial!
Configuration
Code (Text):
New Players Default Tutorial:
Enabled: <true/false> If true on first join new players will be put through the specified tutorial
Tutorial Name: <tutorial name> The tutorial new players will be put through if enabled
Join Message:
Enabled: <true/false> If true on first join new players will be sent a customized message
Message: <message> The message that will be sent to new players if enabled
Tutorials:
Spawn:
Reward:
Item:
Enabled: <true/false> If true the reward below will be given to the player
Item Name: <ITEM_NAME> The reward that will be given if enabled (Acceptable material names can be found here http://minecraft-ids.grahamedgecombe.com/) ex: DIAMOND_BLOCK
Amount: <number> How many items you will get of the reward listed above if enabled
Money:
Enabled: <true/false> If true the money amount below will be given to the player
Amount: <number> How much money will be given to the player if enabled
Delay In Seconds: <seconds> How many seconds the player will spend at each location
Move During Tutorial: <true/false> If true players can move during the tutorial (Works with Fly During Tutorial)
Fly During Tutorial: <true/false> If true players can fly during the tutorial (If "Move During Tutorial" is false they will just float)
End Message:
Enabled: <true/false> If true players will receive a message when they complete the tutorial
Message: <message> The message that will be sent to the player at the end of the tutorial if enabled. ex: Thank you for learning more with EzTutorials
'1':
Message:
Enabled: <true/false> If true a message will be sent at this location
Message: <message> The message that will be sent to the player at this location if enabled. ex: Here you will be able to buy and sell items. Titles messages over 40 characters (including spaces) won't fit. Adding a feature to fix this soon
TitleAsMessage: <true/false> Requires BountifulAPI. If you have it installed it will default to true when you create a new tutorial and vice versa
Location Name: <name> Name the location so when the player is at this location, it will tell them the name. ex: Chest Shop
Enabled: <true/false> If true on first join new players will be put through the specified tutorial
Tutorial Name: <tutorial name> The tutorial new players will be put through if enabled
Join Message:
Enabled: <true/false> If true on first join new players will be sent a customized message
Message: <message> The message that will be sent to new players if enabled
Tutorials:
Spawn:
Reward:
Item:
Enabled: <true/false> If true the reward below will be given to the player
Item Name: <ITEM_NAME> The reward that will be given if enabled (Acceptable material names can be found here http://minecraft-ids.grahamedgecombe.com/) ex: DIAMOND_BLOCK
Amount: <number> How many items you will get of the reward listed above if enabled
Money:
Enabled: <true/false> If true the money amount below will be given to the player
Amount: <number> How much money will be given to the player if enabled
Delay In Seconds: <seconds> How many seconds the player will spend at each location
Move During Tutorial: <true/false> If true players can move during the tutorial (Works with Fly During Tutorial)
Fly During Tutorial: <true/false> If true players can fly during the tutorial (If "Move During Tutorial" is false they will just float)
End Message:
Enabled: <true/false> If true players will receive a message when they complete the tutorial
Message: <message> The message that will be sent to the player at the end of the tutorial if enabled. ex: Thank you for learning more with EzTutorials
'1':
Message:
Enabled: <true/false> If true a message will be sent at this location
Message: <message> The message that will be sent to the player at this location if enabled. ex: Here you will be able to buy and sell items. Titles messages over 40 characters (including spaces) won't fit. Adding a feature to fix this soon
TitleAsMessage: <true/false> Requires BountifulAPI. If you have it installed it will default to true when you create a new tutorial and vice versa
Location Name: <name> Name the location so when the player is at this location, it will tell them the name. ex: Chest Shop
This plugin uses Vault (optional) to manage money rewards. If you don't have Vault and a compatible economy plugin installed, you won't be able to give money rewards for tutorials.
As of v5.0, the plugin uses plugin metrics to report useful information. It will not harm you server at all. However, if you would like to disable it, go to the plugin metrics config and set "opt-out" to true.
As of v5.1, the plugin uses BountifulAPI (optional) to create titles for the location messages. You will need to have it installed to use the title feature. If not the location messages will show up as chat.
If you would like to give money rewards, make sure you have both Vault and an Economy plugin installed as well.
To-Do
- (Done in v5.0) Add a feature for flying during tutorials
- (Done in v5.1) Titles as messages
- (Done in v5.1.1) Multi world tutorials
- Disable PVP while in a tutorial
- Make players invisible in a tutorial
- Disable swimming
- Cooldown for tutorials
- Countdown for next location and when tutorial is starting
- Add a GUI menu for the tutorial list
- Sounds or effects
- Add an option to limit the amount of times players can get rewards from a tutorial
- Add per tutorial permissions
- More console control (start players, dellocation & tutorial, list)
- Take off numbers with locations, just the name of the location
- Create a update video to show all the new features!
Use of the Plugin
- If you would like to make a video showcasing the plugin please ask permission first. We would be more than happy to let you, just ask first.
- In addition if you use the plugin on your server and would like us to check it out give your server ip below and you may receive a surprise visit! (Please no spam though)
- Let me know about any bugs or if you have any suggestions for add-ons in the discussion section
Hey everyone. Thank you so much for the activity on the plugin. I am working hard in my free time to keep this plugin up-to-date and add features you guys want. If you would like to support the development you can donate here (any amount is appreciated). Have a great day!
![[IMG]](http://proxy.spigotmc.org/edfae36ad1a78c1c8e349c87ed29688505311743?url=https%3A%2F%2Fgetflywheel.com%2Fwp-content%2Fuploads%2F2015%2F10%2Fpaypal-donate-button-large-1100x500.png)
--------------------------------------------------------------------------------------------------------------------------------------------------------
For a more in-depth tutorial watch this video I made explaining everything with more detail!
For a more in-depth tutorial watch this video I made explaining everything with more detail!
Quick facts
- Edition: Minecraft Java
- File type: .jar
- Minecraft versions listed: 1.10, 1.11
- How to install: Install the matching mod loader (Forge, Fabric or NeoForge) for your Minecraft version. → Download the .jar. → Put it in the .minecraft/mods folder and launch that loader profile.
- Where to get it: Opens on Spigot — not every file is mirrored on our own servers.
Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.
EzTutorial | The original server tutorial plugin is a free Minecraft Java mod. Compatible with Minecraft 1.10, 1.11. Downloaded 1,708 times (via Spigot). Download it and open it directly in the game.