ServerTutorial

Table of Contents

Have you ever wanted to make a cool tutorial for players that doesn't use boring signs? Now you can make one!

Description

NOW 1.13 COMPATIBLE

This is the ultimate tutorial plugin for Bukkit. It allows easy creation of 'views' which the player sees after typing /tutorial.

Features

Easy tutorial creation
Unlimited tutorials, unlimited scenes per tutorial
Two types of tutorials (CLICK/TIME)
Three types of views (TEXT/TITLE/ACTIONBAR)
Show a player a tutorial when they first join your server
100% configurable
Economy tie-in
Easy to set up and use
Give your players a tutorial that isn't boring
Versatile - Use it for a play, or a plugin tutorial, or a welcome tutorial, or anything you can think of.
Lightweight

Commands

Command	Description
/tutorial	List tutorials
/tutorial help	Help page
/tutorial <name>	Puts you in the tutorial
/tutorial create <name>	Create a new tutorial
/tutorial addview <name>	Add a view to a tutorial
/tutorial remove <name>	Removes a tutorial
/tutorial remove <name> <view number>	Removes a tutorial view

Permissions

Permission	Command	Description
tutorial.create	Use /tutorial create <name>	Creating a tutorial
tutorial.use	Use /tutorial <name>	Allows a player to use any tutorial
tutorial.tutorial.<name>	Use /tutorial <name>	Allows a player to use a specific tutorial
tutorial.remove	Use /tutorial remove <name>	Remove a tutorial

Tutorial types

Tutorial Type	Description
CLICK	Right click an item to go to the next view
TIME	Automatically go to the next view after a customizable amount of time

View types

View Type	Description
TEXT	Show message as a simple chat text
TITLE	Title (subtitle)
ACTIONBAR	Action bar above item bar

Miscellaneous

To make a sign, the top line must be [Tutorial] (changeable in the config), then the second line must be the name of the tutorial.
To make a tutorial start when a player first joins the server, edit the appropriate fields in the config.

Metrics

This plugin makes use of BStats Metrics.
To disable metrics either disable metrics in Bstats config file or disable it in the plugin config file.

We also include an update checker. It will download the latest updates for you. If you'd like to disable it, go into /plugins/ServerTutorial/config.yml

Bugs? Suggestions?

Leave feedback in the comments or file a ticket if there are any bugs!

Github Repo

IRC Channel

IRC WebChat

Comments

_ForgeUser2308899
- Join Date: 4/16/2009
- Posts: 345
- Member Details
#116 _ForgeUser2308899

View User Profile

Send Message

Posted Apr 26, 2014
Wow is there anyway you can push out a fix for the double "TEXT" ? it's really annoying lol

Rollback Post to Revision RollBack

_ForgeUser8846848

Join Date: 5/5/2012
Posts: 50
Member Details

#115 Posted Apr 25, 2014

I have found a much better way to make the item display name stay there. It does not require packets.

boolean reset = true;
public ItemStack getStick() {
    ItemStack is = new ItemStack(Material.STICK);
    ItemMeta isM = is.getItemMeta();

    if (reset) {
        isM.setDisplayName(name + ChatColor.RESET);
        reset = false;
    } else {
        isM.setDisplayName(name);
        reset = true;
    }

    is.setItemMeta(isM);
    return is;
}

EDIT: I have found a more efficient way of doing this. It still uses the same concept:

boolean reset = true;
public ItemStack getStick() {
    ItemStack is = new ItemStack(Material.STICK);
    ItemMeta isM = is.getItemMeta();
    String alt = "";

    if (reset) {
        alt = "" + ChatColor.RESET;
        reset = false;
    } else {
        alt = "";
        reset = true;
    }
    
    isM.setDisplayName(message + alt);
    is.setItemMeta(isM);
    return is;

Please tell me if this helped!

Last edited by _ForgeUser8846848: Apr 26, 2014

_ForgeUser11852421
- Join Date: 7/13/2013
- Posts: 7
- Member Details
#114 _ForgeUser11852421

View User Profile

Send Message

Posted Apr 24, 2014
@Toxicterror1991

I know right!

Rollback Post to Revision RollBack
_ForgeUser4900450
- Join Date: 8/24/2010
- Posts: 40
- Member Details
#113 _ForgeUser4900450

View User Profile

Send Message

Posted Apr 23, 2014
@BluePig yeah... almost checking every day if an update is out :D

Rollback Post to Revision RollBack
hawkfalcon
- Location: Reno
- Join Date: 12/17/2011
- Posts: 521
- Member Details
#112 hawkfalcon

View User Profile

Send Message

Posted Apr 19, 2014
@Toxicterror1991

https://github.com/hawkfalcon/ServerTutorial

Rollback Post to Revision RollBack
_ForgeUser11852421
- Join Date: 7/13/2013
- Posts: 7
- Member Details
#111 _ForgeUser11852421

View User Profile

Send Message

Posted Apr 17, 2014
I HATE THE DOUBLE MESSAGE GLITCH (Sorry for caps but its necessary)

Rollback Post to Revision RollBack
_ForgeUser4900450
- Join Date: 8/24/2010
- Posts: 40
- Member Details
#110 _ForgeUser4900450

View User Profile

Send Message

Posted Apr 15, 2014
@hawkfalcon never said something else :P just wanted to share my thoughts :D

is there actually a source code available?

Last edited by _ForgeUser4900450: Apr 15, 2014

Rollback Post to Revision RollBack
hawkfalcon
- Location: Reno
- Join Date: 12/17/2011
- Posts: 521
- Member Details
#109 hawkfalcon

View User Profile

Send Message

Posted Apr 14, 2014
@Toxicterror1991

Working on it :s

Rollback Post to Revision RollBack
_ForgeUser4900450
- Join Date: 8/24/2010
- Posts: 40
- Member Details
#108 _ForgeUser4900450

View User Profile

Send Message

Posted Apr 10, 2014
can't wait for an update :/

Rollback Post to Revision RollBack
_ForgeUser12362077
- Join Date: 10/6/2013
- Posts: 78
- Member Details
#107 _ForgeUser12362077

View User Profile

Send Message

Posted Mar 26, 2014
@hawkfalcon

Could you maybe add a way to quit a tutorial? When dealing with massive , timed tutorials it is really irritating to accidentally enable the tutorial and have to wait until you can do anything . I recommend adding one more item in the hotbar ( Like the existing stick ) with a quit lore that does let you quit with a right click :D

Please reply asap , the plugin really needs these additions :)

Rollback Post to Revision RollBack
_ForgeUser12362077
- Join Date: 10/6/2013
- Posts: 78
- Member Details
#106 _ForgeUser12362077

View User Profile

Send Message

Posted Mar 26, 2014
@hawkfalcon

There is a bug you have to consider :

Every time I start a tutorial I can't click disconnect through escape which is how it should work but when I use Alt+Tab I'm allowed to disconnect and if I do so the console gets spammed with errors informing me that the scheduled tasks couldn't be performed because of the sudden absence of the player . In other words , if someone's pc crashes my server gets really close to crashing too .

I'm so looking forward to the rewarding system though..keep it up!

Rollback Post to Revision RollBack
_ForgeUser10592025
- Join Date: 2/18/2013
- Posts: 40
- Member Details
#105 _ForgeUser10592025

View User Profile

Send Message

Posted Mar 25, 2014
The messages repeat 2 times! why?

Rollback Post to Revision RollBack
hawkfalcon
- Location: Reno
- Join Date: 12/17/2011
- Posts: 521
- Member Details
#104 hawkfalcon

View User Profile

Send Message

Posted Mar 24, 2014
@PlanetNZX

Reload breaks it. Restart doesn't.

Rollback Post to Revision RollBack
_ForgeUser11817333
- Join Date: 7/7/2013
- Posts: 11
- Member Details
#103 _ForgeUser11817333

View User Profile

Send Message

Posted Mar 23, 2014
hey I just got this plugin and it works great except whenever I restart my server the tutorial doesn't work properly and I cant teleport or move to view point. I looked in my console and it had a big error. I don't can u fix this, this is a great plugin!

Rollback Post to Revision RollBack
_ForgeUser12362077
- Join Date: 10/6/2013
- Posts: 78
- Member Details
#102 _ForgeUser12362077

View User Profile

Send Message

Posted Mar 18, 2014
@forshadowing2

Actually they get teleported at the exact same place they were when they executed the command or started the tutorial in any way :D

Rollback Post to Revision RollBack
_ForgeUser11267113
- Join Date: 5/19/2013
- Posts: 13
- Member Details
#101 _ForgeUser11267113

View User Profile

Send Message

Posted Mar 17, 2014
Also when you set it on join it takes their shit.

Rollback Post to Revision RollBack
_ForgeUser11267113
- Join Date: 5/19/2013
- Posts: 13
- Member Details
#100 _ForgeUser11267113

View User Profile

Send Message

Posted Mar 17, 2014
When they are finished they get teleported to a random place?

Rollback Post to Revision RollBack
_ForgeUser12362077
- Join Date: 10/6/2013
- Posts: 78
- Member Details
#99 _ForgeUser12362077

View User Profile

Send Message

Posted Mar 16, 2014
@DahDuff

If the stick is required for the CLICK transition I can't see why it appears in TIME tutorials.

Rollback Post to Revision RollBack
_ForgeUser12362077
- Join Date: 10/6/2013
- Posts: 78
- Member Details
#98 _ForgeUser12362077

View User Profile

Send Message

Posted Mar 16, 2014
@frostalf

There is a bug you have to consider :

Every time I start a tutorial I can't click disconnect through escape which is how it should work but when I use Alt+Tab I'm allowed to disconnect and if I do so the console gets spammed with errors informing me that the scheduled tasks couldn't be performed because of the sudden absence of the player . In other words , if someone's pc crashes my server gets really close to crashing too .

I'm so looking forward to the rewarding system though..keep it up!

Rollback Post to Revision RollBack

frostalf

Location: Roseville
Join Date: 10/23/2010
Posts: 41
Member Details

#97 Posted Mar 4, 2014

@Baba43

I think I might not be understanding why you would need to use the views without a location? What I am saying about views is that the whole view method relies on the location of the player and to work properly as it is intended.

Upcoming

Rewards system implemented. Money portion requires Vault in order to work. Vault is not required for this plugin to function overall.

Experience Bar can be used as a count down to know when tutorial ends.

Code Cleaned up

Hopefully fixed the double posting message, if not someone is going to have to show what exactly it is doing

Couple more API events

Adding some commands to change config options in-game as well as adding another permission for it as well

Hopefully more things to come

Last edited by frostalf: Mar 4, 2014

To post a comment, please login or register a new account.

Project ID

69090
Created

Nov 15, 2013
Last Released File

Oct 5, 2018
Total Downloads

135,504
License

MIT License

hawkfalcon Owner
_ForgeUser10707724 Contributor
frostalf Maintainer

Bukkit

ServerTutorial

Bukkit Plugins

ServerTutorial

Table of Contents

Description

Features

Commands

Permissions

Tutorial types

View types

Miscellaneous

Metrics

Bugs? Suggestions?

Github Repo

IRC Channel

Comments

Upcoming

About This Project

Categories

Members

Recent Files

Bukkit