|
| 1 | +<!-- define variables --> |
| 2 | +[1.1]: http://i.imgur.com/M4fJ65n.png (ATTENTION) |
| 3 | + |
| 4 | +# Webhook Data Receiver |
| 5 | + |
| 6 | +![alt text][1.1] <strong><em>`The contents of this repo are a proof of concept and are for educational use only, all copyrights belong to their respective owners.`</em></strong>![alt text][1.1]<br/> |
| 7 | + |
| 8 | +## This bot requires intermediate knowledge of discord and bots. You will need a minimun of TWO bot tokens, one for channels and one for subscriptions. This is **not** for a beginner user. You will not receive beginner level support for this. |
| 9 | + |
| 10 | +# Installation: |
| 11 | +## 1: `git clone https://gitlab.com/webhookdatareceiver/Webhook-Data-Receiver.git/` to desired location or download the zip and unzip. |
| 12 | + |
| 13 | +## 2: cd to the new WebhookDataReceiver folder |
| 14 | + |
| 15 | +## 3: Type `node -v` in your terminal to determine if node is installed on your machine. |
| 16 | + - If not or version is less than 10.14, upate or download node.js from here: https://nodejs.org/en/ |
| 17 | + - Type `node -v` again in your terminal post install to confirm installation. |
| 18 | + |
| 19 | +## 4: Install npm package requirements. |
| 20 | + - Run `npm install` in your cloned directory. |
| 21 | + |
| 22 | +## 5: Edit the Config files and save them without the `.example` on them. |
| 23 | + - Emotes.ini |
| 24 | + You will need to join emoji servers, or add the emoji to your own server: |
| 25 | + https://discord.gg/zqVCfPy - WEATHER, TEAMS, GYMS, TYPES |
| 26 | + https://discord.gg/AnECN8U - Legendary boss emojis |
| 27 | + - Discords.json |
| 28 | + - You need to add each Discord you plan on serving. WebhookDataReceiver is multi-discord capable. The geofence should encompass the whole area that the discord covers. Must be in geojson format. |
| 29 | + - Geojson.json |
| 30 | + - Geofences of areas to label your pokemon/raid/quest posts with and for users to subscribe to alerts with. |
| 31 | + - Go to http://geojson.io/ and draw your geofences. You MUST add a "name" field to each geofence. If you want to use sub areas (smaller detailed geofences within larger geofences), you must add a sub_area field and then true or false as the value. All geofences must be in geojson format. |
| 32 | + - config.ini |
| 33 | + - All directions for this files are contianed within this file. |
| 34 | + - Make sure to create bot tokens (2 min) at https://discordapp.com/developers/applications/ |
| 35 | + - Grant Permissions and invite bots to all servers you will be running on. (Bot needs administrator privileges) https://finitereality.github.io/permissions-calculator/?v=0 |
| 36 | + |
| 37 | +## 6: Channels |
| 38 | + - Fill out each channels.ini file with the channels, chosen filter, and areas. If you do not want to filter by area, use the name that you gave your discord in discords.json. |
| 39 | + - channels_pokemon.ini |
| 40 | + - channels_raids.ini |
| 41 | + - channels_quests.ini |
| 42 | + - channels_lures.ini |
| 43 | + - channels_invasion.ini |
| 44 | + |
| 45 | +## 7: Filters |
| 46 | + In /filters you will find examples of spawns, quest, and raid feeds. These files can be named whatever you want, there is no more name requirement. These are spawn filters based on PA type, also with a min_iv and max_iv override. If you do not include a Channel_ID, the bot will ignore the filter. |
| 47 | + |
| 48 | + #### Quests |
| 49 | + - The "Type" field must be "quest". |
| 50 | + - Quest feeds can be filtered by reward and/or encounter. Add each reward our encounter to the "Rewards" array. |
| 51 | + - They are case sensitive, so please see examples. Refer to /static/en.json for all rewards. |
| 52 | + |
| 53 | + #### Raids |
| 54 | + - The "Type field must be "raid". |
| 55 | + - Raids can be filtered by type, levels, and ex eligibility. |
| 56 | + - If you DO NOT want to filter by Ex Eligibility, REMOVE the "Ex_Eligible" field completely from the filter. |
| 57 | + - You can add as many or as few levels to the filter as you with 1-5 as the examples show. |
| 58 | + - The "Egg_Or_Boss" field must be set to either "boss" or "egg". |
| 59 | + |
| 60 | + #### Spawns |
| 61 | + - This WebhookDataReceiver uses PA type filters with some overrides in the config. |
| 62 | + - The "Type" field must be "monster". |
| 63 | + - You must set the min_iv and max_iv for the filter. Defaults `0` and `100`. |
| 64 | + - You must set the min_level and max_level for the filter. Defaults `0` and `35`. |
| 65 | + - More specific IVs can be set for each monster (replace `True`/`False` with `{"min_iv":"80"}`), but that value must be within the min_iv and max_iv you set. |
| 66 | + - You can set the bot to post without IVs using the "Post_Without_IV" field. Set this to `true` or `false`. |
| 67 | + |
| 68 | +## 8: Start the bot. `pm2 start wdr.js` |
| 69 | + - If you get errors that are not because of missing configs, Contact me via discord. |
| 70 | + - PM2 Docs http://pm2.keymetrics.io/docs/usage/cluster-mode/ |
| 71 | + |
| 72 | +## Subscriptions |
| 73 | + |
| 74 | +- Subscription commands can only be used in the command channel set in the discords.json. |
| 75 | +- Type `.help` (or whatever prefix you set) for command instructions. |
| 76 | +- Rewards that users can subscribe to are set in `quest_config.json` in the configs folder. These are case sensitive and the Encounter rewards must state "Encounter" after the monster name just as the example shows. |
0 commit comments