Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/foxworn3365/worldguard
Protect specific regions from one or more events with WorldGuard for PocketMine-MP!
https://github.com/foxworn3365/worldguard
anti-grief guard plugin pmmp pmmp-plugin pocketmine pocketmine-mp pocketmine-mp-5 woldguard world
Last synced: about 21 hours ago
JSON representation
Protect specific regions from one or more events with WorldGuard for PocketMine-MP!
- Host: GitHub
- URL: https://github.com/foxworn3365/worldguard
- Owner: FoxWorn3365
- License: agpl-3.0
- Created: 2023-06-19T20:43:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-27T12:15:46.000Z (over 1 year ago)
- Last Synced: 2024-09-22T15:31:26.362Z (5 days ago)
- Topics: anti-grief, guard, plugin, pmmp, pmmp-plugin, pocketmine, pocketmine-mp, pocketmine-mp-5, woldguard, world
- Language: PHP
- Homepage: https://poggit.pmmp.io/p/UltimateWorldGuard
- Size: 79.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://dev.bukkit.org/projects/worldguard) 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 ` |
| player | <REGION NAME> <PLAYER> | Add or remove a player from the region's whitelist | `/region player ` |
| create | <REGION NAME> | Initialize a region creation, now you'll need to define the area with `/wg pos1`! | `/region create ` |
| delete | <REGION NAME> | Delete a region | `/region delete ` |
| flags | <REGION NAME> | Display all region's flags. Kide outdated, instead use `/flags ` | `/region flags ` |
### /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> | <FLAG> | Add or remove a flag from the selected region | `/flags ` |
## Demonstration Video
On YouTube at [this link](https://youtu.be/GqM56QtxDsA)
## 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 ` 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)!
3. Manage flags with `/flags `
## How to: add a player to the whitelist
Easy:
```
/rg player
```
## 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](https://it.wikipedia.org/wiki/ISO_639) standards or [ISO 639-2](https://it.wikipedia.org/wiki/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](https://github.com/FoxWorn3365) |
| Italian (IT) | `it` | [FoxWorn3365](https://github.com/FoxWorn3365) |
## Useful links
- [Poggit CI page](https://poggit.pmmp.io/ci/FoxWorn3365/WorldGuard/);
- [Poggit](https://poggit.pmmp.io/)
## Contacts
Feel free to contact me via:
- Discord: `@foxworn`
- Email: `[email protected]`