MyTutorialSystem icon

MyTutorialSystem -----

Give your players an introduction in a very cool way :)! Do it with a tutorial!



[​IMG]

Give your players an introduction in a very cool way :)
Do it with a tutorial!

Before you start producing a youtube tutorial, you should
think about a live tutorial on the server. With this
plugin you can easily setup a tutorial and let your players
walk throught it.


[​IMG]

Commands:
To show the admin-help:
/Tutorial
To get the player-default-help-text (txt_cmd_helper.yml) use the following command:
/Tutorial help
To get a list of all created tutorials:
/Tutorial list
To setup a tutorial use the following command:
/Tutorial setup <tutorial-name>
To leave/quit the setup-mode use (nothing will be saved):
/Tutorial setup exit
To edit an existing tutorial:
/Tutorial edit <tutorial-name>
To delete a tutorial:
/Tutorial delete <tutorial-name>
To define a display-name for the tutorial use (display-name will be used for the placeholder '%tutorialName%'):
/Tutorial set display-name <name>
To get a list of all defined spawn-points for this tutorial.
/Tutorial spawn-point list
To add a new spawn-point to the tutorial. The txt-fileName can be for exmaple: 'city' or 'city_mid' it should describe the current location (just for you). The duration is given in seconds which will be the time for reading the defined text to this location.
/Tutorial spawn-point add <txt_fileName> <duration>
To remove a spawn-point use the following command, to get the id you can use the list command (see above).
/Tutorial spawn-point remove <id>
To set your whole inventory items as a reward for the player use the following command:
/Tutorial reward inventory
To set a command-set as reward use the given command, this will add a command-set in the tutorial-files, which can be changed.
/Tutorial reward command-set
To set the exit-location:
/Tutorial set exit-location
To save your tutorial:
/Tutorial save

Tutorial-Area:
A tutorial-area is an area/location in where you need to be to join a tutorial. This is used to avoid the problem that a player can enter the tutorial from any point (for example in a pvp-battle). So you can easily define some areas in which you can join specified tutorials.

To get a list of all created tutorial-areas:
/Tutorial tutorial-area list
To create a new tutorial-area, the distance is the area (in blocks) in which the player needs to be to enter the tutorial:
/Tutorial tutorial-area create <name> <distance>
To delete a tutorial-area:
/Tutorial tutorial-area delete <name>



[​IMG]

Now after we know the commands let's take a look into the 'settings.yml'. In the settings you can enable or disable the plugin by changing the 'Enabled'-entry. You can also enable/disable the placeholder-api. Important settings for this plugin are the entrys for the 'System'-section. The three-sixty-view is used to give the player the capability to rotate 360 degress in the tutorial. By using the store-inventory setting the inventory of the player will be stored in the players-file and will be restored after completing/exiting the tutorial. But in most cases you don't have to enable the 'store-inventory'-setting because the player will be moved into the spectate-mode while doing the tutorial. So the default 'false' should be fine :)!

For example I use these settings on my server:
Code (YAML):
MyTutorialSystem:
  Enabled
: true
  API
:
    PlaceholderAPI
:
      Use
: false
  System
:
    TutorialArea
:
      Use
: true
    ThreeSixtyView
:
      Use
: false
    StoreInventory
:
      Use
: false


[​IMG]

Let's take a look at the folders after installing the plugin on our server.
Folders which will be created:
Code (Text):
- MyTutorialSystem
    - Others
        - messagesSounds.yml
    - TextBlocks
        - txt_cmd_helper.yml
        - txt_tutorial_completed.yml
    - TutorialAreas (when you define tutorial-areas)
    - Tutorials (when you create a tutorial)
    - Userdata (when you join a tutorial)
    - settings.yml
    - version.yml
File 'messagesSounds.yml':
In the "messagesSounds.yml" you can change the messages which will be displayed to the default user. You can also add a sound which will be played if a user gets a defined message.

File 'txt_cmd_helper.yml':
This text-block will be send to the default-player when he enters the command '/Tutorial'. You should change the text to your preferences.

File 'txt_tutorial_completed.yml':
This is the text-block which will be send to the player if he completes a tutorial. Here you can use the placeholder '%tutorialName%'.

TutorialAreas:
When you have defined some areas there will be the defined files. You can change the 'Distance'-Paramter or the 'Tutorials' which will be able to join in these area.

Tutorials:
When you have created a tutorial there will be a sub-folder with the tutorial-name. In this sub-folder is a file named 'myTutorial.yml'. This file is the configuration file for this defined tutorial. You can change the display-name or the duration for the spawn-points (or the text-block for the spawn-points). The entered text-block for the spawn-points are linked to the folder: 'TextBlocks' in the tutorial-folder. You should change the predefined text-blocks to your preferences.



[​IMG]

What is a 'CommandSet'?
With a command-set you can force the player to interact with plugin-functions. That means for example if you want to give the player a diamond after completing the tutorial you can define for the reward-command-set the following statement ('SCMD' is the parameter that the command will be executed by the server/console!):
Code (YAML):
 Reward:
    Use
: true
    AlwaysReward
: false
    CommandSet
:
    - SCMD=give %p% diamond 1
You can also add more functions, for example if you want that the player executes a specific command (for example let's teleport him to the farm-world):
Code (YAML):
 Reward:
    Use
: true
    AlwaysReward
: false
    CommandSet
:
    - SCMD=give %p% diamond 1
    - CMD=warp farmworld
Here are some more CommandSet-Paramters:
Debug the current CommandSet:
Code (YAML):
    - DEBUG
Send a text-block to the player (text-block need to be located in: /plugins/MyTutorialSystem/TextBlocks/):
Code (YAML):
    - TEXTBLOCK=txt_hello_world.yml
To clear the players chat:
Code (YAML):
    - CHATCLEAR


[​IMG]

Placeholders:
'%prefix%' - The plugin prefix (you can change it in the messagesSounds.yml)
'%p%' - The player-name.
'%uuid%' - The player-uuid.
'%tutorialName%' - The tutorial-name.

This plugin supports the 'PlaceholderAPI'.

Permissions:
Admin (for tutorial-setup):
mts.general.admin

User:
mts.general.default
mts.command.tutorial



Thank you for using this plugin!
If you have some problems or questions feel free to ask :)!
Please use the start-a-conversation function (so I will get an e-mail).​



Icon (from the thumbnail):
https://www.flaticon.com/free-icon/video-tutorial_2201225?related_id=2201225&origin=tag#
Resource Information
Author:
----------
Total Downloads: 97
First Release: May 22, 2022
Last Update: May 22, 2022
Category: ---------------
All-Time Rating:
0 ratings
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings