PiggyFactions

PiggyFactions is an open-sourced factions plugin for PocketMine-MP.

Disclaimer

PiggyFactions is currently in beta. While we have tested quite thoroughly, there may exist some bugs. Please report any issue on GitHub.

Table of Contents

• Prerequisites
• Features
• Installation & Setup
• Commands and Permissions
  • Commands
  • Permissions
• Flags
• Admin Mode
• Chat Formatting
  • HRKChat Tags
  • PureChat Tags
• ScoreHUD Addon
• Issue Reporting
• Additional Information
• License

Prerequisites

• Basic knowledge on how to install plugins from Poggit Releases and/or Poggit CI
• PMMP 3.2.0 or greater
• mysql & sqlite3 PHP extensions (should already exist within your PHP binaries)

Features

Installation & Setup

1. Install the plugin from Poggit.
2. (Optional) Setup the data provider that PiggyFactions will be using. By default, PiggyFactions will use SQLite3 which requires no additional setup. If you would like to use MySQL instead, change database.type from sqlite to mysql & enter your MySQL credentials under database.mysql.
3. (Optional) You may configure certain faction features in the config.yml file.
4. (Optional) You may configure messages in the messages.yml file.
5. (Optional) You may want to setup safezones & warzones
   1. Run the command /f admin
   2. Create a faction (preferably named Safezone/Warzone)
   3. Set the appropriate flags (either safezone/warzone) with /f flag
   4. Claim chunks for their respective types
   5. Leave the faction
6. You're done!

Commands

Permissions

Flags

Admin Mode

To enable Admin mode, use the command /f admin. Admin mode will allow you to modify claimed faction lands, forcibly unclaim faction lands, etc. Nearly all commands have support for admin mode.
NOTE: /f admin should be toggled off when you are not using it to prevent accidental modifications. Admin mode will automatically be disabled upon server restart.

HRKChat Tags

Sample Format: &6{{piggyfacs.rank.symbol}}{{piggyfacs.name}} &r&7{{hrk.displayName}}&r: {{msg}}

PureChat Tags

You will need to download our fork of PureChat for PiggyFactions integration, which can be downloaded here.
Sample Format: &6{fac_rank}{fac_name} &r&7{display_name}&r: {msg}

ScoreHud Addon

An addon for JackMD's ScoreHud can be found here.

Issue Reporting

• If you experience an unexpected non-crash behavior with PiggyFactions, click here.
• If you experience a crash in PiggyFactions, click here.
• If you would like to suggest a feature to be added to PiggyFactions, click here.
• If you require support, please join our discord server here.
• Do not file any issues related to outdated API version; we will resolve such issues as soon as possible.
• We do not support any spoons of PocketMine-MP. Anything to do with spoons (Issues or PRs) will be ignored.
  • This includes plugins that modify PocketMine-MP's behavior directly, such as TeaSpoon.

Additional Information

• We do not support any spoons. Anything to do with spoons (Issues or PRs) will be ignored.
• We are using the following virions: Commando, libasynql, and libFormAPI.
  • Unless you know what you are doing, use the pre-compiled phar from Poggit-CI and not GitHub.
  • If you wish to run it via source, check out DEVirion.

License

   Copyright 2020 DaPigGuy

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

"Castle" vector graphic used in the banner and icon is licensed under the Pixabay License.