ServerTutorial
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!
@jpell1221
@DmNova
When you do /tutorial create you are entered into a conversation, just type whichever type you'd like. I'll make this more clear in 1.1.1
I am not sure on how to create a tutorial...when i try using the /tutorial create <name> command I get a list of types of tutorials time and click.
How to create Toturial?
@elkidz
Also, do not edit the config please, that will mess up a lot of things
@gomeow
Ok, but I'am talking about the version 1.1 o.O
@elkidz
The new update has not been approved yet, so you just downloaded the first version. Please wait until v1.1 has been approved so you can use the fixed version
A lot of bugs. My question is: you test the plugin? I'am using the last dev of spigot and I have this spam in my console in 3 minutes (http://pastebin.com/3xubf9Ut). The plugin doesn't have a /tutorial help and have a lot of errors in messages like "You must create this tutorial first! /server create <name>" (/server ? ) and type /tutorial "Availible tutorials". When I'am doing the tutorial, the plugin doesn't give me the correct time to do my messages. In the option Tutorial Time I type "TEXT" the time works correctly but the plugin gives me a stick and I can pass through in all steps of the tutorial. If I edit my config the plugin reset all the config... Probably much more bugs. I'am waiting for the next update. I know that my English it's not very good and sorry if I didn't explain well.
Hi! Finaly an update! :D I will test right now but you fix for no crashing the server/client?
@mrcameron999 : I think that Citizens 2 have an option that when you click a NPC it will execute a command.
@hawkfalcon : An option for a player or console execute commands in the tutorial will be a nice feature. Server owners can give money in the end with this or for example: (Tutorial config:
Another feature that would be nice is mute the chat for the player when he is doing the tutorial.
1.1 has been uploaded finally, thanks to frostalf and gomeow!
Notable features:
- Multiple tutorials
- Time based tutorials
- Much better creation
Enjoy!
Love this plugin it was what i was looking for
i made a plugin request sept i found this amzing thank you sooo much
Few requests able to delete the tutorial Multipal tutorials Get a reward for complition money must be completed for new player Instead of typing /tutorial u click a npc or a sign
thanks
@xXluulXx
When we manage to make it not crash the server! :D
When come v1.1??? :)
Waiting for v1.1 :(
Got some work done today, implemented multiple tutorials and Conversation-based creation, x_X. Expect v1.1 within the week.
@elkidz
Yes, can't wait! Looking forward to it. I hope the protocollib function to hide all other chat is in that :)
@hawkfalcon
We are all waiting for the next update. :D
Ability to toggle "looking" so the players can look around the view in a 360 degree would be nice, as well as an option to disable this with fixed-view.
Timers as well, custom per view so it automatically switches to the next view after a configurable amount of time.
@Relicum
Creating a view is going to get more complex w/ multiple tutorials, the ViewType, and such. I'll probably at least use conversation API for the view creation. As for your idea with stringprompts, I had this, and it worked, but I couldn't seem to be able to leave the conversation. If you'd like, come find me in Irc.esper.net in #hawkfalcon
@hawkfalcon
I have managed to use the conversation API to create a walk through as part of the setup of a plugin I am creating. The problem as you said is the implementation to allow for it to be used by end users. I created various abstraction classes and custom interfaces but there only of use for a developer. Creating a complete abstract API what would be usable for admins to make tutorials would be, well how shall I put it, hard-work lol.
One idea I did have for which might be of use would be to use a single Prompt of the type StringPrompt . If the conversation was set up with withModality set to true then all messages to that player are suppressed. You could have the StringPrompt to set an empty string and blocksForInput is true then nothing would be displayed in chat until some form of input is passed by the player which would then end the conversation and allowing chat to flow again.
Not sure if that is of help or not. I will let you know if |I come up with any other simple based solutions as it's what i'm working on as I said for my own plugin, which is really more of a large framework or well be when complete.
Regards Relicum
@OriginalMadman
Multiple tutorials is planned.
Due to the limits of minecraft I can't do that, but with protocollib I can hide ALL messages and such.. may make it an optional dependancy.
@elkidz
Time mode is planned as well! There is already some code for it in there :D Thanks :D