Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/genboy/festival
Custom events plugin for Pocketmine
https://github.com/genboy/festival
area command flags minecraft plugins pmmp
Last synced: 3 months ago
JSON representation
Custom events plugin for Pocketmine
- Host: GitHub
- URL: https://github.com/genboy/festival
- Owner: genboy
- License: other
- Created: 2018-01-19T15:00:57.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-12T19:24:11.000Z (over 2 years ago)
- Last Synced: 2024-10-09T23:04:10.333Z (3 months ago)
- Topics: area, command, flags, minecraft, plugins, pmmp
- Language: PHP
- Homepage: https://genboy.net/minecraft/festival/
- Size: 743 KB
- Stars: 38
- Watchers: 8
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Festival
# SORRY! This minecraft Pocketmine-MP plugin is not maintained anymore!
Please note that Festival is no longer actively being developed or maintained. Issues will not be attended to, the remainder of this README has been kept in place for future reference.
### Create area's, manage flags and run commmands attachted to area events.
Latest Release v2.1.3
phar available @ [github](https://github.com/genboy/Festival/releases/tag/2.1.3)
###### Copyright [Genboy](https://genboy.net/minecraft) 2018 - 2020
###### Take notice of the Copyright Statement if you use Festival for the first time since 27 April 2019. Read the Legal Notice** at the bottom of this README file or the Legal Notice tab at poggit.pmmp.io/p/Festival
---
# Festival
If you like to use Festival consider [sharing your experience and issues](https://github.com/genboy/Festival/issues) to fix any usability problems before posting a [vote](https://poggit.pmmp.io/p/Festival/1.1.1)! That way it will improve Festival, my coding skills, your Pocketmine-MP insights and strenghten the PMMP community, thank you!
For more info visit [genboy.net/minecraft](https://genboy.net/minecraft), home of [Festival](https://genboy.net/minecraft/festival)
The Festival Plugin is released on poggit
[](https://poggit.pmmp.io/p/Festival) [](https://poggit.pmmp.io/p/Festival) [](https://poggit.pmmp.io/p/Festival) [](https://poggit.pmmp.io/p/Festival)
See and make [reviews @ poggit](https://poggit.pmmp.io/p/Festival)
and post your [issues @ github](https://github.com/genboy/Festival/issues) - [](http://isitmaintained.com/project/genboy/Festival "Average resolve time") [](http://isitmaintained.com/project/genboy/Festival "Percentage open")
## Overview
### version 2.1.2
- Russian (ru) translations
- French (fr) translations
- Add right-click position selection in air
- Barrier op msg fix
- ForceUTF8 update fix PHP 7.4
- Debugged global eventhandling
- Area selection with Midair
### version 2.1.1
- Place compass translations
- Full fix falldamage
- Debug areaMessages & config
- Fix typo's
### version 2.1.0
- Mob/animal flag Slapper fix to remain on restart
- Edit flag protects paintings
- Fall flag bug fix
- Turn on compass usage (in development)
User can select their area's (whitelisted) to set compass direction Command can be used to set any area compass direction on area event
### version 2
Festival Manager Menu (UI + select item) - or use the commands
- Cube AND Sphere area's set with diagonal, radius or diameter
- Area's and Config managed from menu
- Optional Level flag protection
- Area name (and desc) can now be Full string inCluDing MuLti wORds CaPitaLized
- Stretching area's up and down with y scaling
- Use priority number for overlapping area's
## Info
#### Install
**Festival Install (version 2 )**:
*(always save copies of your previous used config.yml and areas.json before re-install)*
1. place phar file or unzipped Festival folder with (Devtools pluginfolder) in server plugins folder and restart,
2. after restart;
2a. if need previous used configs and areas: delete config.json and areas.json from the root folder
and put your config.yml and areas.json in Festival (root) folder
2b. if clean start (no areas) edit /resources/config.yml to your likes and delete config.json from the root folder
3. Then restart again, now areas.json, levels.json and config.json in Festival (root) folder are used.
( or download latest stable version [@ poggit https://poggit.pmmp.io/p/Festival](https://poggit.pmmp.io/p/Festival) - no Festival menu, only command usage)
#### Get started
**Management UI in game**:
command **hold magic item** or ** /fe menu** (ui, form, data)
( default magic item 201 - Purpur Pillar block - change in config management)
When using the form you need to **use the magic item to tab area positions**.
You can swapp item to build/break during area position 1 and 2 selection.
Or use the commands as shown in the usage image (now with Multi wORd FULLY CapitAlized nameS possible)
**Create area** with **menu**:
You can use cmd '/fe menu' or just hold the magic item (purpur block/your selected item/block).
Then if you choose create area you should tab the positions with the magic item.
After tab pos1 you may use other blocks to build etc. and then hold the magic item again to tab pos2. Directly after tab pos2 the menu should come back to name your area.
**Create area** with **commands**:
Use /fe pos1 and /fe pos2 to tab the positions, after pos2 you need '/fe create area ' to finnish the area creation. After creation both commands and menu can be used to manage the area.
#### Development
**Download development version**:
[Poggit development](https://poggit.pmmp.io/ci/genboy/Festival/Festival)
Please report bugs -thank you! [issues @ github](https://github.com/genboy/Festival/issues) and/or [reviews @ poggit](https://poggit.pmmp.io/p/Festival)
or use [devtools plugin](https://poggit.pmmp.io/p/DevTools/1.13.0) and [download zip package https://github.com/genboy/Festival/archive/master.zip](https://github.com/genboy/Festival/archive/master.zip)
### Features
**Menu**
In version 2.0.0 the Festival Management Menu (FormUI) is introduced
**Config**
- set default options in config.yml;
- Language: en - select language English = en, Dutch = nl, es = Español, pl = Polskie - translate please !
- ItemID: Hold this Magic block/item to enter Menu (default item 201 - Purpur Pillar block)
- Msgtype: msg - Area Messages Display position (msg/title/tip/pop)
- Msgdisplay: off - Area Messages persist display to ops (off/op/on)
- Areadisplay: op - Area Floating Title display to ops (off/op/on)
- FlightControl: on - To disable flight flag for all Festival usage (on/off)
- AutoWhitelist: on - Auto whitelist area creator (on/off)
**Area**
- Create and manage area’s ingame
- Define area's by tapping 2 positions
- **diagonal** for cube
- **radius** for sphere
- **diameter** for sphere
- Scale area's verticaly up and down
- create/rename/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 ingame
Flags: Any flag true will protect the area and the players in it.
ie. edit: true (on) means no breaking/building by players. shoot: true (on) means no shooting by players.
- edit: the area is save from building/breaking
- hurt: players in the area are save (previous god flag)
- 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 doors/chests/signs etc.
- animals: no animal spawning (including spawners & eggs)
- mobs: no mobs spawning (including spawners & eggs)
- effect: player can not keep using effects in the area
- msg: do not display area enter/leave messages
- pass: no passage for non-whitelisted players! (previously barrier flag)
- drop: players can not drop things
- tnt: explosions protected area
- fire: fire protected area (including spreading & lava)
- explode: explosions protected area
- shoot: player can not shoot (bow)
- perms: player permissions are used to determine area command execution
- hunger: player does not exhaust / hunger
- fall: player will not have fall damage
- cmd: area event commands are only executed for ops (test area commands)
**Events & Commands**
- Add commands to area events
- assign commands to area events
- enter, center or leave.
- variable player in commands with {player} or @p
- add/edit/delete area event command
- list area commands (ordered by event)
- change event of area commands
**Level flags**
- Use the level flags for level protection
- per level the levelcontrol toggle option enables the level flag protection
---
## Menu (UI)
#### Festival Menu
**Festival main menu**
#### Teleport
**Select teleport destination**
#### Areas
**Area management option menu**
**Select area to manage**
**Manage area settings**
**Manage area flags**
**Manage area commands**
**Add command**
using the @p reference in the command to target the player
(/heal command is an example, comes from another plugin)
**Del or change command** (by id)
Delete: Leave command empty and input 'delete cmd id' to delete id linked command.
Change: Set event type, enter command and input 'edit cmd id' to change that id linked command
**Manage area Whitelist**
Set players on or off area whitelist (this is in development)
**Select area to delete**
**Confirm to delete area**
#### Create
Select new area type
Hold the magic item - 201 purpur block by defaults, set in configs
**Tab positions with the magic block**, meanwhile use other blocks to build in between.
Set area positions
###### Cube Diagonal
1. Place or break the first diagonal position for new cube area
2. Place or break position 2 to set the longest diagonal in the new cube area
###### Sphere Radius
1. Place or break the center position for the new sphere area
2. Place or break position 2 to set the radius for new sphere area
###### Sphere Diameter
1. Place or break the first diameter position for the new sphere area
2. Place or break position 2 to set the diameter for new sphere area
Create area with Name (and description)
#### Levels
Turn on level flag control to use the level flags (instead of defaults)
Select level to manage flags (if levelcontrol config is on)
Manage level flags options
#### Configuration
UI configuration to set overall options and default flags for levels and area's
Manage Festival configuration options and set default flags
###### Copyright [Genboy](https://genboy.net) 2018 - 2019 - markdown edited with [stackedit.io]
## Usage
- Edit config.yml; set the defaults for options, default area flags and the default area flags for specific worlds.
- using ingame Festival Menu (UI) for configurations
- older versions (1.1.3) read [wiki on configurations](https://github.com/genboy/Festival/wiki/2.-Install,-Configure-&-Update)
#### Setup
### Install & Configure
- Standard Plugin installation; Upload .phar file to server 'plugin' folder (or upload .zip if you have latest devtools installed), restart the server, go to folder plugins/Festival;
- read [wiki on configurations](https://github.com/genboy/Festival/wiki/2.-Install,-Configure-&-Update)
#### Updates
Updates available at [poggit](https://poggit.pmmp.io/ci/genboy/Festival/Festival) and [github](https://github.com/genboy/Festival/releases)
##### !Before update always copy your config.yml and areas.json files to a save place, with this you can revert your Festival installation. Keep your old files (befor v2.0.0) for new install.
- first remove Festival folder (keep the areas.json and config.yml)
- after .phar install and first restart/reload plugins; check console info
- replace the new(empty) areas.json with your original (old) areas.json
- put your original config.yml in the Festival (or /resource) folder and remove the config.json file;
- restart server after adjusted correctly
###### Copyright [Genboy](https://genboy.net/minecraft) 2018
#### Festival Manager menu
Open th Festival menu
/fe ui
/fe menu
or get hold of the magic item in the inventory
#### Language
/fe lang
Set Festival language en/nl/es/pl/ru/fr for area and command returned messages.
en = English
nl = Nederlands
es = Español
pl = Polski
ru = русский (Russian)
fr = Français
__ = your language, please help [translate](https://github.com/genboy/Festival/tree/Translations)
#### Create area (cmd)
### Cube area
First command '/fe pos' or '/fe pos1'
and holding the magic block, default 201, tab or break a block for position 1
then command '/fe pos2'
and and holding the magic block tab or break a block to set position2,
these are the endpoints of the area longest diagonal.
/fe pos1(pos)
/fe pos2
### Sphere area
First command '/fe pos' or '/fe pos1'
For sphere radius;
holding the magic block tab or break a block for the center of the sphere
then command '/fe rad' or '/fe radius'
and and holding the magic block tab or break a block to set the radius size.
For sphere diameter;
holding the magic block tab or break a block for first end of the diameter
then command '/fe dia' or '/fe diameter'
and and holding the magic block tab or break a block for the other end of the diameter.
/fe pos
/fe rad / dia
### After position selections
Then name/save the selected area
/fe create
Now the area is ready to use
You might want to set or edit the area description line
/fe desc
#### Set area flags
fast toggle for flags: (since Festival v1.0.1-11)
/fe
Area flag defaults are set in the config.yml, server defaults and world specific default flag.
/fe flag list
#### Delete an area
/fe delete(del,remove)
#### List all area's
See all area info, optional per level
/fe list ()
#### Floating titles
Floating titles are set in the configs (menu or config.json / yml)
Toggles the titles on/off
/fe titles
#### Teleport to area
Teleporting to area center top, drop with no falldamage (if falldamage flag true)
/fe tp
#### Toggle level area's floating title display
Area floating title display (default set in config.yml)
/fe titles
#### Set description
/fe desc
#### Manage whitelist
/fe whitelist
#### Set compass
/fe compass
#### 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
##### Add a command:
/fe command add
'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 center
##### List area commands:
/fe command list
##### Edit command:
/fe command edit
##### Change command event:
/fe command event
##### Remove command:
/fe command del
---
### Updates
Updates available at [poggit](https://poggit.pmmp.io/ci/genboy/Festival/Festival) and [github](https://github.com/genboy/Festival/releases)
##### !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
- ! Update Festival 2 in development translating resource config.yml or your mainfolder config.yml and areas.json on install
## Credits
### Many thanks to all who have posted valid issues and requests!
The basic area code in Festival derives from the [iProctector plugin](https://github.com/LDX-MCPE/iProtector). Credits for the basic area creation and protection code go to the iProtector creator [LDX-MCPE](https://github.com/LDX-MCPE) and [other iProtector devs](https://github.com/LDX-MCPE/iProtector/network).
The Festival code is written and tested by [Genboy](https://www.genboy.net) and first released on 12 Feb 2018 with an area object holding events (enter and leave messages) and soon extended with 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. And players can teleport to top-center of an area.
In festival version 1.0.8 many flag functions where improved and the plugin was extended with 8 new flags, language translation options and area floating titles. During v1.0.9 to 2.1.0 many flag functions where improved, a compass-to-area option added and translations extended to en/nl/es/pl .
## Legal Notice
-- Legal notice --
For Festival the General Public License agreement version 3, as in the LICENSE file is still included and operative.
To protect this software since 27 April 2019 the Festival software package is copyrighted by Genboy.
You are legally bind to read the Festival Copyright statement.
In short this change of Copyright statement does not change the usage levels as stated in the GPU, for a part it now prohibits any entities to sell the software without the knowledge of the owner.
-- end legal notice --
###### Copyright [Genboy](https://genboy.net/minecraft) 2018 - 2019
markdown edited with [stackedit.io](https://stackedit.io) and
translated to html with [browserling.com](https://www.browserling.com/tools/markdown-to-html)