Festival

If you like Festival please leave a thumb up at poggit to help getting the Festival plugin approved, thank you!_

Create a festival with this custom area events plugin for Pocketmine Server:

Manage area's and run commmands attachted to area events.

Copyright Genboy 2018

Info

Festival

issues @ github and/or reviews @ poggit

Features

Area

• Create and manage area’s (like WorldGuard/iProtector)

  • Define cuboid area by tapping 2 positions
  • create/delete/list area’s
  • add area description
  • whitelist players for the area
  • tp to an area
  • show area’s info at current position

Flags

• Set area flags true means

  • edit: the area is save from building/breaking
  • god: players in the area are save in god mode
  • pvp: players in the area are save from PVP
  • flight: players in the area are not allowed to fly
  • touch: area is save from player interaction with chests/signs etc.
  • effects: player can not keep using effects in the area
  • msg: do not display area enter/leave messages
  • passage: no passage for non-whitelisted players! (previously barrier flag)
  • drop: players can not drop things
  • tnt: explosions protected area
  • hunger: player does not exhaust / hunger
  • perms: player permissions are used to determine area command execution (experiment)

Events & Commands

• Add commands to area events

  • assign commands to area events
  • enter, center or leave.
  • add/edit/delete area event commands
  • list area commands (ordered by event)
  • change event of area commands

Specific

• World: Default & world specific flags in config.yml
• Flight: if server allows flight, and level flight-flag is true, an area in that level has still flight enabled untill flight flag is set true
• Perms: Area event commands are executed by default with op-permissions by players or, if perms flag true: area uses the player permissions

Created by Genboy 2018

Credits for the area creation and protection code go to iProtector creator LDX-MCPE and all other iProtector devs.

Usage

Setup

Install & Configure

• Standard Plugin installation;

  • 1. Upload .phar file (or .zip if you have latest devtools installed)
  • 2. restart the server, go to folder plugins/Festival;
  • 3. ! Edit config.yml; set the defaults for options, default area flags and the default area flags for specific worlds.

config.yml options and flags:

Options

• Msgtype: tip/pop - show area messages in tip or pop screen area

• Msgdisplay: off/op/on - on: messages persist display, op: messages persist display to ops only, off: not persistant

• AutoWhitelist: on/off - automatically whitelist creator(op) to area

Settings for unprotected areas in worlds:

Default

- Keep players from getting hurt? Default no = flag off

God: false

- Keep players from getting hurt by other players? Default no = flag off

PVP: false

- Keep players from flying? Default yes = flag on

Flight: true

- Keep players from editing the world? Default yes = flag on

Edit: true

- Keep players from touching blocks and activating things like chests? Default no = flag off

Touch: false

- Keep players from having effects like speed or night vision? Default no = flag off

Effects: false

- Keep players from seeing enter/leave/description messages? Default no = flag off

Msg: false

- Prevent players from enter/leaving the area? (barrier) Default no = flag off

Passage: false

- Keep players from dropping items in the area? Default no = flag off

Drop: false

- No explosions allowed in the area? Default no = flag off

TNT: false

- Keep players from hunger(exhaust) in the area? Default no = flag off

Hunger: false

- Keep players from executing area event commands without specific perms? Default no = flag off

Perms: false


##### Read the flag comments carefully about how the flags work!


- !! edit and flight flags are default true/ON to protect worlds when enabled

Above 'Default' settings apply to all unprotected areas (worlds) as default settings

and for separate worlds in an array called 'Worlds' with first default world Worlds->DEFAULT.

- Add World/level specific flag configuration: 
  
  Copy the all lines of the DEFAULT list, past them below the default and replace DEFAULT with your world name.
  (make sure the world name starts on a new line with 2 spaces indent (= starting a sub array like Worlds[yourworldname])

Updates

Updates available at poggit and github

!Before update always copy your config.yml and areas.json files to a save place, with this you can revert your Festival installation

• after .phar install and first restart/reload plugins; check console info and your areas.json and config.yml; restart after adjusted correctly

Since v1.0.3-11+

• pass(passage) flag gives the area a barrier for non ops/whitelisted
• configuration for area messages (taken out of chat)
  • Msgtype: tip or pop (prefer depend on other plugin message display)
  • Msgdisplay: off = hidden for all players op = only ops see all area enter/leave messages on = all players see the area messages

Since v1.0.4-11

• areas are updated with the new flags, configuration should be updated manually; example resources/config.yml

Since v1.0.5-12

• configuration should be updated with AutoWhitelist option & new Effects flag; example resources/config.yml

Since v1.0.6-13

• new PVP flag
• new Flight flag
• /fe list LEVELNAME - Area list of all area's in all levels, or for specified level
• configuration should be updated resources/config.yml

New in v1.0.7

• new TNT flag
• new Hunger flag
• Fire is now extinguished when player does not get damage (aka. in area with god flag on)

Usage Graphic

A visualisation of Festival command usage

Copyright Genboy 2018

Create area

First command '/fe pos1' and tab a block for position 1,

then command '/fe pos2' and tab a block to set position2,

these are the endpoints of the area longest diagonal.

/fe pos1
/fe pos2

Then name/save the selected area

/fe create <AREANAME>  

Now the area is ready to use

You might want to set or edit the area description line

/fe desc <AREANAME> <description>

Set area flags

Festival v1.0.1-11 introduced a fast toggle for flags:

  /fe <edit/god/pvp/flight/touch/effects/tnt/drop/msg/pass/hunger/perms> <AREANAME>


Area flag defaults are set in the config.yml), server defaults and world specific default flag. 
The basic command to control area flags:

  /fe flag(f) <AREANAME> <edit/god/pvp/flight/touch/effects/tnt/drop/msg/pass/hunger/perms> <true/false>

Area flag listing

  /fe flag <AREANAME> list

Position info

See area information at position

/fe here

List all area's

/fe list

Teleport to area

/fe tp <AREANAME>

Set description

/fe desc <AREANAME> <DESCRIPTION>

Manage whitelist

/fe whitelist <AREANAME> <add/list/remove(del,delete)> <PLAYERNAME>

Delete an area

/fe delete(del,remove) <AREANAME> 

Area event commands

**This is the fun part of Festival: assign commands to area events**

When an area is created 3 events are available;
  - enter; when a player enters the area
  - center; when a player reaches the center (3x3xareaHeight blocks)
  - leave; when a player leaves the area


To add a command you need at least;
  - an areaname, 
  - an unique id for the command 
  - make sure the command works! (when you are op)
  
  
/fe command <AREANAME> <add/list/edit/event*/del> <COMMANDID> <COMMANDSTRING/enter*/leave*/center*> 

Add a command:

/fe command <AREANAME> add <COMMANDID> <COMMANDSTRING>

  'add' is the default for attaching a command on the 'enter' event. 
  Using 'enter', 'center' or 'leave' instead of 'add' attaches the new command to 
  the given eventtype: i.e. /fe command <areaname> center <commandid> <commandstring>

List area commands:

/fe command <AREANAME> list

Edit command:

/fe command <AREANAME> edit <COMMANDID> <COMMANDSTRING>

Change command event:

/fe command <AREANAME> event <COMMANDID> <enter/center/leave>

Remove command:

/fe command <AREANAME> del <COMMANDID>

Development

The Festival plugin is in active development.

Development on github.com/genboy/Festival

If you like to help improve this plugin;

• download/use the plugin and give your feedback
• look at the code and give feedback
• both by submitting issues @ github and/or reviews @ poggit

or send an email to msg @ genboy.net

Thank you

Milestones v1.0.0-11 - v1.0.3-11

• [x] area protection and flag management is stable (core iProtector, 9876ca3 Dec 2017)

• [x] Area messages and msg/description management are stable

• [x] Commands can be attachted to specific events at the area:

• [x] enter: on entering the area

• [x] center: when in the center of the area

• [x] leave: when leaving the area

• [x] Submit to poggit

• [x] Testing expected possibilities; use as portals and shields, design a minigame park, create a quest/parcour..

• [x] Passage flag; turning the area into a barrier, no one in, no one out.

• [x] /fe tp now sends player to the area top-center and prevents fall damage

Milestones v1.0.3-11 - v1.0.7

• [x] Config options:
  • Messages out of chat (tip/pop)
  • Messages persist display to ops (off/op/on)
  • Auto whitelist area creator (on/off)
• [x] Effects flag: remove players effects in area
• [x] Perms flag: player perms used for area commands (vs OP pems)
• [x] Drop flag: player can not drop things
• [x] PVP flag: players can not PvP (warn message)
• [x] Flight flag: players can not fly (incl. no fall damage & allowed messages)
• [x] Area Commands: playerName can be used as {player} or @p in area event commands
• [x] TNT flag: explosion free area's
• [x] Hunger flag: players do not exhaust
• [x] Fire (animation) extinguished when player is save

Credits

The area code derives from the iProctector plugin. All credits for the area creation and protection code go to the iProtector creator LDX-MCPE and other iProtector devs.

The Festival code is written and tested by Genboy and first released on 12 Feb 2018, first extendomg the area object with area events (enter and leave messages) and soon added functions and ingame commands to attach a commandstring to a area-event. Since v1.0.7 the area's and players can be protected with 12 flags, and trigger commands on areaEnter, areaCenter and areaLeave.