Difference between revisions of "Begiak"
TommiPirinen (talk | contribs) |
|||
(127 intermediate revisions by 18 users not shown) | |||
Line 1: | Line 1: | ||
{{TOCD}} |
{{TOCD}} |
||
'''begiak''' is the |
'''begiak''' is the IRC bot in the #apertium [[IRC]] channel. It serves several purposes, including to showcase some applications of the apertium translation [[API]], getting information about languages and other topics, and providing various forms of reminders, as well as a couple features that are just for fun. |
||
== Background == |
== Background == |
||
Begiak was set up by conor_f for [[Google Code-in|GCI 2012]], and several modules were written and fixed by sushain and |
Begiak was set up by conor_f for [[Google Code-in|GCI 2012]], and several modules were written and fixed by [[User:Sushain|sushain]], Qasim, and a number of other GCI students since then. The core code base is the [https://github.com/mutantmonkey/phenny mutantmonkey port] to Python3 of the [http://inamidst.com/phenny/ phenny] bot. Our codebase is currently hosted at [https://github.com/apertium/phenny]. |
||
Begiak means "the eyes" in [[Basque]]. |
Begiak means "the eyes" in [[Basque]]. |
||
== |
== Features == |
||
The following svn repositories are monitored by begiak. Begiak polls for updates when it receives a ping from the server. Also see [[#AI Features|below]] for some ways to manually update |
|||
* [[Using SVN|apertium.svn.sourceforge.net]] |
|||
* HFST |
|||
* vislcg3 |
|||
* phenny |
|||
* omorfi |
|||
* etc. |
|||
== AI Features == |
|||
Begiak recognises the following commands. |
Begiak recognises the following commands. |
||
* <code>.awikstats update <lang></code> — update the wikipage apertium-LANG/stats (note: will dump a bunch of info in private chat) |
|||
=== Apertium features === |
|||
* <code>.follow <nick> <lg1-lg2> [follower]</code> — Follow someone and translate as they speak. (Translations are sent as notices to the follower (follower feature is admin only!)) |
|||
These are special apertium-related or #apertium-specific commands, or were designed with apertium in mind. |
|||
* <code>.following</code> — List people currently being followed. |
|||
* .awik — Search for something on Apertium wiki. |
|||
* . |
* <code>.iso639 <lg></code> — look up [http://en.wikipedia.org/wiki/ISO_639 ISO 639]-1, -2 and -3 language codes either by code or by language name. Codes sourced from Ethnologue.com (639-3) and Wikipedia (-1 and -2) |
||
* <code>.isodb status</code> — see if the database updater (.isodb update) is running |
|||
* .fight ''nick'' — have begiak fight someone for you. |
|||
* <code>.issue <title></code> — create a new GitHub issue. |
|||
* .follow ''nick'' ''lg1-lg2'' ''(follower)'' — Follow someone and translate as they speak. (Translations are sent as notices to the follower (admin only!)) |
|||
* <code>.listpairs <lg></code> — List language pairs available for apertium translation |
|||
* .following — List people currently being followed. |
|||
* <code>.listlangs</code> — List languages available for apertium translation |
|||
* .hug ''nick'' — have begiak hug someone for you. |
|||
* <code>.t <lg1-lg2> [ | lg2-lg3 ...] <text>''</code> — Apertium translate |
|||
* .iso639 ''lg'' — look up [http://en.wikipedia.org/wiki/ISO_639 ISO 639]-1, -2 and -3 language codes either by code or by language name. Codes sourced from Ethnologue.com (639-3) and Wikipedia (-1 and -2) |
|||
* <code>.unfollow <nick></code> — Stop following a user. |
|||
* .isodb update — update the local database of ISO 639 codes (admin only!) |
|||
* <code>.8ball</code> — magic 8 ball |
|||
* .isodb status — see if the database updater (.isodb update) is running |
|||
* <code>.beats</code> — Shows the internet time in Swatch beats |
|||
* .listpairs (''lg'') — List language pairs available for apertium translation |
|||
* . |
* <code>.botsnack</code> — Give begiak a snack for being good |
||
* <code>.c</code> — Calculator using SymPy. |
|||
* .noexceptions (''nick'') — Tells someone there aren't ever any exceptions |
|||
* <code>.chill</code> — Measure the current channel chillness level. |
|||
* .t ... ''lg1-lg2 ( | lg2-lg3 ...)'' — Apertium translate |
|||
* <code>.choose <choice1> <choice2></code> — begiak will choose one of the two options (randomly). |
|||
* .unfollow ''nick'' — Stop following a user. |
|||
* <code>.ety</code> — Look up the etymology of a word |
|||
* .wikicount ''lg'' — Get the number of articles an official or incubated Wikipedia for the specified language has, given a Wikipedia code or partial language name. |
|||
* <code>.fcc <callsign></code> — Look up a callsign issued by the FCC |
|||
* begiak: esan! — Poll for svn updates ("esan!" means "say!" in Basque) |
|||
* <code>.fight <nick></code> — have begiak fight someone for you. |
|||
* begiak: recent — Get most recent svn updates |
|||
* <code>.hug <nick></code> — have begiak hug someone for you. |
|||
* begiak: info <repo> <rev> — Get information on a given revision of a given SVN or git repository |
|||
* <code>.in <time></code> — Set a reminder |
|||
* <code>.linx <url></code> — Upload ''url'' to linx.li |
|||
* <code>.npl</code> — Shows the time from NPL's SNTP server |
|||
* <code>.nsfw <link></code> — for when a link isn't safe for work |
|||
* <code>.pesters |
|||
** begiak: pester <nick> <message></code> — Sends a message to nick every hour they're around (or something. settable in config) |
|||
** <code>.pesters snooze <nick></code> — 'snooze' a pester from nick |
|||
** <code>.pesters <dismiss|rm|remove> <to|from> <nick></code> — to stop pestering/being pestered by nick |
|||
* Search commands: |
|||
** The search commands are used to point other users to the output of several supported commands which are as follows: |
|||
*** Apertium Wiki (<code>.awik</code>) |
|||
*** Wikipedia (<code>.wik</code>) |
|||
*** Urban Dictionary (<code>.urb</code>) |
|||
*** Wiktionary (<code>.w</code>) |
|||
*** DuckDuckGo Search (<code>.search</code>) |
|||
** Replace <code>.wik</code> or <code>.awik</code> with any of the above commands for appropriate output like 'svineet, "India, officially the Republic of India (Bhārat Gaṇarājya),[18][19][c] is a country in South Asia" - https://en.wikipedia.org/wiki/India' for <code>.wik India -> svineet</code> |
|||
*** <code>.awik Begiak -> svineet</code> |
|||
*** <code>.awik Begiak → svineet</code> |
|||
*** <code>nick: .wik India</code> |
|||
*** <code>nick, .wik India</code> |
|||
*** <code>.awik India -> nick</code> |
|||
* <code>.seen</code> — When was the last time a user was seen? |
|||
* <code>.time [timezone]</code> — Returns current time in timezone (can be a city or a time zone e.g UTC). If timezone is empty, returns current time in GMT time zone. |
|||
* <code>.tz</code> — Timezone converter Converts a time from one timezone to another. (e.g., .tz 335EST in CET, or .tz 335EST in London) |
|||
* <code>.tells</code> — See a summary of outstanding reminders you've sent to others using "begiak: tell" |
|||
** begiak: tell <nick> <message> [**pm**]</code> — Tells someone something the next time they say something in a channel begiak is monitoring. The **pm** option has the message sent privately. |
|||
** <code>.tells <nick></code> — List your reminders currently queued to that nick |
|||
** <code>.tells rm <num></code> — Delete a queued reminder using its number from .tells nick |
|||
* <code>.alias</code> — manage aliases |
|||
** <code>.alias add <nick></code> — adds an alias for your nick of nick |
|||
** <code>.alias rm <nick></code> — removes an alias for nick nick |
|||
** <code>.alias list <nick></code> — lists existing aliases for nick |
|||
* <code>.u <char></code> — Search for a unicode character |
|||
* <code>.weather <city></code> — Get the weather for a city |
|||
* <code>.yi</code> — Shows whether it is currently yi or not |
|||
=== |
=== Admin === |
||
These are admin-only, or only useful to admins. |
|||
These are more general-use commands; while many are useful to us in #apertium, they weren't designed specifically for #apertium (though some were hacked to make them more appropriate for #apertium). |
|||
* <code>.isodb update</code> — update the local database of ISO 639 codes |
|||
* .8ball — magic 8 ball |
|||
* <code>.greeting</code> — Manage Greetings |
|||
* .away (''status'') — Sets your status to away |
|||
** <code>.greeting add <name> <message></code> — Add a greeting |
|||
* .back (''status'') — Sets your status to being available. |
|||
** <code>.greeting del <name></code> - Delete a greeting |
|||
* .beats — Shows the internet time in Swatch beats |
|||
* <code>.gitserver [status|start|stop]</code> — get the githook-server's status/start it/stop it. See [[Begiak's git plugin]] for more info. |
|||
* .botsnack — Give begiak a snack for being good |
|||
* <code>.tzdb</code> — Manage timezone database |
|||
* .c — Query Google calculator |
|||
** <code>.tzdb update</code> — Updates a timezones database (admin only) |
|||
* .catfacts — Random facts about cats |
|||
** <code>.tzdb status</code> — Returns a status of updating a timezones database |
|||
* .chill — Measure the current channel chillness level. |
|||
* .choose ''choice1'' ''choice2'' — begiak will choose one of the two options (randomly). |
|||
=== Unknown === |
|||
* .ety — Look up the etymology of a word |
|||
These functions/plugins either don't seem to work or need some figuring out: |
|||
* .fcc ''callsign'' — Look up a callsign issued by the FCC |
|||
* .tfw |
|||
* .g — Search on Google |
|||
* lastfm |
|||
* .gc — Get the number of results on Google |
|||
* mylife (.fml .mlia) |
|||
* .in — Set a reminder |
|||
* oblique |
|||
* .imdb — Search imdb |
|||
* . |
* .whereis ''nick'' — Tells you nick's current status. |
||
* .npl — Shows the time from NPL's SNTP server |
|||
* .nsfw ''link'' - for when a link isn't safe for work |
|||
* .py — Evaluate an expression in python (This runs as a sandboxed web service, not on your computer) |
|||
* .queue — Manage lists. |
* .queue — Manage lists. |
||
** .queue new ''name'' [''item1'', ''item2'' ...] — Make a new queue |
** .queue new ''name'' [''item1'', ''item2'' ...] — Make a new queue |
||
Line 69: | Line 92: | ||
** .queue ''name'' pop — Pop an item off the queue |
** .queue ''name'' pop — Pop an item off the queue |
||
** .queue ''name'' swap ''item1'', ''item2'' — Swap two items |
** .queue ''name'' swap ''item1'', ''item2'' — Swap two items |
||
* .py — Evaluate an expression in python (This runs as a sandboxed web service, not on your computer) |
|||
* .seen — When was the last time a user was seen? |
|||
* .wikicount ''lg'' — Get the number of articles an official or incubated Wikipedia for the specified language has, given a Wikipedia code or partial language name. |
|||
* .slogan ''word'' — Sloganize a word |
|||
* .(ml|mailinglist) poll — Poll for new messages in apertium mailing lists (this is automatically done every five minutes). |
|||
* .stache ''url'' — Moustachify an image |
|||
* .(ml|mailinglist) last <list> — Get the last message in a specified list. |
|||
* .time — Return the current time |
|||
* .title — Get the title of a link |
|||
* .tock — Shows the time from the USNO's atomic clock |
|||
* .u — Search for a unicode character |
|||
* .urb — Query urban dictionary |
|||
* .val ''url'' — Check a webpage using the W3C Markup Validator. |
|||
* .w — look up a word on wiktionary |
|||
* .wa — Query Wolfram Alpha |
|||
* .weather — Get the weather for a city |
|||
* .whereis ''nick'' — Tells you nick's current status. |
|||
* .wik — Search for something on Wikipedia |
|||
* .wuvt — Find out what radio station WUVT is currently playing |
|||
* .yi — Shows whether it is currently yi or not |
|||
* begiak: tell nick something — Send a message to nick |
|||
* begiak: tell ''nick'' ''message'' (''**pm**'') — Tells someone something the next time they say something in a channel begiak is monitoring. The **pm** option has the message sent privately. |
|||
* begiak: "parlez-vous français"? — Translate a phrase (google translate) |
|||
* begiak: reload ''module'' — reload a module (admin only!) |
|||
== Help! It crashed!== |
|||
Begiak has a known bug that causes it to repeatedly quit and rejoin. A few recent changes have reduced this, but it still occasionally occurs. Please don't report this as an issue; we already know about it. If you know how to fix it, however, please do tell us. |
|||
These functions/plugins either don't seem to work or need some figuring out: |
|||
* .tfw |
|||
== Development == |
|||
* rule34 |
|||
A good tutorial on creating Phenny modules can be found [https://github.com/myano/jenni/wiki/How-to-create-a-phenny-module here]. Also, note that some commands start with a period and others start with "begiak: "; new commands should use a period. |
|||
* lastfm |
|||
* mylife (.fml .mlia) |
|||
== Administration == |
|||
* oblique |
|||
Begiak is controlled by an init script (/etc/init.d/begiak.sh, found at [https://github.com/apertium/phenny/blob/master/init.sh]) on Bytemark, and can be started, stopped, and restarted by anyone with sudo access. |
|||
== Irssi == |
|||
Since begiak talks a lot it may be beneficial to set your IRC so begiak's messages don't have to alert you very loudly: |
|||
<pre> |
|||
== Wishlist == |
|||
ignores = ( |
|||
* find out why the "posted" command isn't working as expected |
|||
{ level = "JOINS PARTS QUITS MODES NICKS"; }, |
|||
* document any command that does not have information |
|||
{ mask = "begiak"; level = "NO_ACT ALL"; }, |
|||
* show short links to new apertium-stuff posts (like the commits) |
|||
); |
|||
* fix <code>.bot-slap</code> to only be triggered when begiak is mentioned |
|||
</pre> |
|||
* greet new users (never seen) with a hello message telling them to idle (able to enable/disable) |
|||
* fix <code>.seen</code> forgetting everything after a restart |
|||
* make <code>tell</code> split overly long messages into multiple ones for display |
|||
* <s>fix begiak <code>.help</code> to display stuff about Apertium</s> |
|||
* <s>is the githook server automatically loading yet?</s> |
|||
* <s>wiktionary in other languages if there's some way to do it that makes sense (.ety and .w)</s> |
|||
* <s>find an easier way (or clean up the current method) to poll for SVN updates</s> |
|||
* <s>find out why the "fml" command isn't working as expected</s> |
|||
* <s>svn/git: logic of multiple files (display up to 3 filenames; if more than 3 files, display 2 filenames and the message "and X other files" (it should always be plural))</s> |
|||
* <s>svn/git: when updates are received (either by polling or a hook), don't display the time of the update. Maybe have a default dispalyTime=True (or False) in the display function, and adjust the appropriate functions to send the non-default.</s> |
|||
* <s>svn: when multiple updates occur since last poll, display both</s> |
|||
* <s>.botslap</s> |
|||
This way you don't get highlights in channel list when begiak says automated messages or goes in the join-part-join cycle. |
|||
== Help! == |
|||
Begiak is controlled by an init script (/etc/init.d/begiak.sh) on bytemark, and can be started, stopped, and restarted by anyone with sudo access. |
|||
[[Category:Bots]] |
[[Category:Bots]] |
Latest revision as of 17:01, 3 December 2020
begiak is the IRC bot in the #apertium IRC channel. It serves several purposes, including to showcase some applications of the apertium translation API, getting information about languages and other topics, and providing various forms of reminders, as well as a couple features that are just for fun.
Background[edit]
Begiak was set up by conor_f for GCI 2012, and several modules were written and fixed by sushain, Qasim, and a number of other GCI students since then. The core code base is the mutantmonkey port to Python3 of the phenny bot. Our codebase is currently hosted at [1].
Begiak means "the eyes" in Basque.
Features[edit]
Begiak recognises the following commands.
.awikstats update <lang>
— update the wikipage apertium-LANG/stats (note: will dump a bunch of info in private chat).follow <nick> <lg1-lg2> [follower]
— Follow someone and translate as they speak. (Translations are sent as notices to the follower (follower feature is admin only!)).following
— List people currently being followed..iso639 <lg>
— look up ISO 639-1, -2 and -3 language codes either by code or by language name. Codes sourced from Ethnologue.com (639-3) and Wikipedia (-1 and -2).isodb status
— see if the database updater (.isodb update) is running.issue <title>
— create a new GitHub issue..listpairs <lg>
— List language pairs available for apertium translation.listlangs
— List languages available for apertium translation.t <lg1-lg2> [ | lg2-lg3 ...] <text>
— Apertium translate.unfollow <nick>
— Stop following a user..8ball
— magic 8 ball.beats
— Shows the internet time in Swatch beats.botsnack
— Give begiak a snack for being good.c
— Calculator using SymPy..chill
— Measure the current channel chillness level..choose <choice1> <choice2>
— begiak will choose one of the two options (randomly)..ety
— Look up the etymology of a word.fcc <callsign>
— Look up a callsign issued by the FCC.fight <nick>
— have begiak fight someone for you..hug <nick>
— have begiak hug someone for you..in
— Set a reminder.linx <url>
— Upload url to linx.li.npl
— Shows the time from NPL's SNTP server.nsfw <link>
— for when a link isn't safe for work.pesters
begiak: pester <nick> <message>
— Sends a message to nick every hour they're around (or something. settable in config).pesters snooze <nick>
— 'snooze' a pester from nick.pesters <dismiss|rm|remove> <to|from> <nick>
— to stop pestering/being pestered by nick
- Search commands:
- The search commands are used to point other users to the output of several supported commands which are as follows:
- Apertium Wiki (
.awik
) - Wikipedia (
.wik
) - Urban Dictionary (
.urb
) - Wiktionary (
.w
) - DuckDuckGo Search (
.search
)
- Apertium Wiki (
- Replace
.wik
or.awik
with any of the above commands for appropriate output like 'svineet, "India, officially the Republic of India (Bhārat Gaṇarājya),[18][19][c] is a country in South Asia" - https://en.wikipedia.org/wiki/India' for.wik India -> svineet
.awik Begiak -> svineet
.awik Begiak → svineet
nick: .wik India
nick, .wik India
.awik India -> nick
- The search commands are used to point other users to the output of several supported commands which are as follows:
.seen
— When was the last time a user was seen?.time [timezone]
— Returns current time in timezone (can be a city or a time zone e.g UTC). If timezone is empty, returns current time in GMT time zone..tz
— Timezone converter Converts a time from one timezone to another. (e.g., .tz 335EST in CET, or .tz 335EST in London).tells
— See a summary of outstanding reminders you've sent to others using "begiak: tell"- begiak: tell <nick> <message> [**pm**] — Tells someone something the next time they say something in a channel begiak is monitoring. The **pm** option has the message sent privately.
.tells <nick>
— List your reminders currently queued to that nick.tells rm <num>
— Delete a queued reminder using its number from .tells nick
.alias
— manage aliases.alias add <nick>
— adds an alias for your nick of nick.alias rm <nick>
— removes an alias for nick nick.alias list <nick>
— lists existing aliases for nick
.u <char>
— Search for a unicode character.weather <city>
— Get the weather for a city.yi
— Shows whether it is currently yi or not
Admin[edit]
These are admin-only, or only useful to admins.
.isodb update
— update the local database of ISO 639 codes.greeting
— Manage Greetings.greeting add <name> <message>
— Add a greeting.greeting del <name>
- Delete a greeting
.gitserver [status|start|stop]
— get the githook-server's status/start it/stop it. See Begiak's git plugin for more info..tzdb
— Manage timezone database.tzdb update
— Updates a timezones database (admin only).tzdb status
— Returns a status of updating a timezones database
Unknown[edit]
These functions/plugins either don't seem to work or need some figuring out:
- .tfw
- lastfm
- mylife (.fml .mlia)
- oblique
- .whereis nick — Tells you nick's current status.
- .queue — Manage lists.
- .queue new name [item1, item2 ...] — Make a new queue
- .queue name — Display a queue
- .queue delete name — Delete a queue
- .queue name add item — Add an item
- .queue name remove item — Remove an item
- .queue name pop — Pop an item off the queue
- .queue name swap item1, item2 — Swap two items
- .py — Evaluate an expression in python (This runs as a sandboxed web service, not on your computer)
- .wikicount lg — Get the number of articles an official or incubated Wikipedia for the specified language has, given a Wikipedia code or partial language name.
- .(ml|mailinglist) poll — Poll for new messages in apertium mailing lists (this is automatically done every five minutes).
- .(ml|mailinglist) last <list> — Get the last message in a specified list.
Help! It crashed![edit]
Begiak has a known bug that causes it to repeatedly quit and rejoin. A few recent changes have reduced this, but it still occasionally occurs. Please don't report this as an issue; we already know about it. If you know how to fix it, however, please do tell us.
Development[edit]
A good tutorial on creating Phenny modules can be found here. Also, note that some commands start with a period and others start with "begiak: "; new commands should use a period.
Administration[edit]
Begiak is controlled by an init script (/etc/init.d/begiak.sh, found at [2]) on Bytemark, and can be started, stopped, and restarted by anyone with sudo access.
Irssi[edit]
Since begiak talks a lot it may be beneficial to set your IRC so begiak's messages don't have to alert you very loudly:
ignores = ( { level = "JOINS PARTS QUITS MODES NICKS"; }, { mask = "begiak"; level = "NO_ACT ALL"; }, );
This way you don't get highlights in channel list when begiak says automated messages or goes in the join-part-join cycle.