Skip to content

Commit

Permalink
PiggyFactions: Update Addons
Browse files Browse the repository at this point in the history
Version: 2021.3.25
Release: 2020.3.25-dev03
  • Loading branch information
Aericio committed Mar 26, 2021
1 parent e686af0 commit 38dd912
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 9 deletions.
1 change: 1 addition & 0 deletions assets/piggyfactions/tgn/addons-scorehud-v5.tgn
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"rows_views":[[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}]],"model":{"rows":[[{"value":"Tag","cspan":1,"rspan":1,"markup":[3,3]},{"value":"Description","cspan":1,"rspan":1,"markup":[3,11]}],[{"value":"``{faction}``","cspan":1,"rspan":1,"markup":[3,13]},{"value":"The faction's name.","cspan":1,"rspan":1,"markup":[3,19]}],[{"value":"``{faction_rank}``","cspan":1,"rspan":1,"markup":[3,18]},{"value":"Your rank in the faction.","cspan":1,"rspan":1,"markup":[3,25]}],[{"value":"``{faction_power}``","cspan":1,"rspan":1,"markup":[3,19]},{"value":"The faction's current power.","cspan":1,"rspan":1,"markup":[3,28]}]]},"theme":null,"fixed_layout":false,"markup":{"instances":[{},null,null,{"style":{"fontWeight":"","fontStyle":"","textDecoration":"","color":"","backgroundColor":""}}]},"options":{"table_caption":"","table_label":"tab:my-table"}}
1 change: 1 addition & 0 deletions assets/piggyfactions/tgn/addons-scorehud-v6.tgn
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"rows_views":[[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"center","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}],[{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}},{"style":{"borders":"lrtb","font_style":{},"text_color":"","bg_color":"","halign":"left","valign":"top","padding":{"top":10,"right":5,"bottom":10,"left":5},"border_color":""}}]],"model":{"rows":[[{"value":"Tag","cspan":1,"rspan":1,"markup":[3,3]},{"value":"Description","cspan":1,"rspan":1,"markup":[3,11]}],[{"value":"``{piggyfactions.faction_name}``","cspan":1,"rspan":1,"markup":[3,32]},{"value":"The faction's name.","cspan":1,"rspan":1,"markup":[3,19]}],[{"value":"``{piggyfactions.faction_rank}``","cspan":1,"rspan":1,"markup":[3,32]},{"value":"Your rank in the faction.","cspan":1,"rspan":1,"markup":[3,25]}],[{"value":"``{piggyfactions.faction_power}``","cspan":1,"rspan":1,"markup":[3,33]},{"value":"The faction's current power.","cspan":1,"rspan":1,"markup":[3,28]}]]},"theme":null,"fixed_layout":false,"markup":{"instances":[{},null,null,{"style":{"fontWeight":"","fontStyle":"","textDecoration":"","color":"","backgroundColor":""}}]},"options":{"table_caption":"","table_label":"tab:my-table"}}
4 changes: 2 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@
# built documents.
#
# The short X.Y version.
version = '2020.9.19'
version = '2021.3.25'
# The full version, including alpha/beta/rc tags.
release = '2020.9.19-dev02'
release = '2021.3.25-dev03'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
42 changes: 38 additions & 4 deletions source/plugins/piggyfactions/docs/addons.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,47 @@
Addons
======

ScoreHud Addon
--------------
ScoreHud v6
-----------

ScoreHud support is enabled out-of-the-box and no setup is required on PiggyFaction's part.

.. table::
:align: center

+-----------------------------------+------------------------------+
| Tag | Description |
+===================================+==============================+
| ``{piggyfactions.faction_name}`` | The faction's name. |
+-----------------------------------+------------------------------+
| ``{piggyfactions.faction_rank}`` | Your rank in the faction. |
+-----------------------------------+------------------------------+
| ``{piggyfactions.faction_power}`` | The faction's current power. |
+-----------------------------------+------------------------------+

ScoreHud v5 (Legacy)
--------------------

* An addon for JackMD's `ScoreHud`_ can be downloaded at `DaPigGuy/PiggyFactionsAddon.php`_.

* To learn how to install ScoreHud addons, see `ScoreHud#how-to-use-addons`_.
* Installation instructions can be found at `ScoreHud/v5#how-to-use-addons`_.
* Users on ScoreHud v5 should consider updating to ScoreHud v6 for better performance.
* Differences between v5 and v6 can be found at `ScoreHud#version-60-update`_.

.. table::
:align: center

+---------------------+------------------------------+
| Tag | Description |
+=====================+==============================+
| ``{faction}`` | The faction's name. |
+---------------------+------------------------------+
| ``{faction_rank}`` | Your rank in the faction. |
+---------------------+------------------------------+
| ``{faction_power}`` | The faction's current power. |
+---------------------+------------------------------+

.. _ScoreHud: https://github.com/JackMD/ScoreHud
.. _DaPigGuy/PiggyFactionsAddon.php: https://gist.github.com/DaPigGuy/07442f8b98a70e5973a528e4516e35d1
.. _ScoreHud#how-to-use-addons: https://github.com/JackMD/ScoreHud#how-to-use-addons
.. _ScoreHud/v5#how-to-use-addons: https://github.com/Ifera/ScoreHud/tree/v5#how-to-use-addons
.. _ScoreHud#version-60-update: https://github.com/Ifera/ScoreHud#version-60-update
2 changes: 1 addition & 1 deletion source/plugins/piggyfactions/docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ DTR / Death to Raidable?

This will be created in a separate addon for PiggyFactions. We do not have an ETA for the addon currently since it's low priority.

.. _Claiming#Overclaiming: /plugins/piggyfactions/docs/functionality/claiming.html#overclaiming
.. _Claiming#Overclaiming: functionality/claiming.html#overclaiming
6 changes: 4 additions & 2 deletions source/plugins/piggyfactions/docs/prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Requirements

* `DaPigGuy/libPiggyEconomy`_: 2.0.0+
* `ParoxityTeam/Commando`_: 2.1.0+
* `poggit/libasynql`_: 3.3.0+
* `poggit/libasynql`_: 3.3.1+
* `jojoe77777/FormAPI`_: 1.3+

Soft Dependencies
Expand All @@ -22,6 +22,7 @@ Soft Dependencies
* `PiggyCustomEnchants`_: 2.1.1+
* `HRKChat`_: 1.1.1+
* `PureChat`_: :download:`PR-17 <https://poggit.pmmp.io/r/95436/PureChat_pr-17.phar>`
* `ScoreHud`_: 6.1.0+

.. note::
You **must** use Poggit-CI :guilabel:`PR-17` build for PureChat support and set ``default-factions-plugin`` to ``PiggyFactions``.
Expand All @@ -38,4 +39,5 @@ Soft Dependencies
.. _jojoe77777/FormAPI: https://github.com/jojoe77777/FormAPI
.. _PiggyCustomEnchants: https://poggit.pmmp.io/p/PiggyCustomEnchants
.. _HRKChat: https://github.com/CortexPE/HRKChat
.. _PureChat: https://github.com/Heisenburger69/PureChat
.. _PureChat: https://github.com/Heisenburger69/PureChat
.. _ScoreHud: https://poggit.pmmp.io/p/ScoreHud

0 comments on commit 38dd912

Please sign in to comment.