Skip to content
This repository has been archived by the owner on Jun 14, 2024. It is now read-only.

Commit

Permalink
merge github change
Browse files Browse the repository at this point in the history
  • Loading branch information
crhbetz committed May 20, 2021
2 parents cbfcaaa + 6c4f874 commit 52be3a1
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# mp-poraclePvpHelper
This MAD plugin exists to pass RDM-like PvP data to PoracleJS using webhooks. It targets the PvP Stats Tracking implementation in
This MAD plugin exists to pass RDM-like PvP data to PoracleJS using webhooks. It targets the PvP Stats Tracking implementation in the now merged
[PoracleJS PR #151](https://github.com/KartulUdus/PoracleJS/pull/151) / [PR #206](https://github.com/KartulUdus/PoracleJS/pull/206)
and complies with its formats, emulating the behaviour of [RDM PR #120](https://github.com/RealDeviceMap/RealDeviceMap/pull/120).

As of version 2.0, the calculations part has been moved to a separate project called [PogoPvpData](https://github.com/crhbetz/PogoPvpData), which is linked in as a submodule.

## Installation
This project can now be cloned directly into your MAD/plugins folder. Downloading and distributing `.mp` files for an active project seems a little tedious to me, so this will be the primary way of distribution for this plugin. I may occasionally upload one as a release though.
This project can now be cloned directly into your MAD/plugins folder using the following command - [please also note the command for updating](#updating):

After installation, the usual procedure for MAD plugins applies. Copy the `plugin.ini.example` to `plugin.ini` and edit it to your personal preferences.
```git clone --recurse-submodules https://github.com/crhbetz/mp-poraclePvpHelper.git```

Downloading and distributing `.mp` files for an active project seems a little tedious to me, so cloning and pulling updates from GitHub will be considered the primary way of distribution for this plugin. I'll try to keep up with `.mp` [releases](https://github.com/crhbetz/mp-poraclePvpHelper/releases) though.

After installation, the usual setup procedure for MAD plugins applies. Copy the `plugin.ini.example` to `plugin.ini` and edit it to your personal preferences.

It is recommended to deactivate regular pokemon webhooks to endpoint(s) you're sending to with this plugin, because it sends all the pokemon
data the usual webhook worker would send, enhanced with the additional pvp data. Sending the same data through two different webhook
Expand All @@ -29,7 +33,7 @@ Updating your installation including the submodule through git will require the
The plugin saves its `PokemonData` object to a file called `.data.pickle` within the plugin directory to aviod having to repeat the rather heavy calculations for every run of your MAD instance.
To apply certain settings or load new Pokemon / Stats / Forms, a re-calculation of the previously mentioned data will be necessary. Settings that require a recalc
will be commented accordingly in the `plugin.ini.example` file.
To achieve a recalc, delete the `.data.pickle` file and restart your MAD instance. A new initial calculation will start.
To achieve a recalc, delete the `.data.pickle` file and restart your MAD instance. Recalculation will be done according to your `precalc` setting.

## Multi-instance setup
This plugin is able to run across multiple MAD instances from the same MAD directory. Settings can be made instance-specific by naming a settings category
Expand Down

0 comments on commit 52be3a1

Please sign in to comment.