Eat-This!
User Info
Welcome, Guest. Please login or register.
February 18, 2019, 06:23:00 pm

Login with username, password and session length
Search:     Advanced search
News
Join our Teamspeak 3 server at s3.eat-that.org:9987 !
Forum Stats
1,979 Posts in 283 Topics by 172 Members
Latest Member: Barbarabiz
Home Help Search Login Register
Eat-This!  |  General Category  |  Official Information  |  GatherBot Commands, information
« previous next »
Pages: [1] 2 Print
Author Topic: GatherBot Commands, information  (Read 8159 times)
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« on: November 14, 2012, 10:33:44 am »

Gather Bot - Public Commands
For mode-specific Gather Bot commands, see each Gather mode's specific GatherBot topic.
For admin commands, see the admin forum.

command
Adding to / removing from Gather
description / notes

W

G

U

O
!addAdds you to the gather if a slot is available.
If you are already added for rematch play, !add switches you to regular play.
You can use !add <mode> to make sure you aren't added to a mode different from the one you want to play.  E.g. if the current mode is MM with 3/4 players added, '!add ttw' will make sure you don't accidentally start a gather you do not wish to play.
If the gather has already been set up, it may still be possible to add.  See !maxsize for details.
GEfAgB
!delRemoves you from the gather slot.GEfAG
!rematchAdds you to the gather for rematch play if a slot is available and you played in the previous gather.
If you are already added for regular play, !rematch switches you to rematch play.
An accepted rematch overrides various other commands, such as the balancer and map votes
For more information on rematch gathers, see the appropriate section below.
GEfAgPB
!subAdds you to the gather as a Substitute player if one is requested.
As a substitute player, the gather won't count towards your own stats.
GLEfAgB
!linkReports the soldat:// link you can use to join the gatherGLPEFAG
!liveLets the Gather Bot invite you to the Live Channel if a gather is currently being played.
If you are currently in the Gather and it is being played, you cannot use this command.
GLPEFAgB
!spec
!spect
Allows you to join the gather as a Spectator.GEA
!del <nick>For Admins and Ops only: Allows an Admin or Op to forcibly remove a player from a Gather slot.GEfA $/@ G
!delsubFor Admins and Ops only: Allows an Admin or Op to forcibly undo the request for a Substitute player.GEFA $/@B


command
Gather setup commands
description / notes

W

G

U

O
!mode
!gathermode
!gamemode
Reports the currently active Gather modeG
!mode <mode> [size]
...
Changes the currently active Gather mode and optionally sets the desired gather size.
There is a rate limit on gather mode switching.
During the time it takes for the gather mode to change on the server, the gather will be disabled - you cannot add during this time.

GEfAGB
!fmodeFor Admins and Ops only: Forces a change of the currently active Gather mode.
Can only be used if the gather is not full
GEfA $/@B
!statusReports the current status of the Gather - whether it is not yet full, being set up or currently running (in which case basic statistics about the Gather being played are shown).
If a gather is not yet being played, shows available and occupied slots.
If a gather is about to start, shows a message saying the gather is about to start.
If a gather is currently being played, shows the gather's statistics and (estimated) time remaining.
See each Gather Mode's GatherBot topic for details on that mode's status message
GLPEB
!teamsReports the players and the team they're in for the current Gather.GLPEB
!sizeReports the current size of (number of slots in) the Gather.GLP
!size <size>Changes the size of number of slots in) the Gather.
Players occupying Gather slots will be retained, unless the new size is smaller than the current number of players minus 1 - in which case the slots will all be freed
You have to be in a Gather slot to use this command, unless you're an Admin.
Size 2 gathers are for 1v1 fun only - results are not counted toward your Statistics.
Note: Setting the size is subject to the minimum and maximum allowed size as set by the admins.  By default these are minimum:2, maximum:10.
Note: You can upsize a gather at any time, you can only downsize a gather to current number of players + 1 at best; this is to prevent a size6 with 4 players from automatically starting if somebody tried to change to size4.
GfAG
!maxsizeReports the current maximum size of (maximum number of slots in) the Gather.GLP
!maxsize <size>Changes the maximum size of (maximum number of slots in) the Gather.
A !maxsize larger than !size allows players to add after the gather has been set up if it has not actually started yet.  The additional players will be assigned teams based on the balancer.  Note that generally it's preferable, if a larger gather is desired, to reset and start anew.  However, this requires cooperation from the whole team with inherent details.  Post-setup/pre-start adding simply adds the two new 'extra players'.
If a single 'extra player' adds, GatherBot will note this in status message and wait for a second 'extra player'.  Only if a second 'extra player' adds will both 'extra players' be included in the Gather.  If the gather starts with only a single 'extra player' added, that player will be notified that the Gather has started without them.
GfAG
!votemap <mapname>Casts your vote for a specific map, in case you don't like the current selection (seen when using !status or when adding yourself to a Gather slot).
For a list of maps, see the !maplist command.  For more information about map voting, see the appropriate section below.
GEfAG
!mapvotesReports the currently cast map votes.G
!resetCasts your vote to reset the gather.  For example if players fail to show up and no substitutes can be found.
4 votes are required to pass a reset vote.  Admins can always reset the gather using !freset
GFAG
!unresetRemoves your vote to reset the gather, if cast.GFAG
!onEnables the Gather if it is currently disabled due to a Socket Error.
If the Gather is disabled for another reason, only Admins and ops can re-enable the gather.
GLA [$/@]
!fresetFor Admins and Ops only: Allows an Admin or Op to forcibly reset the Gather.GA $/@
!startgatherFor Admins and Ops only:Allows an Admin or Op to forcibly re-start the Gather.
A new server password will be used and a new link set to the players added to the Gather.
GEFA $/@B
!fmap <map>For Admins and Ops only: Allows an Admin or Op to forcibly set a map on the Gather server.GA $/@
!fixtotalFor Admins and Ops only: In the event the Gather Statistics website is manually adjusted, use this command to make the Gather Bot sync with the website for the correct Gather number.GLA $/@


command
Map commands
description / notes

W

G

U

O
!maplist
!mapslist
!listmaps
!maps

Reports the maps in the map cycle used by the Gather Bot when selecting 'random' maps, as well as all maps you can vote for.
To vote for a map, see !votemap
The map cycle prevents the last 1/3rd of played maps from being selected again, so it is not entirely random.
GLP
!mapstats <map>|*Reports statistics / preview image for the given map.
As with !votemap, you can specify a partial map name.
If specifying * as the map, generic map stats (most played, least played, average time for all maps at current size) is shown instead.
GLP


command
Gather and User statistics
description / notes

W

G

U

O
!prevgather [ID]Reports the previous gather's statistics - its gather number, how long ago it was played and on which map, etc.
Optional ID parameter gives that Gather's statistics, if available, to the extent available
See each Gather Mode's GatherBot topic for details on that mode's statistics
GLP


command
Gather Bot commands
description / notes

W

G

U

O
!commandsReports a short list of these commands.GLP
!rec [nick]Forces the Gather Bot to re-(recognize) your Auth, or that of the given user.
The Gather Bot will automatically attempt to recognize your Auth when you join the channel.  You would only need to use this command if the Gather Bot got confused in a netsplit, for example.
GLPA
!goFor Admins, Ops and Voiced only: causes the Gather Bot to attempt a connection with the Gather Server.
Admins can use this command to force a re-connection even if the bot is already connected.
GLA $/@/+b


command
Live channel commands
description / notes

W

G

U

O
!parameterReports the events that should be shown in the Live channel, such as bunker conquers, task changes, etc.
Green parameter events are enabled, red ones are disabled.
L
!parameter on|off eventnameEnables / Disables the given event.
You can enable / disable all events by using * as the event name.
L


command
Miscellaneous
description / notes

W

G

U

O
!bug <message ...>Records the bug mentioned.  Note that while this is primarily for the Gather Bot, feel free to report other bugs - they'll make their way to the appropriate people/forum sections eventually.
This command also works in-game.
!gsay <message ...>For Admins and Ops only: Sends the given message to the Gather Server.GLA $/@B
!countdown <parameters>For Admins and Ops only: Starts/stops a given countdown.  Please see the !countdown update for details.GA $/@
!random <element 1> <element 2> [element 3 ...]Random number generator / element picker.
  • if used as !random N M, returns a random integer in the range N through M (inclusive)
  • if used as !random N.f M.f, returns a random floating point value in the range N.f through M.f (inclusive)
  • if used as !random X Y [Z ...], returns a random selection of the input arguments.
G
!ircserverReports the IRC server the bot is connected to.  You may wish to connect to the same server to prevent netsplits causing gather messages to be missed.G


command
In-game commands
description / notes




!irc <message ...>Sends a message to the IRC gather channel
!teamsReports the teams (server) as well as any missing players (bot).  The bot will also automatically notify any missing players that they are missing from the gather and asks them to join asap.
!ident <IRCauth>If the GatherBot doesn't recognize you, it will ask you to identify with your IRC auth using this command.  This is only required for statistics, grapher, etc.
Try not to identify as somebody else :)

Some commands only work in certain channels and under certain circumstances.  Generally you don't have to worry about this as it will usually make sense (e.g. you can't !add to a Gather that is Full because, well, it's full).
If you do use a command in the wrong place / at a time you can't, The Gather Bot will typically throw you a friendly error message reminding you that you can't use that command there/at that time.
Nevertheless, for a full list of conditions, look no further than the WGUO columns behind the commands.  These contain flags, and those flags are explained here.
W (Where) column:
  G = Gather Channel - #soldat.eat-this!
  L = Live Channel - #ttw.live (during gathers you must use !live in the Gather Channel, and not be a gather player, to be invited)
  P = Private Messages - /query GatherBot
G (Gather) column
  O = Ongoing - gather must have started
  o = NOT ongoing - gather must not have started
  F = Full - gather must be full
  f = NOT full - gather must not be full
  E = Enabled - gather must be enabled
  e = NOT enabled - gather must be disabled
U (User) column
  A = Authed - you must be authed
  G = Gather player - you must be added to the gather slots
  g = NOT gather player - you must not be added to the gather slots
  P = Previous gather - you must have played in the previous gather
  + = voiced - must be voiced in the Gather channel
  @ = op - must be opped in the Gather channel
  $ - admin - must be a Gather Bot admin
O (Other) column
  B = Bot - Gather Bot must be connected to the Gather Server
  b = Bot - Gather Bot must not be connected to the Gather Server
« Last Edit: January 07, 2014, 04:16:37 pm by KamiquasiSteve » Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #1 on: November 14, 2012, 10:34:01 am »

Gather Rematches
Gather Rematches allow those who have just finished playing a Gather, and want a rematch, to vote for a Gather Rematch.  In a Gather Rematch, all of the players who voted for a rematch (hopefully all of the ones that just played) will be placed in the same teams, on the same map that was just played, but on opposing sides; those who were in Alpha will be in Bravo, those who were in Bravo will be in Alpha.
So if you think the map is unbalanced - prove it, play a rematch from the opposite side of the map.  If your cat walked on your keyboard and caused you to fail - move the cat, and demand a rematch.  If you want to play a best-out-of-3 and each side wins one Gather, go for broke, and play two Gather Rematches in a row!

For a TTW Gather Rematch vote to succeed, two third of the players on each team should be voting for a !rematch.
That works out to the following:
Size 2: both players must vote !rematch
Size 4: all four players must vote !rematch
Size 6: two alphas and two bravos must vote !rematch
Size 8: three alphas and three bravos must vote !rematch
Size 10: four alphas and four bravos must vote !rematch
For larger gathers, do your own math  ;D

Gather Map Voting
A map voting system was added after the Nth complaint about a particular map by some players ( and hey, sometimes you just want to play ttw_Bridge, right? :D ).
The command !votemap mapname will add your vote for that map.
You can specify a partial name: ttw_bridge, tw_bridge, bridge, br will all match ttw_Bridge.  However, if somebody makes a ttw_brasshatch and it gets included, that last example will match that map instead.
You will need at least 1/3rd of the players to agree on the map vote by having them vote for the same map.  For Size 6 and 8 gathers (the most common) this means you'll need at least 2 votes.
If you disagree with a map vote, don't !del - just vote for a different map instead.  You'll also need to get at least 1/3rd of the players to agree, of course.
If you vote for a map that doesn't exist, you'll get a list of valid maps you can vote for.
You can also use !votemap random to force a map to be selected randomly.  If you don't like the current selection, or the currently voted-for map, use this option.  Note that it may still select the current/voted map - it is, after all, random.
You can change your map vote at any time - just !votemap a different map.
You can remove your map vote at any time, use the !votemap command without specifying a map.
If you !del or get deleted, your map vote will be lost.
You can still vote if a rematch gather is to be played, It'll just start a rematch on that map (teams from rematch, map from vote).
« Last Edit: November 14, 2012, 10:59:36 am by KamiquasiSteve » Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #2 on: November 14, 2012, 10:34:11 am »

Seen Bot
This isn't technically part of any Gather thing, but it's on the same bot - so here we go.
commanddescription
!seen nickLooks up the last time nick was seen, and what event they were seen with
Note: If there is no exact match, the bot will look up *nick* instead.  See below for details.
!seen *nick*Looks up nicknames that match *nick* (you can also use *nick or nick*).  If there is only one match, its details are shown.  If there are multiple matches, the bot will return the most recent one and send you a /notice with the other matches.
!seen nick eventLooks up a specific event the bot last saw for the given nick.
Options are: join part quit >nick nick> kicking kicked msg action address auth last
Note: You can also get this list by using !seen without supplying a nick

For example, !seen Falcon` quit will look up the last time the bot saw Falcon` quitting IRC.
!seen @authLooks up the last time somebody with the user auth auth was seen, and what event they were seen with.  This can be useful if somebody uses multiple nicks (BNC, away scripts, legal insanity, etc.) but a single auth, as you wouldn't have to !seen every possible nick or !seen *nick* and ponder whether they really did last use a nickname that fits *nick*.
Note: You can look up an auth for a nick with !seen nick auth.
« Last Edit: November 14, 2012, 10:58:44 am by KamiquasiSteve » Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #3 on: November 14, 2012, 10:36:39 am »

Looking for the old updates from the TTW Forum?
Eat This! » Modes » Tactical Trenchwar » TTW Gather Bot - old updates
« Last Edit: November 14, 2012, 11:05:28 am by KamiquasiSteve » Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #4 on: November 14, 2012, 10:36:56 am »

  • GatherBot can now track players joining/leaving Gathers and perform specific commands based on that information.  By default, the Live channel receives the player name and their auth/nick.  Specific Gather modes can have their own handling; e.g. TTW will warn users who leave Gathers early (200+ tickets remaining) and asks them to re-join.
Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #5 on: November 14, 2012, 11:25:25 am »

  • !fmode (admins/ops only) can now be used to force the mode directly on the server, regardless of whether it is already in that mode or mode has changed recently
Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #6 on: November 18, 2012, 10:34:52 am »

  • !prevgather now adds the Gather Grapher link if available
  • !mode <mode> is no longer rate limited if there is only 1 player
  • !map <nonexistent-map> now gives proper error message
  • After a mode change, a random map is now selected by the main Gather script, regardless of whether the subgather script has an initialization function.
Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #7 on: November 21, 2012, 01:59:24 pm »

Polls are clearly not working, so the following by request/complaint (counter-requests/complaints? msg on IRC I guess  ??? )
  • Live channel disabled
  • !size, !mode, limited to voiced people (and ops, admins)
Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #8 on: December 07, 2012, 03:54:34 am »

  • Live channel has been re-enabled
  • Map changes (such as through accepted/broken map votes) will now highlight players to warn them
  • !prevgather now takes an optional ID parameter to let you look up statistics on that Gather, if available, to the extent available.
  • On reconnect, bot would reset size - fixed
  • After receiving currentmode trigger from server, bot now ignores subsequent currentmode triggers (recently caused a gather to be set up twice.  cause for the subsequent currentmode is network lag)
  • Various minor cosmetic bugs fixed
Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #9 on: December 11, 2012, 08:20:18 pm »

  • !prevgather now de-highlights names
  • added a !unreset command to remove your cast !reset vote
Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #10 on: March 27, 2013, 03:07:52 pm »

  • added a section on in-game commands (e.g. !irc, !bug)
  • added a new in-game command, !ident.  When you first join, the bot will automatically try to recognize your IRC auth.  If it fails at doing so, it will ask you to use !ident IRCauth to identify yourself.  This is currently only used for some statistics, grapher, and shenanigans, but may be expanded in the future (one obvious example, setting you to the correct team if you join the wrong one)
Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #11 on: April 08, 2013, 12:12:08 am »

  • changed !add[mode] to !add [mode] and documented it
  • added !random which...
    • if used as !random N M, returns a random integer in the range N through M (inclusive)
    • if used as !random N.f M.f, returns a random floating point value in the range N.f through M.f (inclusive)
    • if used as !random X Y [Z ...], returns a random selection of the input arguments.
  • !teams in-game will now report missing players (and notifies them automatically on IRC) if the gather has not yet started.
  • Fixed a display bug in !size error response - the desired size was omitted.
  • Fixed a display bug in !unreset response - the threshold count was not displayed (IRC and in-gather).
« Last Edit: April 08, 2013, 12:18:12 am by KamiquasiSteve » Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #12 on: April 23, 2013, 01:57:09 pm »

  • !seen can now be used in pm with the bot
  • !seen output is now de-highlighted when used in-channel
Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #13 on: April 29, 2013, 01:51:12 am »

  • added colors to the 'pledge your allegiance' message when using fixed balance
  • fixed a bug where using !add with nickname X and !a|!b with nickname Y would cause a desync in player data, resulting in stats not being recorded on the stats server
  • added a new Admin command, !countdown, briefly described below so you all know what's going on with that

!countdown explanation
A new command has been added, currently available to Admins, Ops and SethGecko*, that starts a countdown on the bot.
This countdown can be a pure countdown, or a countdown to a given date and time, and is accompanied by a message.
This message is spammed to the channel at a 'natural' interval.  So if the event is weeks from now, it won't bother sending it every minute, or even every day, while if it is imminent, the bot will send it quite often (with a minimum limit at 10s remaining to prevent flooding).

Right now there's a countdown going called TTWmasters which is counting down until the next TTW Masters event.  It was set up as follows:
!countdown TTWmasters on 2013 May 5 7pm @ The TTW Tournament will be starting this Sunday, the 5th of May at 7pm CET - http://eat-that.org/index.php/board,14.0.html

The colors indicate the parameters of the command:
!countdown ID on|off countdown string @ message

!countdownthe command
IDThe ID you want to give this countdown.  It should be relatively unique - though not strictly required, it helps the bot know which one you're referring to.
on|offDetermines whether the countdown should be turned on (in which case you must supply the other parameters) or off (in which case the countdown must exist).  If this parameter is omitted, it will report basic information on the countdown provided, if it exists.
countdown stringThis is an important one.  It determines what time the countdown... counts down to.  There's a few formats in which you can specify this:
  • An integer number - This is interpreted to be that many seconds from 'now'.
  • A duration string - For example, '2 minutes' or '1 hour'.
  • A time - For example, 20:00 or 8pm.
  • A date and time - Such as given in the example above.
If the bot doesn't know what to do with the countdown string you provided, it will complain.  If it does know what to do, but gets it wrong, you'll have no choice other than to remove the countdown (use 'off'), and try again.  While it's fairly robust in figuring out what you mean, being specific helps.  When in doubt, use this format: Year Month-in-English CalendarDay 24-hour-Time .
@Because this command accepts flexible countdown strings, you need to use the @ symbol to separate it from your desired message
messageThe message you want sent to the channel

Once the command has been given, the bot will report the date and time and the time it will take to get there.

After that, the bot will start messaging the channel.  The times at which the messages appear depend on how much time is left.  The bot has been set up to message at 'natural' intervals (yoinked and slightly modified from another bot I wrote):
yearly (assumptioned), monthly (assumptioned), weekly, daily, hourly, at 45, 30, 15, 10, 5 and 1 minute(s), and at 45, 30, and 15 seconds.

* SethGecko has special dispensation access in order to set up TTW Masters tournament countdowns.
Logged
KamiquasiSteve
Global Moderator
Hero Member
*****
Offline Offline

Posts: 296

View Profile
« Reply #14 on: September 06, 2013, 11:25:16 am »

Some of this is going to be changes I made over the past 7 weeks, so when it says 'now' - it may have been so for a while already.
  • !status post-setup, pre-start of gather will now list the map the gather is set up for
  • If a singly-added player votes for a map and dels from the gather, and there are no other map votes cast, the voted map reverts back to the bot-selected map vote.
  • '!maxsize' (no parameter) works for everybody now to check what the current maxsize is. See Post-setup pre-start adding for details on maxsize
  • extra players added post-setup/pre-start can now delete IF they're not already added to the teams
  • !paratrooper disabled for non-TTW modes
Logged
Pages: [1] 2 Print 
« previous next »
 

SMF 2.0.11 | SMF © 2015, Simple Machines | Theme by nesianstyles | Buttons by Andrea
Page created in 0.025 seconds with 18 queries.