Difference between revisions of "Raid.php"

From Bebot Wiki 2
Jump to navigationJump to search
 
(11 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
==== Features ====
 
==== Features ====
  
  * List of features the module provides
+
Recently this module gained capabilities to read and store damage dump in order to feed the bot !top #5 (damage section).
 +
 
 +
You'll first need to properly set your 3rd party damage dumping tool pointing on wanted combat window textfile log. Then :
 +
 
 +
- with Tiny => click on "GlobalDump" on top right, then /gd in chat
 +
 
 +
- with AODM => ctrl+left-clic middle of violet area named "Damage Done", then /aodm in chat
 +
 
 +
Note : this will only work once & after doing !raid end (and will only include the characters that joined it).
  
  
Line 37: Line 45:
 
|!raid    |notin    |              |Warns not joined to do so            |Leader    |N/A      |Leader    |
 
|!raid    |notin    |              |Warns not joined to do so            |Leader    |N/A      |Leader    |
 
|!raid    |notinkick |              |Kicked not joined                    |Leader    |N/A      |Leader    |
 
|!raid    |notinkick |              |Kicked not joined                    |Leader    |N/A      |Leader    |
|!raid    |top      |              |Shows Leaders/Raiders Top #5        |Leader   |N/A      |Leader    |
+
|!raid    |top      |              |Shows various Top (cache 30m)        |Leader |N/A      |Leader    |
 
|!s      |          |<text>        |Shouts the text on channel          |Leader    |N/A      |Leader    |
 
|!s      |          |<text>        |Shouts the text on channel          |Leader    |N/A      |Leader    |
 +
|!c      |          |              |AO : shows a cocoon warning          |Leader    |N/A      |Leader    |
 +
|!f      |          |              |AO : shows a fence warning          |Leader    |N/A      |Leader    |
 
</pre>
 
</pre>
  
 
<sub>
 
<sub>
Notes to table:\\ You also can check !raidhistory with linked details about each ended raid.
+
Notes to table: You also can check !raidhistory with linked details about each ended raid, and also !raidstat playername for a given user details.
 +
Admins also have !raidtool to search for raids wrongly ended when they should have been cancelled ; they can furtherly delete those with !raidclear
 
</sub>
 
</sub>
  
Line 73: Line 84:
 
DiscChanId:   
 
DiscChanId:   
 
Description: What Discord ChannelId in case we separate raid alerts from main Discord channel (leave empty for all in main channel)
 
Description: What Discord ChannelId in case we separate raid alerts from main Discord channel (leave empty for all in main channel)
 +
 +
DiscTag: 
 +
Description: Should we add a Discord Tag (e.g. @here or @everyone) to raid starts for notifying Discord users (leave empty for no notification) ?
  
 
inPG:
 
inPG:
Line 103: Line 117:
 
Remonleave:
 
Remonleave:
 
Description: Automatically remove players from the raid if they leave bot's channel?
 
Description: Automatically remove players from the raid if they leave bot's channel?
 +
 +
TopAll:
 +
Description: Do we show all times Top 5 ?
 +
 +
TopCache:
 +
Specify the number of minutes before Top cache is refreshed (set to 60 by default).
 +
 +
TopDD:
 +
Description: Do we show damage Top ?
 +
 +
TopLimit:
 +
Description: Specify the shown winners for all top (limited to 5 by default).
 +
 +
TopMonth:
 +
Description: Do we show monthly Top 5 ?
 +
 +
TopYear:
 +
Description: Do we show yearly Top 5 ?

Latest revision as of 19:34, 27 August 2023

Raid.php

Description

Handles raid functions and awards raid points


Features

Recently this module gained capabilities to read and store damage dump in order to feed the bot !top #5 (damage section).

You'll first need to properly set your 3rd party damage dumping tool pointing on wanted combat window textfile log. Then :

- with Tiny => click on "GlobalDump" on top right, then /gd in chat

- with AODM => ctrl+left-clic middle of violet area named "Damage Done", then /aodm in chat

Note : this will only work once & after doing !raid end (and will only include the characters that joined it).


Commands provided
^Command  ^ Keyword  ^Argument(s)   ^Description                          ^Tell      ^Guild     ^Priv      ^
|!raid    |start     |<word(s)>     |Starts named raid                    |Leader    |N/A       |Leader    |
|!raid   |description|<word(s)>     |Renames raid                         |Leader    |N/A       |Leader    |
|!raid    |note      |<word(s)>     |Adds raid a note                     |Leader    |N/A       |Leader    |
|!raid    |end       |              |Ends a raid                          |Leader    |N/A       |Leader    |
|!raid    |cancel    |              |Cancels a raid                       |Leader    |N/A       |Leader    |
|!raid    |tank      |<name>        |Sets raid tank                       |Leader    |N/A       |Leader    |
|!raid    |move      |<number>      |Adds move in X seconds to announce   |Leader    |N/A       |Leader    |
|!raid   |showcallers|<on|off>      |Adds callers to announce             |Leader    |N/A       |Leader    |
|!raid    |showtank  |<on|off>      |Adds tank to announce                |Leader    |N/A       |Leader    |
|!raid    |check     |              |Check presence of raid participants  |Leader    |N/A       |Leader    |
|!raid    |list      |              |Shows info about raid participants   |Leader    |N/A       |Leader    |
|!raid    |reward    |<pts>         |Rewards a raid                       |Leader    |N/A       |Leader    |
|!raid    |punish    |<pts>         |Punishes a raid                      |Leader    |N/A       |Leader    |
|!raid    |pause     |              |Pauses points over time              |Leader    |N/A       |Leader    |
|!raid    |unpause   |              |Unpauses points over time            |Leader    |N/A       |Leader    |
|!raid    |join      |              |Join a raid                          |Guest     |N/A       |Guest     |
|!raid    |leave     |              |Leaves a raid                        |Guest     |N/A       |Guest     |
|!raid    |add       |<name>        |Adds player <name> to the raid       |Leader    |N/A       |Leader    |
|!raid    |kick      |<name>        |Kicks player <name> from the raid    |Leader    |N/A       |Leader    |
|!raid    |lock      |              |Locks the raid from further joins    |Leader    |N/A       |Leader    |
|!raid    |unlock    |              |Opens the raid for joins after a lock|Leader    |N/A       |Leader    |
|!raid    |notin     |              |Warns not joined to do so            |Leader    |N/A       |Leader    |
|!raid    |notinkick |              |Kicked not joined                    |Leader    |N/A       |Leader    |
|!raid    |top       |              |Shows various Top (cache 30m)        |Leader |N/A       |Leader    |
|!s       |          |<text>        |Shouts the text on channel           |Leader    |N/A       |Leader    |
|!c       |          |              |AO : shows a cocoon warning          |Leader    |N/A       |Leader    |
|!f       |          |              |AO : shows a fence warning           |Leader    |N/A       |Leader    |

Notes to table: You also can check !raidhistory with linked details about each ended raid, and also !raidstat playername for a given user details. Admins also have !raidtool to search for raids wrongly ended when they should have been cancelled ; they can furtherly delete those with !raidclear

Related commands

 * **!points** - Manage raid points. See Points.php
 * **!caller** - Manage callers for raids and events. See Callers.php


Settings

AlertDisc: Description: Do we alert Discord of raid activity ?

AlertIrc: Description: Do we alert Irc of raid activity ?

AnnounceDelay: Description: Specify the delay between raid announces.

AutoEnd: Description: After how many hours a running raid is assumed forgotten and ended automatically?

Cformat: Description: How Should the Raid Command be Output, Use and to place name and message where you want. also for new line

Command: Description: Who should be able to access the higher level raid commands (all commands except join/leave)?

DiscChanId: Description: What Discord ChannelId in case we separate raid alerts from main Discord channel (leave empty for all in main channel)

DiscTag: Description: Should we add a Discord Tag (e.g. @here or @everyone) to raid starts for notifying Discord users (leave empty for no notification) ?

inPG: Description: Do users have to be in the PG to join a Raid?

minlevel: Description: Whats the Default min level to join Raid.

MoreBots: Description: Anymore bots (sharing same DB) that should be included in the raid stats? This has to be a comma-separated list.

Points: Description: How Many points should a User get Every minute while in Raid

raidtypes: Description: List of Raid Types to show in raid control, use ; to seperate

showcallers: Description: Whats the Default for Show Callers.

showlft: Description: show LFT link next to raid join

showtank: Description: Whats the Default for Show Tank.

AddOnRejoin: Description: Automatically add players to the raid if they where in the raid but left and rejoin bot's channel?

Remonleave: Description: Automatically remove players from the raid if they leave bot's channel?

TopAll: Description: Do we show all times Top 5 ?

TopCache: Specify the number of minutes before Top cache is refreshed (set to 60 by default).

TopDD: Description: Do we show damage Top ?

TopLimit: Description: Specify the shown winners for all top (limited to 5 by default).

TopMonth: Description: Do we show monthly Top 5 ?

TopYear: Description: Do we show yearly Top 5 ?