Skip to content

Protect specific regions from one or more events with WorldGuard for PocketMine-MP!

License

Notifications You must be signed in to change notification settings

FoxWorn3365/WorldGuard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WorldGuard

Protect specific regions from one or more events with WorldGuard for PocketMine-MP!

⚠️ We are not in any way related to the WorldGuard plugin for Bukkit!

Features

  • Possibility of creating regions with different flags
  • A lot of flags! (43)
  • Region whitelist
  • Easy region definition!

Commands

Name Alias Args Description
worldguard wguard / wg [info|pos1|pos2] The base command, also used for region definition!
region rg / wrg [info|player|create|delete|flags] <REGION NAME> The region management command
flags none <REGION NAME> <FLAG> Add or remove a flag from a region, if the flag is empty displays all flags of the region

/region

Name Args Description Command
info <REGION NAME> Display region's informations /region info <REGION NAME>
player <REGION NAME> <PLAYER> Add or remove a player from the region's whitelist /region player <REGION NAME> <PLAYER>
create <REGION NAME> Initialize a region creation, now you'll need to define the area with /wg pos1! /region create <REGION NAME>
delete <REGION NAME> Delete a region /region delete <REGION NAME>
flags <REGION NAME> Display all region's flags. Kide outdated, instead use /flags <REGION NAME> /region flags <REGION NAME>

/flags

Name Args Description Command
none none Displaya all available flags /flags
<REGION NAME> none Display all flags for the selected region /flags <REGION NAME>
<REGION NAME> <FLAG> Add or remove a flag from the selected region /flags <REGION NAME> <FLAG>

Demonstration Video

On YouTube at this link

How to: create a region

Defining regions is one of the key parts of the plugin as they then allow you to add or remove flags.
Here are the steps you need to take:

  1. Run the /rg create <NAME> command to define a new region
  2. Now define the region area with /wg pos1 and /wg pos2

Note
Regions are 2D so you don't need to define also the height (y)!

  1. Manage flags with /flags <NAME>

How to: add a player to the whitelist

Easy:

/rg player <REGION NAME> <PLAYER NAME>

Bug reporting

Please report bugs only via the GitHub issues of this repository and not in DMs on discord or via email!
When you score a bug, please include:

  • The download source of the plugin (GutHub or Poggit)
  • All files inside the plugin_data/WorldGuard/ folder
  • The full error code
  • A simple guide to know how to reproduce the bug
  • (Optional) the WorldGuard.phar

Contributing

I welcome any contribution and here are two guides for contribution:

Translation contribution

If you decided to help with the translation then free to create a pull request where you edit the src/FoxWorn3365/WorldGuard/languages.json file and also the README.md updating the list of translators by adding the language.
The name must follow ISO 639-1 standards or ISO 639-2 in the case of dialects.
Correct:

[...]
    "roa":{ // The ligurian language, a dialect
      [...]

Correct:

[...]
    "es":{ // Spanish language, a global and official language
    [...]

Wrong:

[...]
    "roa-IT":{ // Yes, Ligurian is an Italian dialect but the format is wrong!
    [...]

Wrong:

[...]
    "spa":{ // Yes, this is also a global language (spanish) BUT because of this it's mandatory to use the ISO 639 standard!
    [...]

Coding contribution

To contribute to the code, it is mandatory to meet these parameters:

  • Clean code
  • Comment what you do please
  • Update the "file header" if you edit the scope or if you create new files
  • Please explain what you've changed in the pull request!

Languages

Language Code Contributors
English (US) en FoxWorn3365
Italian (IT) it FoxWorn3365

Useful links

Contacts

Feel free to contact me via:

  • Discord: @foxworn
  • Email: foxworn3365@gmail.com