Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hbeau authored May 14, 2019
1 parent 855ecfb commit b97d8e9
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,27 @@ The plugin is designed to work with Sponge API 7.0.0 (Minecraft 1.12). To instal
into the mods folder on your server. A default configuration will be created in the *config/storyteller* folder when you first launch the server with the plugin.

## Commands
* **/dialog *x* [*player*]** : Open a configured dialog to a given player or the command executor, *x* being the dialog identifier.
Permission : *storyteller.command.read*
* **/reload-storyteller** : Reload the storyteller configuration files.
Permission : *storyteller.command.reload*
* **/get-objectives *player*** : Returns storyteller associated player objectives in chat.
Permission : *storyteller.command.objectives*
* **/set-objective *player* *objective* *value*** : Set the current player objective value for a given objective to a given number.
Permission : *storyteller.command.objectives*

* `/dialog read|r <index> [player] ` : Open a configured dialog to a given player or the command executor, *index* being the dialog identifier.
_Permission : `storyteller.command.dialog`_
* `/dialog info|i <index>` : Get informations about the dialog with the corresponding id, *index* being the dialog identifier.
_Permission : `storyteller.command.dialog`_
* `/dialog trigger|t <npcName> [player]` : Load the current player dialog for the npc according to conditions, *npcName* being the npc name, and a given player or the command executor.
_Permission : `storyteller.command.dialog`_
* `/reload-storyteller` : Reload the storyteller configuration files.
_Permission : `storyteller.command.reload`_
* `/get-objectives <player>` : Returns storyteller associated player objectives in chat.
_Permission : `storyteller.command.objectives`_
* `/set-objective <player> <objective> <value>` : Set the current player objective value for a given objective to a given number.
_Permission : `storyteller.command.objectives`_

## Configuration

###Global
### Global
In the *storyteller.conf* file, there is the global plugin configuration. you can change :
* the *interaction* is if entities are interactible. if it's `true`, entities can trigger dialogs else you must use command to trigger dialogs
* A list of intractable entities. if it's empty all entity are enabled.
###Dialogs
### Dialogs
The dialogs need to be configured first, using JSON files located in the *config/storyteller/* folder, like the following example.
* The **id** number is used to reference a dialog from an other one or from a command call
* The **trigger** defines a list of villager names that will trigger the dialog when the player right click them
Expand Down Expand Up @@ -119,4 +124,4 @@ Here is the list of the available button actions and there arguments (separated
- **START_KILL_COUNT** : Start a counter for a given NPC and a given monster. Takes a monster name or type as argument.
- **STOP_KILL_COUNT** : Stop a counter for cleaning. Takes a monster name as argument, and use the NPC name (trigger).
- **CREATE_INSTANCE** : Create an instance from a world and teleport the player into it. Takes the world to copy as first argument, then three numbers for X, Y and Z position to teleport the player to (*Only if EpicBoundaries plugin is available*).
- **APPARATE** : Teleport the player to another world. Takes the world name as first argument, then the X, Y and Z position (*Only if EpicBoundaries plugin is available*)
- **APPARATE** : Teleport the player to another world. Takes the world name as first argument, then the X, Y and Z position (*Only if EpicBoundaries plugin is available*)

0 comments on commit b97d8e9

Please sign in to comment.