---

Introduction

Have you ever tried to explain every aspect of the game by just writing signs?
Are you tired of new players joining and asking to explain how the game works?



That time is over! Now with EzTutorial you can make easy and informational tutorials for your players to learn from!
The
way this plugin works is by location points. You the owner sets as many
locations as you want, then your server users can then go on a tour of
those locations you set. But they can have messages, rewards, delays,
and so much more. Almost every aspect of the plugin is configurable.
Make sure you read the configuration section because it can be
confusing.

Features

• Tutorials are easy to create and, use signs to start them.
  
• Tutorials are easily expandable for as many locations as you want, even after the tutorial has been saved.
  
• Tutorials can be easily be deleted in game with one command!
  
• Locations in tutorials can be easily deleted in game with one command!
  
• Messages and location names for each location are available for easy customization.
  
• The delay in between the locations can be configured.
  
• Rewards of any kind and of any amount can be given on completion of a tutorial.
  
• An end message can be easily customized to be sent after a player has completed a tutorial.
  
• A tutorial can be set as the default tutorial for new players to the server to be put through
  
• A custom join message can be sent on first join of new players, in correlation to the default tutorial.
  
• Staff members of the server can put a player through a tutorial with one easy command!
  
• Every aspect of the plugin in configurable
  
• Permissions are available on every aspect of the plugin (If you don't have a permissions manager it defaults to OP).
  

Commands and Permissions

Command	Permission	About
/tutorial list	tutorial.list	Lists all the tutorials
/tutorial help	tutorial.help	Displays the help page for the plugin
/tutorial new <tutorial name>	tutorial.new	Creates a new tutorial
/tutorial setlocation <tutorial name> <location number>	tutorial.setlocation	Creates a new location in the given tutorial
/tutorial dellocation <tutorial name> <location number>	tutorial.dellocation	Deletes a location from the given tutorial
/tutorial deltutorial <tutorial name>	tutorial.deltutorial	Deletes the tutorial given
/tutorial startplayer <tutorial name> <target player>	tutorial.startplayer	Puts the target player through the tutorial given
	tutorial.start	Gives the ability to use the start signs for the tutorials
	tutorial*	Gives the ability to use every command in the plugin

Usage

1. Type /tutorial new <tutorial name>
   
2. 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)
   
3. Walk to where you want a location to be and type /tutorial setlocation <tutorial name> <location number>
   
4. Repeat step 3 as many times as you want
   
5. Edit the config to your liking
   
6. Right click the start sign to be put through the tutorial!
   

Configuration

Some of the things in this are just examples such as the heading
Spawn (The example tutorial name) and 1 (The example location number)



Tutorials:

• 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
      
    
    
  
  
• Spawn:
  • Reward:
    • 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)
      • ex: DIAMOND_BLOCK
        
      
      
    • Amount: <number> How many items you will get of the reward listed above 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
    
  • 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
          
        
        
      
      
    • Location Name: <name> Name the location so when the player is at this location, it will tell them the name
      • ex: Chest Shop
        
      
      
    
    
  
  

---

For a more indepth tutorial watch this video explaining everything with more detail!

TODO

• Vault integration so money rewards can be given
  
• Citizens integration so you can have a npc tour guide
  

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)
  

Visit our Bukkitdev page here.