search

genboy / Festival

Custom events plugin for Pocketmine
https://genboy.net/minecraft/festival/
Other
39 stars 15 forks source link
area command flags minecraft plugins pmmp

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

Festival plugin logo large

Copyright Genboy 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 to fix any usability problems before posting a vote! 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, home of Festival

The Festival Plugin is released on poggit

See and make reviews @ poggit and post your issues @ github - Average time to resolve an issue Percentage of issues still open

Festival 2.1.0 Command usage

Overview

version 2.1.2

version 2.1.1

version 2.1.0

version 2

Festival Manager Menu (UI + select item) - or use the commands

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 - 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 Please report bugs -thank you! issues @ github and/or reviews @ poggit

or use devtools plugin and download zip package https://github.com/genboy/Festival/archive/master.zip

Features

Menu In version 2.0.0 the Festival Management Menu (FormUI) is introduced

Config

Area

Flags

Events & Commands

Level flags

Menu (UI)

Festival Menu

Festival main menu

Start menu select management option

Teleport

Select teleport destination

Select teleport destination

Areas

Area management option menu

Area option menu

Select area to manage

Select area

Manage area settings

Edit area settings

Manage area flags

Edit area flags

Manage area commands

Manage commands for area events

Add command

Edit or add commands to area

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)

Edit or add commands to area

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

Manage area whitelist

Set players on or off area whitelist (this is in development)

Select area to delete

Delete area

Confirm to delete area

Cofirm area delete

Create

Select new area type

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)

Create area with name and description

Levels

Turn on level flag control to use the level flags (instead of defaults) festival-use-level-flags

Select level to manage flags (if levelcontrol config is on)

Select level

Manage level flags options

Manage Level use option and flags Edit level flags(defaults)

Configuration

UI configuration to set overall options and default flags for levels and area's festival-set-configs-default-flags

Manage Festival configuration options and set default flags

Manage configuration

Copyright Genboy 2018 - 2019 - markdown edited with [stackedit.io]

Usage

Festival 2.1.0 Command usage

Setup

Install & Configure

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. Keep your old files (befor v2.0.0) for new install.

Festival Manager menu

Open th Festival menu

/fe ui
/fe menu

or get hold of the magic item in the inventory

Language

/fe lang <en/nl/es/pl/ru/fr>

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

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 <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

fast toggle for flags: (since Festival v1.0.1-11)

  /fe <edit/hurt/pvp/flight/touch/mobs/animals/effect/tnt/fire/explode/shoot/drop/msg/pass/hunger/perms/fall/cmd> <AREANAME>

Area flag defaults are set in the config.yml, server defaults and world specific default flag. 

  /fe flag <AREANAME> list

Delete an area

  /fe delete(del,remove) <AREANAME>

List all area's

See all area info, optional per level

  /fe list (<LEVELNAME>)

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 <AREANAME>

Toggle level area's floating title display

Area floating title display (default set in config.yml)

/fe titles

Set description

/fe desc <AREANAME> <DESCRIPTION>

Manage whitelist

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

Set compass

/fe compass <AREANAME/(reset/spawn)>

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>

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

Credits

Many thanks to all who have posted valid issues and requests!

The basic area code in Festival derives from the iProctector plugin. Credits for the basic 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 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 2018 - 2019

markdown edited with stackedit.io and
translated to html with browserling.com