SoylentNews - User contributions [en]

IRC

2016-01-30T00:29:24Z

Crutchy: /* Official channels */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

* Official channels are usually safe for work / kids / family.

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! NSFW !! Description !! Maintained by
|-
| ## || yes || mostly about bacon and stuff || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || yes || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || no || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || no || bot error spew || [[User:chromas|chromas]]
|-
| #comments || no || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || no || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

* NSFW = not safe for work / kids /family (contains adult themes and profanity)

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting (if dumping errors to #debug, bots should ideally be set to not respond to commands in that channel to prevent race/infinite loop conditions).

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|-
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2016-01-30T00:28:25Z

Crutchy: /* Private establishments (unofficial) */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! NSFW !! Description !! Maintained by
|-
| ## || yes || mostly about bacon and stuff || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || yes || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || no || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || no || bot error spew || [[User:chromas|chromas]]
|-
| #comments || no || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || no || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

* NSFW = not safe for work / kids /family (contains adult themes and profanity)

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting (if dumping errors to #debug, bots should ideally be set to not respond to commands in that channel to prevent race/infinite loop conditions).

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|-
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2016-01-30T00:27:57Z

Crutchy: added nsfw column

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! NSFW !! Description !! Maintained by
|-
| ## || yes || mostly about bacon and stuff || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || yes || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || no || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || no || bot error spew || [[User:chromas|chromas]]
|-
| #comments || no || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || no || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

* NSFW = not safe for work (contains adult themes and profanity)

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting (if dumping errors to #debug, bots should ideally be set to not respond to commands in that channel to prevent race/infinite loop conditions).

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|-
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2016-01-30T00:22:29Z

Crutchy: /* Bots */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting (if dumping errors to #debug, bots should ideally be set to not respond to commands in that channel to prevent race/infinite loop conditions).

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|-
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2016-01-30T00:20:03Z

Crutchy: /* Bots */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|-
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2016-01-30T00:18:15Z

Crutchy: /* Bots */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|-
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
||
}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2016-01-30T00:17:43Z

Crutchy: /* Bots */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|-
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2016-01-30T00:16:32Z

Crutchy: /* Bots */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|-
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
|
}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2016-01-30T00:14:57Z

Crutchy: added x to table

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|
| [[IRC:exec|x]] ||
* #debug 
* #crutchy
||
* ~
||
* [[User:Crutchy|crutchy]] (op/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* exec development
|
}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC:exec aliases

2016-01-23T11:37:27Z

Crutchy: added some aliases

[[IRC:exec]]

a link to exec's main wiki page will be output if any user types "exec: help" in a channel where the bot resides 

==~==

==~bot==

==~bucket==

==~buckets-dump==

==~buckets-flush==

==~buckets-list==

==~buckets-load==

==~buckets-save==

==~chart==

==~cid==

==~comments==
https://soylentnews.org/~crutchy/journal/1098

==~count==
~count <nick>

==~cowsay==

==~define==
~define term

==~define-add==
~define-add term, meaning

==~define-count==

==~define-delete==

==~define-list==

==~define-source-edit==

==~define-source-param==

==~define-sources==

==~deop==

==~dest-clear==

==~dest-override==

==~devoice==

==~find-first==
~find-first <text>

==~find-last==
~find-last <text>

==~first==
~first <nick>

==~fortune==

==~g'day==

==~gday==

==~header==
~header <header> <url> 
returns value of header (if found) 
fails silently if error occurs or header not found

==~header-login==

==~help==

==~ignore==

==~invite==

==~ircd==

==~isup==
~isup host[:port] (checks connection, returns http status if found)

==~join==
~join #channel (don't have to be channel op)

==~kick==

syntax: ~kick %nick% 
kicks %nick% from the channel. admin-only command

==~kill==

syntax: ~kill %pid% 
kills process run by exec with process id %pid% 
admin-only command 
only works for processes run by exec. processes outside exec aren't affected by this command

==~killall==

kills all processes being run by the bot at the time. admin-only command

==~last==
~last <nick>

==~link==

syntax to search: ~link %search%, set: ~link %id% %content%, delete: ~link %id% -

can't use pipe (|) char, %id% can't contain spaces, but %content% can, %search% is a regexp pattern

will return a list of one or more %id% => %content% if %search% matches either %id% or %content%

==~links==

alias of ~link

==~list==
syntax: ~list 
lists available commands that don't require elevated privs

==~list-auth==
syntax: ~list-auth 
lists available commands requiring nickserv authentication

==~location==
~location %name% 
returns the location associated with the specified name

==~lock==
syntax: ~lock %alias% 
treats all lines entered as being prefixed with alias, channel-specific 
see also: ~unlock

==~lockdown==
syntax: ~lockdown 
admins-only 
bot must be op 
MODE $dest +ntipm

==~log==

syntax: ~log param=value ... 
returns data from chromas' logging website 
refer to http://chromas.0x.no/s/soylent_log.php for more info

==~moo==

apt-get moo

==~op==

syntax: ~op [%nick%] 
admin-only command 
%nick% is optional 
if %nick% isn't specified, will op the calling admin 
if %nick% is supplied, will op the specified %nick% 
bot must be op in channel

==~openthepodbaydoors==

fortune -s -o

==~part==
instruct bot to leave the current channel, or a different channel with optional parameter 
syntax: ~part [channel]

==~php==

==~ps==

==~q==

==~queue==
~queue (returns number of SN submissions in the queue)

==~rainbow==
~rainbow text

==~rehash==

==~remind==

==~restart==

==rofl==

==~rps==

infinite asynchronous play-by-irc rock/paper/scissors 
syntax: ~rps [ranks|r|p|s] 
rankings: http://ix.io/nAz 
handicap = losses/wins/turns*rounds*100 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/rps.php

==~say==

==~scramble==

==~sed==
~sed on|off 
[nick[:|,|>|.] ]s/pattern/replace[/[g]] (similar to SedBot)

==~seen==

==~staff==
syntax: ~staff meeting 
displays meeting info from either the site news slashbox or the board meeting wiki page

==~submit==

==~suggest==

==~tell==

==~tests==

==~time==
Syntax: ~time location 
Related commands: ~time-add ~time-del ~location 
Developer(s): crutchy 
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php

==~time-add==

==~time-del==

==~title==

==~translate==
~translate tolang text (auto-detects source lang, eg: ~translate en prueba)

==~translate-sl==
~translate-sl fromlang tolang text (eg: ~translate-sl es en prueba)

==~unignore==

==~unlock==
Syntax: ~unlock 
Related commands: ~lock 
Developers: crutchy 
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

==~up==

==~users==

syntax: ~users %command% %subject% 
admin-only command 
where %command% is one of: 
===nicks===
%subject% is the channel that you want to get a listing of nicks for
===channels===
%subject% is the nick that you want to get a list of channels for
===all-channels===
%subject% not applicable for this command 
returns a listing of all channels that stored users are members of
===count===
%subject% is the channel that you want the user count of
===data===
%subject% is the nick that you want to return stored data for
===account===
%subject% is the nick that you want to find out the nickserv account of

==~voice==

==~weather==
Syntax: 
~weather location 
Examples: 
~weather JFK 
~weather vostok, aq 
Related commands: 
~weather-add 
~time-add 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php

==~weather-add==
Syntax: ~weather-add name location 
Developer(s): crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php 
Related commands: 
~weather 
~time 
~time-add 
~location 
Description: 
Enables storing a short name to refer to a longer location description when using the ~weather or ~time commands. 
If a name already exists, setting it again will overwrite the existing named location. 
Names cannot be deleted at this stage. 
A few thousand ICAO and IATA/FAA airport codes have been imported into the codes file thanks to OpenFlights. 
<crutchy> ~weather-add crutchy melbourne australia 
<exec> code "crutchy" set for location "melbourne australia"

==~weather-del==

==~welcome==

==~wiki==

==~x==

the "~x" alias allows a bot operator to create and manage scripts from within IRC (dubbed "live scripts")

scripts created using this alias are stored in a bucket by the bot instead of a file

the handler uses php's eval to run live scripts

to prevent anyone from executing arbitrary commands on the bot host, a whois command is issued to verify that the NickServ account of the user of the ~x alias is the bot operator (by settling the userlist parameter of the alias definition line to "@")

the general form of the command is:

~x %action% [%param%] [%code%]

in a nutshell the possible actions and params are:
"global on|off" (enables or disables all live scripts)
"kill" (a shorcut for disabling all live scripts)
"enable %script-name%" (enables an individual live script)
"disable %script-name%" (disables an individual live script)
"delete-script %script-name%" (deletes a live script from memory)
"open %script-name%" (opens a live script for editing in the active channel)
"close" (closes the currently open live script in the active channel)
"code" (outputs a line-numbered code listing of the currently open live script in the active channel)
"list" (outputs a listing of available live scripts, and highlights enabled scripts)
"replace [L]%line-number% %old-code%|%new-code%" (replaces a line of code in the currently open live script)
"delete-line [L]%line-number%" (deletes a line of code in the currently open live script)
"insert [L]%line-number% %code%" (inserts a line of code in the currently open live script)
"add %code%" (adds a line of code to the currently open live script)

import and export (from/to file) actions are also proposed but not yet implemented.

live scripts have access to common lib functions used by other scripts, and also have direct access to $nick, $dest (channel), $trailing. the privmsg lib function doesn't work for live scripts as the live script handler is triggered internally by the bot using a registered privmsg event handler, so to privmsg the channel that the sender ($nick) is in you simply call pm($dest,"message) instead.

when a new live script is created, it must be enabled before it will run, but once enabled any changes will come into affect immediately.

whilst the code is currently limited to php, it could potentially be adapted to execute code in other languages using their command-line interpreters. it also doesn't have to be limited to code. it could potentially be used to collaborate on lines of non-executing text (such as for collaborative editing of SN submissions). with some tweaks it could be possible to collaborate on code as well, with other users being able to add/edit/delete lines but requiring the operator to re-enable the script for changes to come into effect.

==!isr==
In Soviet Russia, x2 x1s YOU!

==.macro==

syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>

syntax to delete: .macro <trigger> -

<chanlist> is comma-separated or * for any

Used to set a PRIVMSG or INTERNAL macro.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130

==.relays==
Outputs a list of freenode channel relays currently active.
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111

==systemctl==
syntax: systemctl %subject% 
tries to do %subject% and fails

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2016-01-23T11:33:40Z

Crutchy: added items template

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

===Get a list of commands===

* ~list
* ~list-auth

===Get help for a command===

* ~help ~command

===Public commands===

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%items%% = php serialized array containing all parameters
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

==SoylentNews Wiki spam combat==

Spam control features have been developed to help control botspam in the SN wiki.
These are a selection of commands that will only work in the #wiki channel.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki.php

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki_lib.php

===.delpage===
syntax: .delpage %title% 
Deletes page with specified title. 
This command is restricted to a list of hard coded NickServ accounts with wiki admin rights. 
If there are no wiki admins around and there is a clear spam violation, two trusted irc nickserv accounts may delete a page by each issuing the .delpage command for the same title.

===.undelpage===
syntax: .undelpage %title% 
Use this command to undo a .delpage command by a trusted irc nickserv account who isn't a wiki admin. 
Must be either a wiki admin or trusted irc nickserv account.

===.listspamrules===
syntax: .listspamrules 
Lists the regular expressions that are used to match names of users that edit the wiki. If the username matches one or more patterns, the page edited is automatically flagged.
===.listspamusers===
syntax: .listspamusers 
Output blacklisted usernames, who when editing a page will trigger exec to automatically flag it as spam.
===.listsafeusers===
syntax: .listsafeusers 
Output whitelisted usernames, who will be allowed to make edits even if their username is blacklisted or matches a regexp rule.
===.delspamrule===
syntax: .delspamrule %pattern% 
Deletes the specified pattern from the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.testrules===
syntax: .testrules %username% 
Runs %username% through the regular expressions in the list of spam rules. Returns 'match' or 'no match'.
===.spamrule===
syntax: .spamrule %pattern% 
Adds the specified pattern to the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamctl===
syntax: .spamctl %title% 
syntax: .spamctl last 
Commands exec to mark either the specified page as spam, or to mark the last edit output by the WikiRC bot. 
This is a privileged command (authorized users must be identified with NickServ).
===.delsafeuser===
syntax: .delsafeuser %username% 
Deletes the specified username from the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.safeuser===
syntax: .safeuser %username% 
Adds the specified username to the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.delspamuser===
syntax: .delspamuser %username% 
Deletes the specified username from the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamuser===
syntax: .spamuser %username% 
Adds the specified username to the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).

[[Category:IRC]]
[[Category:IRC:exec]]

Talk:ProposedSpending

2016-01-05T06:37:28Z

Crutchy:

=Formatting=

If you have an idea for proposed spending, click "Edit" at the top of this page and list it below and sign your comment using four tildes <nowiki>"~~~~"</nowiki> (no quotes). The tildes will be replaced with a coded line signing your comment. Replies to that comment can be made by including a colon (for each level of indent) and a space after (": " or ":: " etc.) at the beginning of the reply.

==Example==

Convert it to dolla dolla bills y'all and make it rain! [[User:Mrcoolbp|mrcoolbp]] ([[User talk:Mrcoolbp|talk]]) 20:41, 21 October 2015 (UTC)
: That's a horrible idea! [[User:Mrcoolbp|mrcoolbp]] ([[User talk:Mrcoolbp|talk]]) 20:55, 21 October 2015 (UTC)
:: I agree! [[User:Mrcoolbp|mrcoolbp]] ([[User talk:Mrcoolbp|talk]]) 21:00, 21 October 2015 (UTC)

[[HelpTalk_pages2|More info on talk pages and commenting conventions]]

=Suggestions= 

User DonkeyChan (5551) suggests that we pay back the founders using a "50% rule", where half of the money generated beyond what is needed for the current period is split between being "banked for contingency" while the other half goes directly towards paying back the founders. [[User:Mrcoolbp|mrcoolbp]] ([[User talk:Mrcoolbp|talk]]) 22:44, 21 October 2015 (UTC)

- i second this suggestion. paying back the founders should be a high priority so that SN can become a not-for-profit in the normal sense. it probably has tax benefits too. ~ [[User:Crutchy|crutchy]] 06:37, 5 January 2016 (UTC)

IRC:exec aliases

2015-12-27T08:41:38Z

Crutchy: added ~lockdown command

[[IRC:exec]]

a link to exec's main wiki page will be output if any user types "exec: help" in a channel where the bot resides 

==~==

==~bot==

==~bucket==

==~buckets-dump==

==~buckets-flush==

==~buckets-list==

==~buckets-load==

==~buckets-save==

==~chart==

==~cid==

==~comments==
https://soylentnews.org/~crutchy/journal/1098

==~count==
~count <nick>

==~cowsay==

==~define==
~define term

==~define-add==
~define-add term, meaning

==~define-count==

==~define-delete==

==~define-list==

==~define-source-edit==

==~define-source-param==

==~define-sources==

==~deop==

==~dest-clear==

==~dest-override==

==~devoice==

==~find-first==
~find-first <text>

==~find-last==
~find-last <text>

==~first==
~first <nick>

==~fortune==

==~g'day==

==~gday==

==~header==
~header <header> <url> 
returns value of header (if found) 
fails silently if error occurs or header not found

==~header-login==

==~help==

==~ignore==

==~invite==

==~ircd==

==~isup==
~isup host[:port] (checks connection, returns http status if found)

==~join==
~join #channel (don't have to be channel op)

==~kick==

syntax: ~kick %nick% 
kicks %nick% from the channel. admin-only command

==~kill==

syntax: ~kill %pid% 
kills process run by exec with process id %pid% 
admin-only command 
only works for processes run by exec. processes outside exec aren't affected by this command

==~killall==

kills all processes being run by the bot at the time. admin-only command

==~last==
~last <nick>

==~link==

syntax to search: ~link %search%, set: ~link %id% %content%, delete: ~link %id% -

can't use pipe (|) char, %id% can't contain spaces, but %content% can, %search% is a regexp pattern

will return a list of one or more %id% => %content% if %search% matches either %id% or %content%

==~links==

alias of ~link

==~list==
syntax: ~list 
lists available commands that don't require elevated privs

==~list-auth==
syntax: ~list-auth 
lists available commands requiring nickserv authentication

==~location==
~location %name% 
returns the location associated with the specified name

==~lock==
syntax: ~lock %alias% 
treats all lines entered as being prefixed with alias, channel-specific 
see also: ~unlock

==~lockdown==
syntax: ~lockdown 
admins-only 
bot must be op 
MODE $dest +ntipm

==~log==

syntax: ~log param=value ... 
returns data from chromas' logging website 
refer to http://chromas.0x.no/s/soylent_log.php for more info

==~moo==

apt-get moo

==~op==

syntax: ~op [%nick%] 
admin-only command 
%nick% is optional 
if %nick% isn't specified, will op the calling admin 
if %nick% is supplied, will op the specified %nick% 
bot must be op in channel

==~openthepodbaydoors==

fortune -s -o

==~part==
instruct bot to leave the current channel, or a different channel with optional parameter 
syntax: ~part [channel]

==~php==

==~ps==

==~q==

==~queue==
~queue (returns number of SN submissions in the queue)

==~rainbow==
~rainbow text

==~rehash==

==~remind==

==~restart==

==rofl==

==~say==

==~scramble==

==~sed==
~sed on|off 
[nick[:|,|>|.] ]s/pattern/replace[/[g]] (similar to SedBot)

==~staff==
syntax: ~staff meeting 
displays meeting info from either the site news slashbox or the board meeting wiki page

==~suggest==

==~tests==

==~time==
Syntax: ~time location 
Related commands: ~time-add ~time-del ~location 
Developer(s): crutchy 
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php

==~time-add==

==~time-del==

==~title==

==~translate==
~translate tolang text (auto-detects source lang, eg: ~translate en prueba)

==~translate-sl==
~translate-sl fromlang tolang text (eg: ~translate-sl es en prueba)

==~unignore==

==~unlock==
Syntax: ~unlock 
Related commands: ~lock 
Developers: crutchy 
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

==~up==

==~users==

syntax: ~users %command% %subject% 
admin-only command 
where %command% is one of: 
===nicks===
%subject% is the channel that you want to get a listing of nicks for
===channels===
%subject% is the nick that you want to get a list of channels for
===all-channels===
%subject% not applicable for this command 
returns a listing of all channels that stored users are members of
===count===
%subject% is the channel that you want the user count of
===data===
%subject% is the nick that you want to return stored data for
===account===
%subject% is the nick that you want to find out the nickserv account of

==~voice==

==~weather==
Syntax: 
~weather location 
Examples: 
~weather JFK 
~weather vostok, aq 
Related commands: 
~weather-add 
~time-add 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php

==~weather-add==
Syntax: ~weather-add name location 
Developer(s): crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php 
Related commands: 
~weather 
~time 
~time-add 
~location 
Description: 
Enables storing a short name to refer to a longer location description when using the ~weather or ~time commands. 
If a name already exists, setting it again will overwrite the existing named location. 
Names cannot be deleted at this stage. 
A few thousand ICAO and IATA/FAA airport codes have been imported into the codes file thanks to OpenFlights. 
<crutchy> ~weather-add crutchy melbourne australia 
<exec> code "crutchy" set for location "melbourne australia"

==~weather-del==

==~welcome==

==~wiki==

==~x==

the "~x" alias allows a bot operator to create and manage scripts from within IRC (dubbed "live scripts")

scripts created using this alias are stored in a bucket by the bot instead of a file

the handler uses php's eval to run live scripts

to prevent anyone from executing arbitrary commands on the bot host, a whois command is issued to verify that the NickServ account of the user of the ~x alias is the bot operator (by settling the userlist parameter of the alias definition line to "@")

the general form of the command is:

~x %action% [%param%] [%code%]

in a nutshell the possible actions and params are:
"global on|off" (enables or disables all live scripts)
"kill" (a shorcut for disabling all live scripts)
"enable %script-name%" (enables an individual live script)
"disable %script-name%" (disables an individual live script)
"delete-script %script-name%" (deletes a live script from memory)
"open %script-name%" (opens a live script for editing in the active channel)
"close" (closes the currently open live script in the active channel)
"code" (outputs a line-numbered code listing of the currently open live script in the active channel)
"list" (outputs a listing of available live scripts, and highlights enabled scripts)
"replace [L]%line-number% %old-code%|%new-code%" (replaces a line of code in the currently open live script)
"delete-line [L]%line-number%" (deletes a line of code in the currently open live script)
"insert [L]%line-number% %code%" (inserts a line of code in the currently open live script)
"add %code%" (adds a line of code to the currently open live script)

import and export (from/to file) actions are also proposed but not yet implemented.

live scripts have access to common lib functions used by other scripts, and also have direct access to $nick, $dest (channel), $trailing. the privmsg lib function doesn't work for live scripts as the live script handler is triggered internally by the bot using a registered privmsg event handler, so to privmsg the channel that the sender ($nick) is in you simply call pm($dest,"message) instead.

when a new live script is created, it must be enabled before it will run, but once enabled any changes will come into affect immediately.

whilst the code is currently limited to php, it could potentially be adapted to execute code in other languages using their command-line interpreters. it also doesn't have to be limited to code. it could potentially be used to collaborate on lines of non-executing text (such as for collaborative editing of SN submissions). with some tweaks it could be possible to collaborate on code as well, with other users being able to add/edit/delete lines but requiring the operator to re-enable the script for changes to come into effect.

==!isr==
In Soviet Russia, x2 x1s YOU!

==.macro==

syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>

syntax to delete: .macro <trigger> -

<chanlist> is comma-separated or * for any

Used to set a PRIVMSG or INTERNAL macro.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130

==.relays==
Outputs a list of freenode channel relays currently active.
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111

==systemctl==
syntax: systemctl %subject% 
tries to do %subject% and fails

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec aliases

2015-12-27T03:23:31Z

Crutchy:

[[IRC:exec]]

a link to exec's main wiki page will be output if any user types "exec: help" in a channel where the bot resides 

==~==

==~bot==

==~bucket==

==~buckets-dump==

==~buckets-flush==

==~buckets-list==

==~buckets-load==

==~buckets-save==

==~chart==

==~cid==

==~comments==
https://soylentnews.org/~crutchy/journal/1098

==~count==
~count <nick>

==~cowsay==

==~define==
~define term

==~define-add==
~define-add term, meaning

==~define-count==

==~define-delete==

==~define-list==

==~define-source-edit==

==~define-source-param==

==~define-sources==

==~deop==

==~dest-clear==

==~dest-override==

==~devoice==

==~find-first==
~find-first <text>

==~find-last==
~find-last <text>

==~first==
~first <nick>

==~fortune==

==~g'day==

==~gday==

==~header==
~header <header> <url> 
returns value of header (if found) 
fails silently if error occurs or header not found

==~header-login==

==~help==

==~ignore==

==~invite==

==~ircd==

==~isup==
~isup host[:port] (checks connection, returns http status if found)

==~join==
~join #channel (don't have to be channel op)

==~kick==

syntax: ~kick %nick% 
kicks %nick% from the channel. admin-only command

==~kill==

syntax: ~kill %pid% 
kills process run by exec with process id %pid% 
admin-only command 
only works for processes run by exec. processes outside exec aren't affected by this command

==~killall==

kills all processes being run by the bot at the time. admin-only command

==~last==
~last <nick>

==~link==

syntax to search: ~link %search%, set: ~link %id% %content%, delete: ~link %id% -

can't use pipe (|) char, %id% can't contain spaces, but %content% can, %search% is a regexp pattern

will return a list of one or more %id% => %content% if %search% matches either %id% or %content%

==~links==

alias of ~link

==~list==
syntax: ~list 
lists available commands that don't require elevated privs

==~list-auth==
syntax: ~list-auth 
lists available commands requiring nickserv authentication

==~location==
~location %name% 
returns the location associated with the specified name

==~lock==
syntax: ~lock %alias% 
treats all lines entered as being prefixed with alias, channel-specific 
see also: ~unlock

==~log==

syntax: ~log param=value ... 
returns data from chromas' logging website 
refer to http://chromas.0x.no/s/soylent_log.php for more info

==~moo==

apt-get moo

==~op==

syntax: ~op [%nick%] 
admin-only command 
%nick% is optional 
if %nick% isn't specified, will op the calling admin 
if %nick% is supplied, will op the specified %nick% 
bot must be op in channel

==~openthepodbaydoors==

fortune -s -o

==~part==
instruct bot to leave the current channel, or a different channel with optional parameter 
syntax: ~part [channel]

==~php==

==~ps==

==~q==

==~queue==
~queue (returns number of SN submissions in the queue)

==~rainbow==
~rainbow text

==~rehash==

==~remind==

==~restart==

==rofl==

==~say==

==~scramble==

==~sed==
~sed on|off 
[nick[:|,|>|.] ]s/pattern/replace[/[g]] (similar to SedBot)

==~staff==
syntax: ~staff meeting 
displays meeting info from either the site news slashbox or the board meeting wiki page

==~suggest==

==~tests==

==~time==
Syntax: ~time location 
Related commands: ~time-add ~time-del ~location 
Developer(s): crutchy 
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php

==~time-add==

==~time-del==

==~title==

==~translate==
~translate tolang text (auto-detects source lang, eg: ~translate en prueba)

==~translate-sl==
~translate-sl fromlang tolang text (eg: ~translate-sl es en prueba)

==~unignore==

==~unlock==
Syntax: ~unlock 
Related commands: ~lock 
Developers: crutchy 
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

==~up==

==~users==

syntax: ~users %command% %subject% 
admin-only command 
where %command% is one of: 
===nicks===
%subject% is the channel that you want to get a listing of nicks for
===channels===
%subject% is the nick that you want to get a list of channels for
===all-channels===
%subject% not applicable for this command 
returns a listing of all channels that stored users are members of
===count===
%subject% is the channel that you want the user count of
===data===
%subject% is the nick that you want to return stored data for
===account===
%subject% is the nick that you want to find out the nickserv account of

==~voice==

==~weather==
Syntax: 
~weather location 
Examples: 
~weather JFK 
~weather vostok, aq 
Related commands: 
~weather-add 
~time-add 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php

==~weather-add==
Syntax: ~weather-add name location 
Developer(s): crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php 
Related commands: 
~weather 
~time 
~time-add 
~location 
Description: 
Enables storing a short name to refer to a longer location description when using the ~weather or ~time commands. 
If a name already exists, setting it again will overwrite the existing named location. 
Names cannot be deleted at this stage. 
A few thousand ICAO and IATA/FAA airport codes have been imported into the codes file thanks to OpenFlights. 
<crutchy> ~weather-add crutchy melbourne australia 
<exec> code "crutchy" set for location "melbourne australia"

==~weather-del==

==~welcome==

==~wiki==

==~x==

the "~x" alias allows a bot operator to create and manage scripts from within IRC (dubbed "live scripts")

scripts created using this alias are stored in a bucket by the bot instead of a file

the handler uses php's eval to run live scripts

to prevent anyone from executing arbitrary commands on the bot host, a whois command is issued to verify that the NickServ account of the user of the ~x alias is the bot operator (by settling the userlist parameter of the alias definition line to "@")

the general form of the command is:

~x %action% [%param%] [%code%]

in a nutshell the possible actions and params are:
"global on|off" (enables or disables all live scripts)
"kill" (a shorcut for disabling all live scripts)
"enable %script-name%" (enables an individual live script)
"disable %script-name%" (disables an individual live script)
"delete-script %script-name%" (deletes a live script from memory)
"open %script-name%" (opens a live script for editing in the active channel)
"close" (closes the currently open live script in the active channel)
"code" (outputs a line-numbered code listing of the currently open live script in the active channel)
"list" (outputs a listing of available live scripts, and highlights enabled scripts)
"replace [L]%line-number% %old-code%|%new-code%" (replaces a line of code in the currently open live script)
"delete-line [L]%line-number%" (deletes a line of code in the currently open live script)
"insert [L]%line-number% %code%" (inserts a line of code in the currently open live script)
"add %code%" (adds a line of code to the currently open live script)

import and export (from/to file) actions are also proposed but not yet implemented.

live scripts have access to common lib functions used by other scripts, and also have direct access to $nick, $dest (channel), $trailing. the privmsg lib function doesn't work for live scripts as the live script handler is triggered internally by the bot using a registered privmsg event handler, so to privmsg the channel that the sender ($nick) is in you simply call pm($dest,"message) instead.

when a new live script is created, it must be enabled before it will run, but once enabled any changes will come into affect immediately.

whilst the code is currently limited to php, it could potentially be adapted to execute code in other languages using their command-line interpreters. it also doesn't have to be limited to code. it could potentially be used to collaborate on lines of non-executing text (such as for collaborative editing of SN submissions). with some tweaks it could be possible to collaborate on code as well, with other users being able to add/edit/delete lines but requiring the operator to re-enable the script for changes to come into effect.

==!isr==
In Soviet Russia, x2 x1s YOU!

==.macro==

syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>

syntax to delete: .macro <trigger> -

<chanlist> is comma-separated or * for any

Used to set a PRIVMSG or INTERNAL macro.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130

==.relays==
Outputs a list of freenode channel relays currently active.
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111

==systemctl==
syntax: systemctl %subject% 
tries to do %subject% and fails

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec aliases

2015-12-27T03:15:41Z

Crutchy:

[[IRC:exec]]

a link to exec's main wiki page will be output if any user types "exec: help" in a channel where the bot resides 

==~==

==~bot==

==~bucket==

==~buckets-dump==

==~buckets-flush==

==~buckets-list==

==~buckets-load==

==~buckets-save==

==~chart==

==~cid==

==~comments==
https://soylentnews.org/~crutchy/journal/1098

==~count==
~count <nick>

==~cowsay==

==~define==
~define term

==~define-add==
~define-add term, meaning

==~define-count==

==~define-delete==

==~define-list==

==~define-source-edit==

==~define-source-param==

==~define-sources==

==~deop==

==~dest-clear==

==~dest-override==

==~devoice==

==~find-first==
~find-first <text>

==~find-last==
~find-last <text>

==~first==
~first <nick>

==~fortune==

==~g'day==

==~gday==

==~header==
~header <header> <url> 
returns value of header (if found) 
fails silently if error occurs or header not found

==~header-login==

==~help==

==~ignore==

==~invite==

==~ircd==

==~isup==
~isup host[:port] (checks connection, returns http status if found)

==~join==
~join #channel (don't have to be channel op)

==~kick==

syntax: ~kick %nick% 
kicks %nick% from the channel. admin-only command

==~kill==

syntax: ~kill %pid% 
kills process run by exec with process id %pid% 
admin-only command 
only works for processes run by exec. processes outside exec aren't affected by this command

==~killall==

kills all processes being run by the bot at the time. admin-only command

==~last==
~last <nick>

==~link==

syntax to search: ~link %search%, set: ~link %id% %content%, delete: ~link %id% -

can't use pipe (|) char, %id% can't contain spaces, but %content% can, %search% is a regexp pattern

will return a list of one or more %id% => %content% if %search% matches either %id% or %content%

==~links==

alias of ~link

==~list==
syntax: ~list 
lists available commands that don't require elevated privs

==~list-auth==
syntax: ~list-auth 
lists available commands requiring nickserv authentication

==~location==
~location %name% 
returns the location associated with the specified name

==~lock==
syntax: ~lock %alias% 
treats all lines entered as being prefixed with alias, channel-specific 
see also: ~unlock

==~log==

syntax: ~log param=value ... 
returns data from chromas' logging website 
refer to http://chromas.0x.no/s/soylent_log.php for more info

==~moo==

apt-get moo

==~op==

syntax: ~op [%nick%] 
admin-only command 
%nick% is optional 
if %nick% isn't specified, will op the calling admin 
if %nick% is supplied, will op the specified %nick% 
bot must be op in channel

==~openthepodbaydoors==

fortune -s -o

==~part==
instruct bot to leave the current channel, or a different channel with optional parameter 
syntax: ~part [channel]

==~php==

==~ps==

==~q==

==~queue==
~queue (returns number of SN submissions in the queue)

==~rainbow==
~rainbow text

==~rehash==

==~remind==

==~restart==

==rofl==

==~say==

==~scramble==

==~sed==
~sed on|off 
[nick[:|,|>|.] ]s/pattern/replace[/[g]] (similar to SedBot)

==~staff==
syntax: ~staff meeting 
displays meeting info from either the site news slashbox or the board meeting wiki page

==~suggest==

==~tests==

==~time==
Syntax: ~time location 
Related commands: ~time-add ~time-del ~location 
Developer(s): crutchy 
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php

==~time-add==

==~time-del==

==~title==

==~translate==
~translate tolang text (auto-detects source lang, eg: ~translate en prueba)

==~translate-sl==
~translate-sl fromlang tolang text (eg: ~translate-sl es en prueba)

==~unignore==

==~unlock==
Syntax: ~unlock 
Related commands: ~lock 
Developers: crutchy 
Sources: https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

==~up==

==~users==

syntax: ~users %command% %subject% 
admin-only command 
where %command% is one of: 
===nicks===
%subject% is the channel that you want to get a listing of nicks for
===channels===
%subject% is the nick that you want to get a list of channels for
===all-channels===
%subject% not applicable for this command 
returns a listing of all channels that stored users are members of
===count===
%subject% is the channel that you want the user count of
===data===
%subject% is the nick that you want to return stored data for
===account===
%subject% is the nick that you want to find out the nickserv account of

==~voice==

==~weather==
Syntax: 
~weather location 
Examples: 
~weather JFK 
~weather vostok, aq 
Related commands: 
~weather-add 
~time-add 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php

==~weather-add==
Syntax: ~weather-add name location 
Developer(s): crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php 
Related commands: 
~weather 
~time 
~time-add 
~location 
Description: 
Enables storing a short name to refer to a longer location description when using the ~weather or ~time commands. 
If a name already exists, setting it again will overwrite the existing named location. 
Names cannot be deleted at this stage. 
A few thousand ICAO and IATA/FAA airport codes have been imported into the codes file thanks to OpenFlights. 
<crutchy> ~weather-add crutchy melbourne australia 
<exec> code "crutchy" set for location "melbourne australia"

==~weather-del==

==~welcome==

==~wiki==

==~x==

the "~x" alias allows a bot operator to create and manage scripts from within IRC (dubbed "live scripts")

scripts created using this alias are stored in a bucket by the bot instead of a file

the handler uses php's eval to run live scripts

to prevent anyone from executing arbitrary commands on the bot host, a whois command is issued to verify that the NickServ account of the user of the ~x alias is the bot operator (by settling the userlist parameter of the alias definition line to "@")

the general form of the command is:

~x %action% [%param%] [%code%]

in a nutshell the possible actions and params are:
"global on|off" (enables or disables all live scripts)
"kill" (a shorcut for disabling all live scripts)
"enable %script-name%" (enables an individual live script)
"disable %script-name%" (disables an individual live script)
"delete-script %script-name%" (deletes a live script from memory)
"open %script-name%" (opens a live script for editing in the active channel)
"close" (closes the currently open live script in the active channel)
"code" (outputs a line-numbered code listing of the currently open live script in the active channel)
"list" (outputs a listing of available live scripts, and highlights enabled scripts)
"replace [L]%line-number% %old-code%|%new-code%" (replaces a line of code in the currently open live script)
"delete-line [L]%line-number%" (deletes a line of code in the currently open live script)
"insert [L]%line-number% %code%" (inserts a line of code in the currently open live script)
"add %code%" (adds a line of code to the currently open live script)

import and export (from/to file) actions are also proposed but not yet implemented.

live scripts have access to common lib functions used by other scripts, and also have direct access to $nick, $dest (channel), $trailing. the privmsg lib function doesn't work for live scripts as the live script handler is triggered internally by the bot using a registered privmsg event handler, so to privmsg the channel that the sender ($nick) is in you simply call pm($dest,"message) instead.

when a new live script is created, it must be enabled before it will run, but once enabled any changes will come into affect immediately.

whilst the code is currently limited to php, it could potentially be adapted to execute code in other languages using their command-line interpreters. it also doesn't have to be limited to code. it could potentially be used to collaborate on lines of non-executing text (such as for collaborative editing of SN submissions). with some tweaks it could be possible to collaborate on code as well, with other users being able to add/edit/delete lines but requiring the operator to re-enable the script for changes to come into effect.

==.macro==

syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>

syntax to delete: .macro <trigger> -

<chanlist> is comma-separated or * for any

Used to set a PRIVMSG or INTERNAL macro.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130

==.relays==
Outputs a list of freenode channel relays currently active.
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111

==systemctl==
syntax: systemctl %subject% 
tries to do %subject% and fails

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec aliases

2015-12-27T02:53:26Z

Crutchy:

[[IRC:exec]]

==~==

==~bot==

==~bucket==

==~buckets-dump==

==~buckets-flush==

==~buckets-list==

==~buckets-load==

==~buckets-save==

==~chart==

==~cid==

==~comments==
https://soylentnews.org/~crutchy/journal/1098

==~count==
~count <nick>

==~cowsay==

==~define==
~define term

==~define-add==
~define-add term, meaning

==~define-count==

==~define-delete==

==~define-list==

==~define-source-edit==

==~define-source-param==

==~define-sources==

==~deop==

==~dest-clear==

==~dest-override==

==~devoice==

==~find-first==
~find-first <text>

==~find-last==
~find-last <text>

==~first==
~first <nick>

==~fortune==

==~g'day==

==~gday==

==~header==
~header <header> <url> 
returns value of header (if found) 
fails silently if error occurs or header not found

==~header-login==

==~help==

==~ignore==

==~invite==

==~ircd==

==~isup==
~isup host[:port] (checks connection, returns http status if found)

==~join==
~join #channel (don't have to be channel op)

==~kick==

==~kill==

==~killall==

==~last==
~last <nick>

==~link==

syntax to search: ~link %search%, set: ~link %id% %content%, delete: ~link %id% -

can't use pipe (|) char, %id% can't contain spaces, but %content% can, %search% is a regexp pattern

will return a list of one or more %id% => %content% if %search% matches either %id% or %content%

==~list==
~list (lists available commands)

==~list-auth==
~list-auth (lists available commands requiring NickServ account authorization)

==~location==
~location code

==~lock==
~lock alias (treats all lines entered as being prefixed with alias, channel-specific)

==~log==

==~moo==

==~op==

==~part==
instruct bot to leave the current channel, or a different channel with optional parameter 
syntax: ~part [channel]

==~php==

==~ps==

==~q==

==~queue==
~queue (returns number of SN submissions in the queue)

==~rainbow==
~rainbow text

==~rehash==

==~remind==

==~restart==

==rofl==

==~say==

==~scramble==

==~sed==
~sed on|off 
[nick[:|,|>|.] ]s/pattern/replace[/[g]] (similar to SedBot)

==~staff==
syntax: ~staff meeting 
displays meeting info from either the site news slashbox or the board meeting wiki page

==~suggest==

==~tests==

==~time==
Syntax: 
~time location 
Related commands: 
~time-add 
~time-del 
~location 
Developer(s): 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php

==~time-add==

==~time-del==

==~title==

==~translate==
~translate tolang text (auto-detects source lang, eg: ~translate en prueba)

==~translate-sl==
~translate-sl fromlang tolang text (eg: ~translate-sl es en prueba)

==~unignore==

==~unlock==
Syntax: 
~unlock 
Related commands: 
~lock 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

==~up==

==~users==

syntax: ~users %command% %subject% 
where %command% is one of: 
===nicks===
%subject% is the channel that you want to get a listing of nicks for
===channels===
%subject% is the nick that you want to get a list of channels for
===all-channels===
%subject% not applicable for this command 
returns a listing of all channels that stored users are members of
===count===
%subject% is the channel that you want the user count of
===data===
%subject% is the nick that you want to return stored data for
===account===
%subject% is the nick that you want to find out the nickserv account of

==~voice==

==~weather==
Syntax: 
~weather location 
Examples: 
~weather JFK 
~weather vostok, aq 
Related commands: 
~weather-add 
~time-add 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php

==~weather-add==
Syntax: ~weather-add name location 
Developer(s): crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php 
Related commands: 
~weather 
~time 
~time-add 
~location 
Description: 
Enables storing a short name to refer to a longer location description when using the ~weather or ~time commands. 
If a name already exists, setting it again will overwrite the existing named location. 
Names cannot be deleted at this stage. 
A few thousand ICAO and IATA/FAA airport codes have been imported into the codes file thanks to OpenFlights. 
<crutchy> ~weather-add crutchy melbourne australia 
<exec> code "crutchy" set for location "melbourne australia"

==~weather-del==

==~welcome==

==~wiki==

==~x==

the "~x" alias allows a bot operator to create and manage scripts from within IRC (dubbed "live scripts")

scripts created using this alias are stored in a bucket by the bot instead of a file

the handler uses php's eval to run live scripts

to prevent anyone from executing arbitrary commands on the bot host, a whois command is issued to verify that the NickServ account of the user of the ~x alias is the bot operator (by settling the userlist parameter of the alias definition line to "@")

the general form of the command is:

~x %action% [%param%] [%code%]

in a nutshell the possible actions and params are:
"global on|off" (enables or disables all live scripts)
"kill" (a shorcut for disabling all live scripts)
"enable %script-name%" (enables an individual live script)
"disable %script-name%" (disables an individual live script)
"delete-script %script-name%" (deletes a live script from memory)
"open %script-name%" (opens a live script for editing in the active channel)
"close" (closes the currently open live script in the active channel)
"code" (outputs a line-numbered code listing of the currently open live script in the active channel)
"list" (outputs a listing of available live scripts, and highlights enabled scripts)
"replace [L]%line-number% %old-code%|%new-code%" (replaces a line of code in the currently open live script)
"delete-line [L]%line-number%" (deletes a line of code in the currently open live script)
"insert [L]%line-number% %code%" (inserts a line of code in the currently open live script)
"add %code%" (adds a line of code to the currently open live script)

import and export (from/to file) actions are also proposed but not yet implemented.

live scripts have access to common lib functions used by other scripts, and also have direct access to $nick, $dest (channel), $trailing. the privmsg lib function doesn't work for live scripts as the live script handler is triggered internally by the bot using a registered privmsg event handler, so to privmsg the channel that the sender ($nick) is in you simply call pm($dest,"message) instead.

when a new live script is created, it must be enabled before it will run, but once enabled any changes will come into affect immediately.

whilst the code is currently limited to php, it could potentially be adapted to execute code in other languages using their command-line interpreters. it also doesn't have to be limited to code. it could potentially be used to collaborate on lines of non-executing text (such as for collaborative editing of SN submissions). with some tweaks it could be possible to collaborate on code as well, with other users being able to add/edit/delete lines but requiring the operator to re-enable the script for changes to come into effect.

==.macro==

syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>

syntax to delete: .macro <trigger> -

<chanlist> is comma-separated or * for any

Used to set a PRIVMSG or INTERNAL macro.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130

==.relays==
Outputs a list of freenode channel relays currently active.
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111

==systemctl==
syntax: systemctl %subject% 
tries to do %subject% and fails

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-12-15T11:35:01Z

Crutchy: /* SoylentNews Wiki spam combat */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

===Get a list of commands===

* ~list
* ~list-auth

===Get help for a command===

* ~help ~command

===Public commands===

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

==SoylentNews Wiki spam combat==

Spam control features have been developed to help control botspam in the SN wiki.
These are a selection of commands that will only work in the #wiki channel.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki.php

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki_lib.php

===.delpage===
syntax: .delpage %title% 
Deletes page with specified title. 
This command is restricted to a list of hard coded NickServ accounts with wiki admin rights. 
If there are no wiki admins around and there is a clear spam violation, two trusted irc nickserv accounts may delete a page by each issuing the .delpage command for the same title.

===.undelpage===
syntax: .undelpage %title% 
Use this command to undo a .delpage command by a trusted irc nickserv account who isn't a wiki admin. 
Must be either a wiki admin or trusted irc nickserv account.

===.listspamrules===
syntax: .listspamrules 
Lists the regular expressions that are used to match names of users that edit the wiki. If the username matches one or more patterns, the page edited is automatically flagged.
===.listspamusers===
syntax: .listspamusers 
Output blacklisted usernames, who when editing a page will trigger exec to automatically flag it as spam.
===.listsafeusers===
syntax: .listsafeusers 
Output whitelisted usernames, who will be allowed to make edits even if their username is blacklisted or matches a regexp rule.
===.delspamrule===
syntax: .delspamrule %pattern% 
Deletes the specified pattern from the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.testrules===
syntax: .testrules %username% 
Runs %username% through the regular expressions in the list of spam rules. Returns 'match' or 'no match'.
===.spamrule===
syntax: .spamrule %pattern% 
Adds the specified pattern to the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamctl===
syntax: .spamctl %title% 
syntax: .spamctl last 
Commands exec to mark either the specified page as spam, or to mark the last edit output by the WikiRC bot. 
This is a privileged command (authorized users must be identified with NickServ).
===.delsafeuser===
syntax: .delsafeuser %username% 
Deletes the specified username from the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.safeuser===
syntax: .safeuser %username% 
Adds the specified username to the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.delspamuser===
syntax: .delspamuser %username% 
Deletes the specified username from the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamuser===
syntax: .spamuser %username% 
Adds the specified username to the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-12-13T10:48:02Z

Crutchy: added .undelpage

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

===Get a list of commands===

* ~list
* ~list-auth

===Get help for a command===

* ~help ~command

===Public commands===

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

==SoylentNews Wiki spam combat==

Spam control features have been developed to help control botspam in the SN wiki.
These are a selection of commands that will only work in the #wiki channel.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki.php

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki_lib.php

===.delpage===
syntax: .delpage %title% 
Deletes page with specified title. 
This command is restricted to a list of hard coded NickServ accounts with wiki admin rights. 
If there are no wiki admins around and there is a clear spam violation, two trusted irc nickserv accounts may delete a page by each issuing the .delpage command for the same title.

===.undelpage===
syntax: .undelpage %title% 
Use this command to undo a .delpage command by a trusted irc nickserv account who isn't a wiki admin. 
Must be either a wiki admin or trusted irc nickserv account.

===.listspamrules===
syntax: .listspamrules 
Lists the regular expressions that are used to match names of users that edit the wiki. If the username matches one or more patterns, the page edited is automatically flagged.
===.listspamusers===
syntax: .listspamusers 
Output blacklisted usernames, who when editing a page will trigger exec to automatically flag it as spam.
===.listsafeusers===
syntax: .listsafeusers 
Output whitelisted usernames, who will be allowed to make edits even if their username is blacklisted or matches a regexp rule.
===.delspamrule===
syntax: .delspamrule %pattern% 
Deletes the specified pattern from the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamrule===
syntax: .spamrule %pattern% 
Adds the specified pattern to the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamctl===
syntax: .spamctl %title% 
syntax: .spamctl last 
Commands exec to mark either the specified page as spam, or to mark the last edit output by the WikiRC bot. 
This is a privileged command (authorized users must be identified with NickServ).
===.delsafeuser===
syntax: .delsafeuser %username% 
Deletes the specified username from the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.safeuser===
syntax: .safeuser %username% 
Adds the specified username to the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.delspamuser===
syntax: .delspamuser %username% 
Deletes the specified username from the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamuser===
syntax: .spamuser %username% 
Adds the specified username to the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-12-13T09:59:35Z

Crutchy: /* .delpage */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

===Get a list of commands===

* ~list
* ~list-auth

===Get help for a command===

* ~help ~command

===Public commands===

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

==SoylentNews Wiki spam combat==

Spam control features have been developed to help control botspam in the SN wiki.
These are a selection of commands that will only work in the #wiki channel.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki.php

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki_lib.php

===.delpage===
syntax: .delpage %title% 
Deletes page with specified title. 
This command is restricted to a list of hard coded NickServ accounts with wiki admin rights.
If there are no wiki admins around and there is a clear spam violation, two trusted irc nickserv accounts may delete a page by each issuing the .delpage command for the same title.

===.listspamrules===
syntax: .listspamrules 
Lists the regular expressions that are used to match names of users that edit the wiki. If the username matches one or more patterns, the page edited is automatically flagged.
===.listspamusers===
syntax: .listspamusers 
Output blacklisted usernames, who when editing a page will trigger exec to automatically flag it as spam.
===.listsafeusers===
syntax: .listsafeusers 
Output whitelisted usernames, who will be allowed to make edits even if their username is blacklisted or matches a regexp rule.
===.delspamrule===
syntax: .delspamrule %pattern% 
Deletes the specified pattern from the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamrule===
syntax: .spamrule %pattern% 
Adds the specified pattern to the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamctl===
syntax: .spamctl %title% 
syntax: .spamctl last 
Commands exec to mark either the specified page as spam, or to mark the last edit output by the WikiRC bot. 
This is a privileged command (authorized users must be identified with NickServ).
===.delsafeuser===
syntax: .delsafeuser %username% 
Deletes the specified username from the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.safeuser===
syntax: .safeuser %username% 
Adds the specified username to the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.delspamuser===
syntax: .delspamuser %username% 
Deletes the specified username from the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamuser===
syntax: .spamuser %username% 
Adds the specified username to the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-12-12T10:52:56Z

Crutchy: added delpage

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

===Get a list of commands===

* ~list
* ~list-auth

===Get help for a command===

* ~help ~command

===Public commands===

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

==SoylentNews Wiki spam combat==

Spam control features have been developed to help control botspam in the SN wiki.
These are a selection of commands that will only work in the #wiki channel.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki.php

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki_lib.php

===.delpage===
syntax: .delpage %title% 
Deletes page with specified title. 
This command is restricted to a list of hard coded NickServ accounts.
===.listspamrules===
syntax: .listspamrules 
Lists the regular expressions that are used to match names of users that edit the wiki. If the username matches one or more patterns, the page edited is automatically flagged.
===.listspamusers===
syntax: .listspamusers 
Output blacklisted usernames, who when editing a page will trigger exec to automatically flag it as spam.
===.listsafeusers===
syntax: .listsafeusers 
Output whitelisted usernames, who will be allowed to make edits even if their username is blacklisted or matches a regexp rule.
===.delspamrule===
syntax: .delspamrule %pattern% 
Deletes the specified pattern from the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamrule===
syntax: .spamrule %pattern% 
Adds the specified pattern to the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamctl===
syntax: .spamctl %title% 
syntax: .spamctl last 
Commands exec to mark either the specified page as spam, or to mark the last edit output by the WikiRC bot. 
This is a privileged command (authorized users must be identified with NickServ).
===.delsafeuser===
syntax: .delsafeuser %username% 
Deletes the specified username from the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.safeuser===
syntax: .safeuser %username% 
Adds the specified username to the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.delspamuser===
syntax: .delspamuser %username% 
Deletes the specified username from the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamuser===
syntax: .spamuser %username% 
Adds the specified username to the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).

[[Category:IRC]]
[[Category:IRC:exec]]

IRC

2015-12-12T10:31:18Z

Crutchy: updated exec devs/ops

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:cmn32480|cmn32480]] (op) 
* [[User:Crutchy|crutchy]] (admin/dev) 
* [[User:chromas|chromas]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

User:Exec

2015-12-12T10:24:31Z

Crutchy:

[[IRC:exec]]

[[user:crutchy]]

[[IRC:exec#SoylentNews_Wiki_spam_combat]]

https://github.com/crutchy-/exec-irc-bot

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki.php

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki_lib.php

[[Category:IRC]]
[[Category:IRC:exec]]

User:Exec

2015-12-12T10:24:07Z

Crutchy:

[[IRC:exec]]

[[user:crutchy]]

[[IRC:exec#SoylentNews_Wiki_spam_combat]]

[[https://github.com/crutchy-/exec-irc-bot]]

[[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki.php]]

[[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki_lib.php]]

[[Category:IRC]]
[[Category:IRC:exec]]

ApiDocs

2015-12-02T09:01:17Z

Crutchy: /* Example scripts */

[[Development]] - parent

==Foreword==
This is the documentation for the upcoming SoylentNews API that I'm working on. It is currently live but it's possible it may cease to be that way. In the event that it doesn't though, I want it documented so people can actually start building against it right off.

==Layout==
Code is arranged with methods (m=foo) being the highest order of operation, each able to perform several ops (m=foo&op=bar, m=foo&op=baz). Each op requires or allows different arguments, depending on what is being done.

==Methods==
The top level methods are as follows:
* user
** operations on users such as looking up a uid by nickname or vice versa
* comment
** operations on comments like getting the latest or an entire discussion's comments
* story
** operations on stories such as getting the latest or a single story
* journal
** not yet implemented
* auth
** not yet implemented
* default
** any other method currently returns an empty 200 status. error text would not be a bad idea though.

==Operations==
The operations for each method are as follows:
===user ops===
* max_uid - takes no arguments and returns the highest user id.
** <pre>https://soylentnews.org/api.pl?m=user&op=max_uid</pre>
* get_uid - takes "nick" as an argument and returns the uid associated or null if there is no such user. the following are all equivilent:
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The Mighty Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The+Mighty+Buzzard</pre>
** <pre>https://soylentnews.org/api.pl?m=user&op=get_uid&nick=The%20Mighty%20Buzzard</pre>
* get_nick - takes "uid" as an argument and returns the nickname associated or null if there is no such user.
** <pre>https://soylentnews.org/api.pl?m=user&op=get_nick&uid=18</pre>
* get_user - takes "uid" as an argument and returns full public user information for the user
** <pre>https://soylentnews.org/api.pl?m=user&op=get_user&uid=18</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===comment ops===
* latest - returns the latest 50 comments without argument or all comments since the comment id supplied in the argument "since". if "since" is not numeric, the latest 50 are returned. if since is too high, an empty json array is returned
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=latest&since=27700</pre>
* discussion - returns all comments in a discussion. takes "sid" as an argument. sid must be the numeric story id here unlike with m=story&op=single. returns an empty 200 on error. this should be fixed.
** <pre>https://soylentnews.org/api.pl?m=comment&op=discussion&sid=1117</pre>
* single - returns a single comment specified by the "cid" argument.
** <pre>https://soylentnews.org/api.pl?m=comment&op=single&cid=27698</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=comment&op=reskey</pre>
* post - posts a comment. sid, postersubj, posttype, reskey, and postercomment are required. sid may be numeric or in "14/08/07/1647258" form. preview=1 will return a json-encoded preview exactly as it would be included on the webpage for viewing. to reply to another comment, set pid = the comment to reply to's cid. I very much suggest you use a POST request here or it will be a huge pain to fill out postercomment properly and you will be limited by GET request max length. posttype is as follows: 1 Plain Old Text, 2 HTML, 3 Extrans (HTML tags to text), 4 Code reskey comes from a previous call to the m=comment&op=reskey op ten seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&preview=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1</pre>
** <pre>https://soylentnews.org/api.pl?m=comment&op=post&sid=1128&postersubj=chickenbutt&postercomment=man+who+cares+even+more&posttype=1&pid=27719</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===story ops===
* latest - returns the latest 10 stories. optionally takes "limit" as an argument for the number of stories returned, which may range from 1-50. On dev you may also specify "tid" as an argument. Behavior is however strange currently. If tid is the tid of a topic, you will get stories of that topic from every nexus; if tid belongs to a nexus, you will get stories of every topic within that nexus. This needs to be changed but it would require changing the main site as well.
** <pre>https://soylentnews.org/api.pl?m=story&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=latest&limit=42</pre>
* single - returns a single story. takes "sid" as an option. may be in the form of either sid=14/08/07/1647258 or sid=832. returns an empty 200 on error.
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=14/08/07/1647258</pre>
** <pre>https://soylentnews.org/api.pl?m=story&op=single&sid=832</pre>
* pending - returns a json hash containing current submissions and pending stories. takes no arguments
** <pre>https://soylentnews.org/api.pl?m=story&op=pending</pre>
* reskey - returns a reskey for later use in the post op. takes no arguments.
** <pre>https://soylentnews.org/api.pl?m=story&op=reskey</pre>
* post - submit a story. subj, reskey, story, tid, sub_type, and primaryskid are required. name is optional. POST method is absolutely required for submissions primaryskid should be set to 1 until nexuses are working sub_type should be either "plain" or "html" reskey comes from a previous call to the m=story&op=reskey op name, subj, and story are up to you tid the topic and is the same as the values on submit.pl: 2=Answers, 4=Slash, 5=Code, 6=News, 9=Hardware, 10=/dev/random, 11=OS, 12=Business, 13=Mobile, 14=Science, 15=Security, 16=Software, 18=Techonomics, 19=Career & Education On dev you may use the topiclist story op to obtain a current list of topics. Twenty seconds are required between reskey creation and use so do a reskey creation call before allowing the user to enter data
** <pre>no GET example will work, the POST method is required. https//soylentnews.org/api.pl?m=story&op=post&subj="..."&reskey='...'&story='...'&tid='...'&sub_type='...'&primaryskid='...'&name='...'</pre>
* nexuslist - returns an array of hashes containing data on every nexus (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=nexuslist</pre>
* topiclist - returns an array of hashes containing data on every topic (dev only)
** <pre>https://soylentnews.org/api.pl?m=story&op=topiclist</pre>
* default - any other op returns an empty 200 status. error text would not be a bad idea though.

===journal ops===
* latest - returns the latest 20 journal entries. optionally takes "limit" and "uid" as arguments. limit specifies the number of results while uid specifies only entries by the user with that uid. limit may be anything in the range of 1-50.
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&limit=42</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2</pre>
** <pre>https://soylentnews.org/api.pl?m=journal&op=latest&uid=2&limit=3</pre>
* Single - returns a single journal entry specified by the argument "id". This is a journal id not a story id.
** <pre>https://soylentnews.org/api.pl?m=journal&op=single&id=204</pre>

===auth ops===
*login - Logs you in, duh. Takes nick and pass as mandatory arguments. Currently returns the cookie value. DO NOT USE THE COOKIE VALUE. Use the proper cookie returned in the headers as this will change to a success/failure check only soon. You should also probably do this via POST for security reasons.
**<pre>https://soylentnews.org/api.pl?m=auth&op=login&nick=The Mighty Buzzard&pass=ilikecheese</pre>

==Errata==
* The "uid" field data will always be truncated to only leading digits as part of slash internals. uid=18z becomes 18, uid=1z8 becomes 1, uid=z18 becomes a null value. This is expected behavior.
==Related pages==
[[SN API ideas]]

==Example scripts==
* PHP script used by the exec IRC bot: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/sn_api.php
===Usage===
<pre>Syntax: ~api [%argument1%=%value1% %argument2%=%value2%] [/%element%]</pre>
There can be as many argument=value pairs as you like, and the element is optional and corresponds to a key in the json structure
<pre>~api m=user op=get_uid nick=The Mighty Buzzard /uid</pre>

The element may also contain forward-slashes that correspond to array levels, allowing you to drill down into an array structure to retrieve a specific piece of data.
For example, to get the uid of the latest comment:
<pre>~api m=comment op=latest /0/uid</pre>

[[Category:Development]]

IRC:exec

2015-11-08T10:38:50Z

Crutchy: /* Quick start */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

===Get a list of commands===

* ~list
* ~list-auth

===Get help for a command===

* ~help ~command

===Public commands===

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

==SoylentNews Wiki spam combat==

The exec bot has a wiki user account with the bot flag set.
Spam control features have been developed to help control botspam in the SN wiki.
These are a selection of commands that will only work in the #wiki channel.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki.php

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki_lib.php

===.listspamrules===
syntax: .listspamrules 
Lists the regular expressions that are used to match names of users that edit the wiki. If the username matches one or more patterns, the page edited is automatically flagged.
===.listspamusers===
syntax: .listspamusers 
Output blacklisted usernames, who when editing a page will trigger exec to automatically flag it as spam.
===.listsafeusers===
syntax: .listsafeusers 
Output whitelisted usernames, who will be allowed to make edits even if their username is blacklisted or matches a regexp rule.
===.delspamrule===
syntax: .delspamrule %pattern% 
Deletes the specified pattern from the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamrule===
syntax: .spamrule %pattern% 
Adds the specified pattern to the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamctl===
syntax: .spamctl %title% 
syntax: .spamctl last 
Commands exec to mark either the specified page as spam, or to mark the last edit output by the WikiRC bot. 
This is a privileged command (authorized users must be identified with NickServ).
===.delsafeuser===
syntax: .delsafeuser %username% 
Deletes the specified username from the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.safeuser===
syntax: .safeuser %username% 
Adds the specified username to the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.delspamuser===
syntax: .delspamuser %username% 
Deletes the specified username from the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamuser===
syntax: .spamuser %username% 
Adds the specified username to the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).

[[Category:IRC]]
[[Category:IRC:exec]]

IRC

2015-11-01T23:38:45Z

Crutchy: /* Bots */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:Crutchy|crutchy]] (dev/op) 
* [[User:chromas|chromas]] (admin) 
* [[User:juggs|juggs]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2015-11-01T23:38:09Z

Crutchy: /* Bots */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:Crutchy|crutchy]] (dev/op) 
* [[User:chromas|chromas]] (admin) 
* [[User:juggs|juggs]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:PlowKing|PlowKing]] || || ||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC

2015-11-01T23:32:39Z

Crutchy:

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

[[IRC links]]

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:Crutchy|crutchy]] (dev/op) 
* [[User:chromas|chromas]] (admin) 
* [[User:juggs|juggs]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC:exec

2015-11-01T22:52:44Z

Crutchy: /* SoylentNews Wiki spam combat */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

==SoylentNews Wiki spam combat==

The exec bot has a wiki user account with the bot flag set.
Spam control features have been developed to help control botspam in the SN wiki.
These are a selection of commands that will only work in the #wiki channel.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki.php

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/wiki_lib.php

===.listspamrules===
syntax: .listspamrules 
Lists the regular expressions that are used to match names of users that edit the wiki. If the username matches one or more patterns, the page edited is automatically flagged.
===.listspamusers===
syntax: .listspamusers 
Output blacklisted usernames, who when editing a page will trigger exec to automatically flag it as spam.
===.listsafeusers===
syntax: .listsafeusers 
Output whitelisted usernames, who will be allowed to make edits even if their username is blacklisted or matches a regexp rule.
===.delspamrule===
syntax: .delspamrule %pattern% 
Deletes the specified pattern from the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamrule===
syntax: .spamrule %pattern% 
Adds the specified pattern to the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamctl===
syntax: .spamctl %title% 
syntax: .spamctl last 
Commands exec to mark either the specified page as spam, or to mark the last edit output by the WikiRC bot. 
This is a privileged command (authorized users must be identified with NickServ).
===.delsafeuser===
syntax: .delsafeuser %username% 
Deletes the specified username from the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.safeuser===
syntax: .safeuser %username% 
Adds the specified username to the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.delspamuser===
syntax: .delspamuser %username% 
Deletes the specified username from the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamuser===
syntax: .spamuser %username% 
Adds the specified username to the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-11-01T01:56:37Z

Crutchy: /* SoylentNews Wiki spam combat */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

==SoylentNews Wiki spam combat==

The exec bot has a wiki user account with the bot flag set.
Spam control features have been developed to help control botspam in the SN wiki.
These are a selection of commands that will only work in the #wiki channel.

===.listspamrules===
syntax: .listspamrules 
Lists the regular expressions that are used to match names of users that edit the wiki. If the username matches one or more patterns, the page edited is automatically flagged.
===.listspamusers===
syntax: .listspamusers 
Output blacklisted usernames, who when editing a page will trigger exec to automatically flag it as spam.
===.listsafeusers===
syntax: .listsafeusers 
Output whitelisted usernames, who will be allowed to make edits even if their username is blacklisted or matches a regexp rule.
===.delspamrule===
syntax: .delspamrule %pattern% 
Deletes the specified pattern from the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamrule===
syntax: .spamrule %pattern% 
Adds the specified pattern to the wiki spam rules file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamctl===
syntax: .spamctl %title% 
syntax: .spamctl last 
Commands exec to mark either the specified page as spam, or to mark the last edit output by the WikiRC bot. 
This is a privileged command (authorized users must be identified with NickServ).
===.delsafeuser===
syntax: .delsafeuser %username% 
Deletes the specified username from the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.safeuser===
syntax: .safeuser %username% 
Adds the specified username to the wiki safe users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.delspamuser===
syntax: .delspamuser %username% 
Deletes the specified username from the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).
===.spamuser===
syntax: .spamuser %username% 
Adds the specified username to the wiki spam users file. 
This is a privileged command (authorized users must be identified with NickServ).

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-11-01T01:43:31Z

Crutchy:

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

==SoylentNews Wiki spam combat==

.listspamrules
.listspamusers
.listsafeusers
.delspamrule
.spamrule
.spamctl
.delsafeuser
.safeuser
.delspamuser
.spamuser

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec suggestions

2015-10-24T07:49:50Z

Crutchy:

This page contains suggestions for the [[IRC:exec|exec]] IRC bot.

[[Category:IRC]]
[[Category:IRC:exec]]

* IMDB movie info script
* language translation tools

==Suggestions from IRC==
* chromas suggested a submission feed. poll http://sylnt.us/queue every 30 mins ~ [[User:crutchy|crutchy]] @ 02:06, 26 October 2014 (UTC)
* make freepascal version of SN log parser ~ [[User:crutchy|crutchy]] @ 02:08, 26 October 2014 (UTC)
* when regurgitator gets a wiki page, add a section ==Suggestions from IRC== and i'll be able to add a ~suggest-rss scripty to add to the list ~ [[User:crutchy|crutchy]] @ 05:36, 26 October 2014 (UTC)
* crutchy: maybe add a ~videosearch ~ [[User:crutchy|crutchy]] @ 10:52, 26 October 2014 (UTC)
* need to generalize the server post request that i used to upload irciv map images ~ [[User:crutchy|crutchy]] @ 13:00, 27 October 2014 (UTC)
* web interface for ~define-add definitions [chromas] ~ [[User:crutchy|crutchy]] @ 13:01, 27 October 2014 (UTC)
* need to add another list command that just lists options for single poll ~ [[User:crutchy|crutchy]] @ 21:01, 27 October 2014 (UTC)
* web bot management console ~ [[User:crutchy|crutchy]] @ 08:41, 29 October 2014 (UTC)
* with dynamical js thingys and gd charts and stuffs ~ [[User:crutchy|crutchy]] @ 08:44, 29 October 2014 (UTC)
* irciv ☺ ~ [[User:chromas|chromas]] @ 08:44, 29 October 2014 (UTC)
* for scrolling charts, left-align gd image of container width + extra, then increment left css prop of image negative and load next image segment with left prop equal to first img width less first img left, etc ~ [[User:crutchy|crutchy]] @ 08:49, 29 October 2014 (UTC)
* add some checksums/validation/whatevers to the bucket subsystem ~ [[User:crutchy|crutchy]] @ 13:56, 2 November 2014 (UTC)
* feed to flag if suggestion on wiki has been marked done ~ [[User:crutchy|crutchy]] @ 12:08, 8 November 2014 (UTC)
* web console with relay for crutchy's lappy ~ [[User:crutchy|crutchy]] @ 12:12, 8 November 2014 (UTC)
* SN journal feed ~ [[User:crutchy|crutchy]] @ 13:41, 11 November 2014 (UTC)
* commands to pause/unpause timer scripts ~ [[User:crutchy|crutchy]] @ 10:57, 21 November 2014 (UTC)
* maybe command to kill by alias ~ [[User:crutchy|crutchy]] @ 10:58, 21 November 2014 (UTC)
* php lib for slash api ~ [[User:crutchy|crutchy]] @ 11:41, 21 November 2014 (UTC)
* github issue search ~ [[User:crutchy|crutchy]] @ 15:07, 22 November 2014 (UTC)
* unserialize(): Error at offset 0 of 1589 bytes in /nas/server/git/exec-irc-bot/scripts/lib_buckets.php on line 100 on ~rehash ~ [[User:crutchy|crutchy]] @ 11:44, 31 December 2014 (UTC) EDIT: this one is due to a bug in irciv load function
* i need a way to tell what channels a minion is in ~ [[User:crutchy|crutchy]] @ 10:39, 31 January 2015 (UTC)
* if there's no queue message on ~queue, say something to that effect ~ [[User:crutchy|crutchy]] @ 02:07, 12 February 2015 (UTC)
* regex-based grab - chromas ~ [[User:crutchy|crutchy]] @ 12:16, 17 March 2015 (UTC)
* filtered comment pms should list the filter that matched ~ [[User:TheMightyBuzzard|TheMightyBuzzard]] @ 14:05, 20 March 2015 (UTC)
* http://wiki.soylentnews.org/wiki/IRC%3Aexec_suggestions#Suggestions_from_IRC
* ~imdb script ~ [[User:crutchy|crutchy]] @ 07:15, 13 August 2015 (UTC)

IRC

2015-10-24T07:46:39Z

Crutchy: /* Bot projects / task ideas */

Contact '''chat@soylentnews.org''' if you are interested in working on one of these projects. Also, the [[SoylentNews:IRC|IRC Page]] has information about getting started with IRC, and the [[IRCVision|IRC vision]] is worth checking out.

==Who we are==
<section begin=whoarewe />
{| class="wikitable" width="100%"
!colspan="3"|'''[[IRC|IRC Team Main Page]]'''
|-
| style="width: 20%; background-color: #f2f2f2;"|
'''nick'''
| style="width: 40%; background-color: #f2f2f2;"|
'''position'''
| style="width: 40%; background-color: #f2f2f2;"|
'''timezone'''
|-
| [[User:xlefay|xlefay]]
| Co-team leader
| UTC+2 (CEST)
|-
| [[User:juggs|juggs]]
| Co-team leader
| UTC+1 (BST)
|-
| [[User:paulej72|paulej72]]
| Member
| UTC-4 (EDT)
|-
| [[User:FunPika|FunPika]]
| Member
| UTC-4 (EDT)
|-
| [[User:Landon|Landon]]
| Retired Member
| ?
|-
|}
<section end=whoarewe />

==Current Projects==

===Chat bot (Python)===
* ELIZA module that uses Futurama personalities (to match the bot's current nick)
* Modify bot logging to match existing formats (mIRC preferably)

===Services (C)===
* Single sign on against the website (coordinate with NCommander)
* Get the web IRC to use the website's sessions to sign in

===Documentation===
* Quick-Start/How-to guide for staff members (.op .topic nickserv commands etc.)

===Misc bots===
* Anyone wanting to join existing bot development projects should contact the developer(s) noted below.

===IRC Games===
* NerdRPG

==Dependencies==
*servers
*bots

[[Category:Teams]]
[[Category:IRC]]

==Channels==

===Official channels===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| #soylent || General chat/lobby, mostly family-friendly || All SoylentNews Staff
|-
| #staff || Public Staff channel - Everyone's welcome to join, but messages from non-voiced are only send to the ops in the channel || All SoylentNews Staff.
|-
| #editorial || The home of the SoylentNews editors, here you can volunteer for duty, report typo's & ask for submission tips and the like. || Editors & IRC Staff.
|-
| #dev || The home of and for developers that help develop our fork of SlashCode. || Development team & IRC staff.
|-
| #help || This is the IRC help channel, where IRC operators and others provide help and answer any questions related to IRC you may have. || IRC Staff.
|-
| #sysops || This is the Sysops homefront, where most of the magic happens. We maintain the servers and services. || Sysops & IRC Staff.
|-
| #wiki || This is the Wiki's channel, nothing much happens here except for a bot reporting our every edit on the wiki! || IRC Staff.
|-
| #irpg || This is our "nerdRPG"'s (our fork of idleRPG) channel, feel free to idle along! || IRC Staff.
|-
| #test || Main testing chambers, feel free to test anything in here (just be friendly & be considerative) || IRC Staff.
|}

===Private establishments (unofficial)===

{| class="wikitable" style="width:100%;"
|-
! Channel !! Description !! Maintained by
|-
| ## || This is a channel which isn't family safe. It's mostly about bacon and stuff' || team-bacon ([[User:kobach|kobach]], [[User:xlefay|xlefay]])
|-
| # || the batcave; bot testing/borking, random chaos, exec's home || [[User:Alberto|Alberto]]
|-
| #derp || aqu4bot's origin and the portal to Universe 2. Bring own peanut butter. || [[User:Subsentient|Subsentient]]
|-
| #sublight || Sublight's bot home ground || [[User:xlefay|xlefay]]
|-
| #rss-bot || various rss/atom feeds || [[User:juggs|juggs]]
|-
| #debug || bot error spew || [[User:chromas|chromas]]
|-
| #comments || soylentnews.org comments feed || [[User:crutchy|crutchy]]
|-
| #github || ~github-list repos push feed - checked every 5 mins || [[User:crutchy|crutchy]]
|}

==Bots==
There are a few bots lurking in the Soylent IRC channels besides the services mentioned above. 
Anyone wishing to develop bots should use #test or # for testing. 
Please avoid flooding in private establishments and official channels (except #test and #). The #debug channel is used by bots for public error reporting.

{| class="wikitable" width="100%"
|-
! nick !! channels !! triggers !! devs/ops/hosts !! source !! tasks !! usage/notes
|-
| [[Aqu4bot|aqu4]] ||
* # 
* ## 
* #Soylent 
* #derp 
* #test
||
* $ 
* aqu4:
||
* [[User:Subsentient|Subsentient]] (dev/op)
|| http://github.com/Subsentient/aqu4bot ||
* Memos ($sticky) 
* Messaging ($tell) 
* Logging/user tracking 
* Channel control (in #derp)
||
* $sr 
* $seen 
* $tell 
* $help 
* $burrito
|-
| [[IRC:Bender|Bender]] ||
* #Soylent 
* ## 
* #
||
* <nowiki>!</nowiki>
||
* [[User:paulej72|paulej72]] (op)
|| ||
* karma 
* todo
||
* coffee++ 
* <nowiki>!</nowiki>whoup 
* <nowiki>!</nowiki>todo stuff 
* <nowiki>!</nowiki>uid
|-
| [[IRC:ciri|ciri]] ||
* #
|| ||
* [[User:arti|arti]]
|| ||
* Entertainment
||
* <nowiki>!</nowiki>decide yes "other stuff"
* 8ball (your question)
* <nowiki>.</nowiki>country (2 digit code) - country lookup.
* <nowiki>.</nowiki>bin2dec <binary value>
* <nowiki>.</nowiki>binary2decimal <binary value>
* <nowiki>.</nowiki>decimal <binary value>
* <nowiki>.</nowiki>dec2bin <decimal value>
* <nowiki>.</nowiki>decimal2binary <decimal value>
* <nowiki>.</nowiki>binary <decimal value>
* <nowiki>.</nowiki>calc <Equation> - Calculates a mathmatical equation.
* <nowiki>.</nowiki>f2c <Fahrenheit> - Fahrenheit => Celsius.
* <nowiki>.</nowiki>c2f <Celsius> - Celsius => Fahrenheit.
* <nowiki>.</nowiki>ft2m <Feet> - Feet => Meters.
* <nowiki>.</nowiki>m2ft <Meters> - Meters => Feet.
* <nowiki>.</nowiki>mi2km <Miles> - Miles => Kilometers.
* <nowiki>.</nowiki>km2mi <Kilometers> - Kilometers => Miles.
* <nowiki>.</nowiki>lb2kgl <Pounds> - Pounds => Kilograms.
* <nowiki>.</nowiki>kg2lb <Kilograms> - Kilograms => Pounds.
* <nowiki>!</nowiki>word - word scramble game.
* <nowiki>!</nowiki>idle - see who is idle.
* <nowiki>!</nowiki>g (term) - google something.
* <nowiki>!</nowiki>google (.countrycode) (term) - google something.
* <nowiki>!</nowiki>google [.google.country.code] [define:|spell:]
* <search terms> <1+1> <1 cm in ft> <patent ##>
* <weather city|zip> <??? airport>
* <nowiki>!</nowiki>images [.google.country.code] <search terms>
* <nowiki>!</nowiki>groups [.google.country.code] <search terms>
* <nowiki>!</nowiki>news [.google.country.code] <search terms>
* <nowiki>!</nowiki>local [.google.country.code] <what> near <where>
* <nowiki>!</nowiki>book [.google.country.code] <search terms>
* <nowiki>!</nowiki>video [.google.country.code] <search terms>
* <nowiki>!</nowiki>fight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>trans region@region <text>
* <nowiki>!</nowiki>gamespot <search terms>
* <nowiki>!</nowiki>gamefaqs <system> in <region>
* <nowiki>!</nowiki>blog [.google.country.code] <search terms>
* <nowiki>!</nowiki>ebay [.ebay.country.code] <search terms>
* <nowiki>!</nowiki>ebayfight <word(s) one> vs <word(s) two>
* <nowiki>!</nowiki>wikipedia [.2-digit-country-code] <search terms>[#subtag]
* <nowiki>!</nowiki>wikimedia [.www.wikisite.org[/wiki]] <search terms>[#subtag]
* <nowiki>!</nowiki>locate <ip or hostmask>
* <nowiki>!</nowiki>review <gamename> [@ <system>]
* <nowiki>!</nowiki>torrent <search terms>
* <nowiki>!</nowiki>best <system>
* <nowiki>!</nowiki>worst <system>
* <nowiki>!</nowiki>rgb2hex (r:XXX g:XXX b:XXX) - converts rgb value to hex.
* <nowiki>!</nowiki>hex2rgb (XXXXXX) - converts hex color value to rgb.
* <nowiki>!</nowiki>roll (1dX) - rolls a X sided die (1d4, 2d6).
* <nowiki>!</nowiki>disc - discworld quotes
* <nowiki>!</nowiki>dict (word) - dictionary, word lookup via princeton.edu.
* <nowiki>!</nowiki>dailymotion <search terms>
* <nowiki>!</nowiki>ign <search terms>
* <nowiki>!</nowiki>myspace <search terms>
* <nowiki>!</nowiki>trends [.google.country.code] <YYYY-MM-DD>
* <nowiki>!</nowiki>dawn - random dawn of war quote.
* <nowiki>!</nowiki>bofh - random BOfH quote.
* <nowiki>!</nowiki>duke - random duke nukem quote.
* <nowiki>!</nowiki>coffee - order coffee for you or someone.
* <nowiki>!</nowiki>coke - order coffee for you or someone.
* <nowiki>!</nowiki>icecream - shows menu.
* <nowiki>!</nowiki>order (nick) (something) - shows menu.
* <nowiki>!</nowiki>pizza - shows menu.
|-
| [[IRC:diego|diego]] ||
* #soylent
|| ||
* [[User:juggs|juggs]] (op)
|| pircbot + piespy
|| * Generation of piespy relationship maps for #soylent
|| http://stats.sylnt.us/social/soylent/index.html
|-
| [[IRC:exec|exec]] ||
* # 
* #comments 
* #debug 
* #github
||
* ~
||
* [[User:Crutchy|crutchy]] (dev/op) 
* [[User:chromas|chromas]] (admin) 
* [[User:juggs|juggs]] (admin)
|| http://sylnt.us/execsrc || ||
* SN comments feed (in #comments) 
* GitHub events feed (in #github) 
* refer to [[IRC:exec#Quick_start|quick start guide]]
|-
| [[IRC:Loggie|Loggie]] ||
* #Soylent
|| ||
* [[User:xlefay|xlefay]]
|| ||
* logging to logs.sylnt.us
||
* /invite Loggie
|-
| [[IRC:monopoly|Hedonismbot]] ||
* #
* #Soylent
||
* =
||
* [[User:chromas|chromas]] (dev/op)
|| ||
* link title output
||
|-
| [[IRC:NerdRPG|NerdRPG]] ||
* #irpg
|| || || ||
* outputs game data
||
|-
| [[IRC:MrPlow|MrPlow]] ||
* #Soylent 
* #test
||
* ; 
||
* [[User:TheMightyBuzzard|The Mighty Buzzard]] (dev/op)
|| ||
* Translate to Klingon 
* Get staff attention 
* Get help with commands 
* Get local weather 
* Set #weather location 
* Get time/date/channel/message of the last time someone spoke 
* Have a libertarian debate 
||
* #klingon 
* #battlestations 
* #help 
* #weather
* #weatheradd 
* #seen 
* #socialist 
|-
| [[IRC:perlbot|perlbot]] || || ||
* [[User:Konomi|Konomi]] (dev/op)
|| || ||
|-
| [[IRC:Regurgitator|Regurgitator]] ||
* #rss-bot
* #soylent
||
* !rss
||
* [[User:juggs|juggs]] (op)
||
Eggdrop v1.8.0+fixbotnetloop http://www.egghelp.org/files.htm 
rss-synd v0.6 plugin https://github.com/eggtcl/rss-synd
||
* various rss / atom feeds
* logging only in #soylent for pisg stats
||
* #rss-bot !rss to see all feeds. !<feed> to see individual feed contents. Idle in channel to see all feeds.
* #soylent see pisg output here: http://stats.sylnt.us/pisg/index.html
|-
| [[SedBot]] || || ||
* [[User:FoobarBazbot|FoobarBazbot]] (dev/op)
|| https://github.com/FoobarBazbot/sedbot ||
* message correction
||
* s/old/new/ 
* nick: s/old/new/
|-
| [[IRC:SoylentMUD|SoylentMUD]] || || ||
* [[User:mattie_p|mattie_p]]
|| || ||
|-
| [[IRC:sublight|sublight]] || || ||
* [[User:xlefay|xlefay]] (dev/op)
|| || ||
|-
| [[IRC:tama|tama]] ||
* #
|| ||
* [[User:arti|arti]] (op)
|| || ||
|-
| [[WikiRC|WikiRC]] ||
* #wiki
|| ||
* [[User:FunPika|FunPika]]
|| ||
* wiki events feed
||
|}

===Bot projects / task ideas===

* [[IRCiv]] is currently under development for the exec bot and is intended to be a civilization-like building game played on IRC.
* a Soylent PBC board meeting assistant script is currently under development for the exec bot, intended for minute taking and publishing on the wiki. See [[IRC:exec#Meeting_assistant]] for more details.
* an IRC voting system. refer to [[IRC:exec#Proposed_IRC_voting_system]] for details.
* returning data from the SoylentNews using the [[ApiDocs|SlashCode API]]
* [[IRC:exec suggestions]]

== Information for Sysops / IRC admins ==

=== Server Related Info ===

{{#lst:Beryllium|ircops}}

== Information for IRC Operators ==

=== Useful Links ===

* [http://www.stack.nl/~jilles/irc/charybdis-oper-guide Charybdis IRC Ops Guide]
* [http://atheme.net/help/7.0/ Atheme Services Help Pages]

[[Category:IRC]]

IRC:exec

2015-10-23T23:52:39Z

Crutchy: /* Installing and running your own 'exec' bot */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
MYSQL_LOG=0
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

If you want to enable MySQL logging, set the MYSQL_LOG setting to 1 instead of 0, and you will need to create a new schema per [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/schema_log.sql]]. A setup php script [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/mysql/setup_log.php]] has been created to make this a bit simpler. Tweak the password file location in the script to suit.
MySQL logging requires the lib_mysql.php file in the scripts subdirectory [[https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_mysql.php]]. Change the password file location in this file to suit also.

Once you have your settings (and optionally MySQL logging schema) sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

[[Category:IRC]]
[[Category:IRC:exec]]

SoylentNews

2015-10-04T08:48:10Z

Crutchy: updated slashcode repo link to rehash

This is a home for information about how '''[http://soylentnews.org SoylentNews.org]''' was started, the vision for it, and discussion about it's future.

==About SoylentNews.org==

Welcome to the '''[http://soylentnews.org SoylentNews.org]''' Wiki.

We deliver community-sourced news and discussion. This is an [https://github.com/SoylentNews/slashcode open-source], grassroots effort powered by article submissions from our readers, volunteers, and our forked version of slashcode. We highlight stories on the web which are important to everyone - especially nerds. We also provide a soapbox for discussion moderated by the site's patrons, and allow anonymous discourse as there's no mandatory registration needed to comment.

We are mindful of community sentiment, and will not bend to overreaching corporate agenda. The goal is to be an excellent source for discussion and news about technology, art, science and politics.

We've incorporated as a Delaware Public Benefit Corporation (similar to a non-profit) as we feel our mission to provide a platform for news dissemination and relevant discussion is not only essential for mankind, but also a legal right (i.e. freedom of press, freedom of speech) in some places, and these are liberties which we aim to protect.

Though the site is young and there are [https://github.com/SoylentNews/slashcode/issues bugs], we are improving and adapting to satisfy the community's needs. We look forward to pushing the boundaries of web experience and are committed to involving the community on all major decisions.

==Get Involved==

This project is run entirely by the community and there are many different facets. Here are some of the many ways to participate:

*'''[http://soylentnews.org/submit.pl Submit a Story]'''
** Try joining the #rss-bot channel in [[SoylentNews:IRC|IRC]] for story ideas
*'''Volunteer'''
** Get in touch with the '''[[Development|Development Team]]''', especially if you know perl
** Reach out to one of the other '''[[TeamPages|Teams]]''' (we have openings for many skill sets)
** Contact the relevant person: '''[[WhosWho| Who's Who?]]'''
*Hop in to '''IRC:'''
** #soylent on irc.soylentnews.org/6697
** [http://irc.sylnt.us/?channels=#soylent Webchat]
** [[SoylentNews:IRC|IRC Wiki Page]]
*'''Bugs''' and Features:
** [https://github.com/SoylentNews/slashcode/issues/new Submit a bug or Feature Request]
** [[Suggestions|Add a Suggestion]] - larger projects to tackle for the future
*'''Tell Somebody''' A friend, a colleague, any major news source....
** Do what you can to [[Spreading the word|get the word out]]
** You could participate in [[The_Slashcott|The Slashcott]]

==Contacts==

A list of people working on this project:
===[[WhosWho| Who's Who?]]===

== Useful Links ==

*[[Submission guidelines]] - best practices for story submissions
*[[Story Style]] - a guide for editors on article formatting
*[[Development]] team page
**[https://github.com/SoylentNews/rehash Code Repo] - The Slashcode fork repository for this project on GitHub
** [[DevelopmentVMHowto]] - How to get our code setup in a VM
** [[SlashDocumentationIndex]]
*[[UserExperience]] team page
**[[Style]] - some of this info needs to be merged/moved/organized into/with [[UserExperience]]
**[[CssWork]]
* [[SystemAdministration|System Administration]]
*[[Finances]] - Breakdown of our proposed spending
*[[Licensing]] - ideas about which license to use for our slashcode fork
*[[Staff_Meetings|Staff Meeting Logs]]
*[[SoylentNews_PBC|SoylentNews PBC]]
*[[SoylentNews_Site_Policy|SoylentNews Policy]]

== Similar Projects ==
* [http://pipedot.org/ Pipedot] - A complete re-write that uses a modern codebase and sports a clean look
* Usenet newsgroup comp.misc - [https://groups.google.com/forum/#!forum/comp.misc on Google Groups], [http://squte.com/ on Squte], [news:comp.misc via newsreader application]
* [http://technocrat.net/ Technocrat] - (now defunt) News site presented by Bruce Perens

== Archive ==

[[Archive]] -- An archive of obsolete pages/discussions that occurred before launch

User:Exec

2015-09-27T00:13:17Z

Crutchy:

[[IRC:exec]]

__TOC__

==Development==

[[user:crutchy]]

==Capabilities==
Editing of wiki articles may be performed using the ~wiki alias in IRC (must be authorized).

==Approved tasks==

==How it works==

Exec is a php IRC bot.

==Description of tasks==

.spamctl <title>

from the #wiki channel on irc.sylnt.us will trigger exec to replace all content in the <title> with spam template

==Scripts==

<pre>
~wiki login
~wiki title[|section] (gets [section] content)
~wiki edit title|section|text
~wiki edit title|section| (deletes section)
~wiki logout
</pre>

https://github.com/crutchy-/test/blob/master/scripts/wiki.php

must be authorized to use this script in IRC

==Logs==

http://irciv.us.to/irc_logs/

http://irciv.us.to/exec_logs/20140702.txt

[[Category:IRC]]
[[Category:IRC:exec]]

User:Exec

2015-09-27T00:12:52Z

Crutchy:

[[IRC:exec]]

__TOC__

==Development==

[[user:crutchy]]

==Capabilities==
Editing of wiki articles may be performed using the ~wiki alias in IRC (must be authorized).

==Approved tasks==

==How it works==

Exec is a php IRC bot.

==Description of tasks==

.spamctl <title>

from the #wiki channel on irc.sylnt.us will trigger exec to replace all content in the <title> with {{spam}}

==Scripts==

<pre>
~wiki login
~wiki title[|section] (gets [section] content)
~wiki edit title|section|text
~wiki edit title|section| (deletes section)
~wiki logout
</pre>

https://github.com/crutchy-/test/blob/master/scripts/wiki.php

must be authorized to use this script in IRC

==Logs==

http://irciv.us.to/irc_logs/

http://irciv.us.to/exec_logs/20140702.txt

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec aliases

2015-09-09T10:52:03Z

Crutchy:

[[IRC:exec]]

==~==

==~bot==

==~bucket==

==~buckets-dump==

==~buckets-flush==

==~buckets-list==

==~buckets-load==

==~buckets-save==

==~chart==

==~cid==

==~comments==
https://soylentnews.org/~crutchy/journal/1098

==~count==
~count <nick>

==~cowsay==

==~define==
~define term

==~define-add==
~define-add term, meaning

==~define-count==

==~define-delete==

==~define-list==

==~define-source-edit==

==~define-source-param==

==~define-sources==

==~deop==

==~dest-clear==

==~dest-override==

==~devoice==

==~find-first==
~find-first <text>

==~find-last==
~find-last <text>

==~first==
~first <nick>

==~fortune==

==~g'day==

==~gday==

==~header==
~header <header> <url> 
returns value of header (if found) 
fails silently if error occurs or header not found

==~header-login==

==~help==

==~ignore==

==~invite==

==~ircd==

==~isup==
~isup host[:port] (checks connection, returns http status if found)

==~join==
~join #channel (don't have to be channel op)

==~kick==

==~kill==

==~killall==

==~last==
~last <nick>

==~link==

syntax to search: ~link %search%, set: ~link %id% %content%, delete: ~link %id% -

can't use pipe (|) char, %id% can't contain spaces, but %content% can, %search% is a regexp pattern

will return a list of one or more %id% => %content% if %search% matches either %id% or %content%

==~list==
~list (lists available commands)

==~list-auth==
~list-auth (lists available commands requiring NickServ account authorization)

==~location==
~location code

==~lock==
~lock alias (treats all lines entered as being prefixed with alias, channel-specific)

==~log==

==~moo==

==~op==

==~part==
instruct bot to leave the current channel, or a different channel with optional parameter 
syntax: ~part [channel]

==~php==

==~ps==

==~q==

==~queue==
~queue (returns number of SN submissions in the queue)

==~rainbow==
~rainbow text

==~rehash==

==~remind==

==~restart==

==rofl==

==~say==

==~scramble==

==~sed==
~sed on|off 
[nick[:|,|>|.] ]s/pattern/replace[/[g]] (similar to SedBot)

==~staff==
syntax: ~staff meeting 
displays meeting info from either the site news slashbox or the board meeting wiki page

==~suggest==

==~tests==

==~time==
Syntax: 
~time location 
Related commands: 
~time-add 
~time-del 
~location 
Developer(s): 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php

==~time-add==

==~time-del==

==~title==

==~translate==
~translate tolang text (auto-detects source lang, eg: ~translate en prueba)

==~translate-sl==
~translate-sl fromlang tolang text (eg: ~translate-sl es en prueba)

==~unignore==

==~unlock==
Syntax: 
~unlock 
Related commands: 
~lock 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

==~up==

==~users==

==~voice==

==~weather==
Syntax: 
~weather location 
Examples: 
~weather JFK 
~weather vostok, aq 
Related commands: 
~weather-add 
~time-add 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php

==~weather-add==
Syntax: ~weather-add name location 
Developer(s): crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php 
Related commands: 
~weather 
~time 
~time-add 
~location 
Description: 
Enables storing a short name to refer to a longer location description when using the ~weather or ~time commands. 
If a name already exists, setting it again will overwrite the existing named location. 
Names cannot be deleted at this stage. 
A few thousand ICAO and IATA/FAA airport codes have been imported into the codes file thanks to OpenFlights. 
<crutchy> ~weather-add crutchy melbourne australia 
<exec> code "crutchy" set for location "melbourne australia"

==~weather-del==

==~welcome==

==~wiki==

==~x==

the "~x" alias allows a bot operator to create and manage scripts from within IRC (dubbed "live scripts")

scripts created using this alias are stored in a bucket by the bot instead of a file

the handler uses php's eval to run live scripts

to prevent anyone from executing arbitrary commands on the bot host, a whois command is issued to verify that the NickServ account of the user of the ~x alias is the bot operator (by settling the userlist parameter of the alias definition line to "@")

the general form of the command is:

~x %action% [%param%] [%code%]

in a nutshell the possible actions and params are:
"global on|off" (enables or disables all live scripts)
"kill" (a shorcut for disabling all live scripts)
"enable %script-name%" (enables an individual live script)
"disable %script-name%" (disables an individual live script)
"delete-script %script-name%" (deletes a live script from memory)
"open %script-name%" (opens a live script for editing in the active channel)
"close" (closes the currently open live script in the active channel)
"code" (outputs a line-numbered code listing of the currently open live script in the active channel)
"list" (outputs a listing of available live scripts, and highlights enabled scripts)
"replace [L]%line-number% %old-code%|%new-code%" (replaces a line of code in the currently open live script)
"delete-line [L]%line-number%" (deletes a line of code in the currently open live script)
"insert [L]%line-number% %code%" (inserts a line of code in the currently open live script)
"add %code%" (adds a line of code to the currently open live script)

import and export (from/to file) actions are also proposed but not yet implemented.

live scripts have access to common lib functions used by other scripts, and also have direct access to $nick, $dest (channel), $trailing. the privmsg lib function doesn't work for live scripts as the live script handler is triggered internally by the bot using a registered privmsg event handler, so to privmsg the channel that the sender ($nick) is in you simply call pm($dest,"message) instead.

when a new live script is created, it must be enabled before it will run, but once enabled any changes will come into affect immediately.

whilst the code is currently limited to php, it could potentially be adapted to execute code in other languages using their command-line interpreters. it also doesn't have to be limited to code. it could potentially be used to collaborate on lines of non-executing text (such as for collaborative editing of SN submissions). with some tweaks it could be possible to collaborate on code as well, with other users being able to add/edit/delete lines but requiring the operator to re-enable the script for changes to come into effect.

==.macro==

syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>

syntax to delete: .macro <trigger> -

<chanlist> is comma-separated or * for any

Used to set a PRIVMSG or INTERNAL macro.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130

==.relays==
Outputs a list of freenode channel relays currently active.
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec aliases

2015-09-09T08:47:52Z

Crutchy: /* .macro */

[[IRC:exec]]

==~==

==~bot==

==~bucket==

==~buckets-dump==

==~buckets-flush==

==~buckets-list==

==~buckets-load==

==~buckets-save==

==~chart==

==~cid==

==~comments==
https://soylentnews.org/~crutchy/journal/1098

==~count==
~count <nick>

==~cowsay==

==~define==
~define term

==~define-add==
~define-add term, meaning

==~define-count==

==~define-delete==

==~define-list==

==~define-source-edit==

==~define-source-param==

==~define-sources==

==~deop==

==~dest-clear==

==~dest-override==

==~devoice==

==~find-first==
~find-first <text>

==~find-last==
~find-last <text>

==~first==
~first <nick>

==~fortune==

==~g'day==

==~gday==

==~header==
~header <header> <url> 
returns value of header (if found) 
fails silently if error occurs or header not found

==~header-login==

==~help==

==~ignore==

==~invite==

==~ircd==

==~isup==
~isup host[:port] (checks connection, returns http status if found)

==~join==
~join #channel (don't have to be channel op)

==~kick==

==~kill==

==~killall==

==~last==
~last <nick>

==~list==
~list (lists available commands)

==~list-auth==
~list-auth (lists available commands requiring NickServ account authorization)

==~location==
~location code

==~lock==
~lock alias (treats all lines entered as being prefixed with alias, channel-specific)

==~log==

==~moo==

==~op==

==~part==
instruct bot to leave the current channel, or a different channel with optional parameter 
syntax: ~part [channel]

==~php==

==~ps==

==~q==

==~queue==
~queue (returns number of SN submissions in the queue)

==~rainbow==
~rainbow text

==~rehash==

==~remind==

==~restart==

==rofl==

==~say==

==~scramble==

==~sed==
~sed on|off 
[nick[:|,|>|.] ]s/pattern/replace[/[g]] (similar to SedBot)

==~staff==
syntax: ~staff meeting 
displays meeting info from either the site news slashbox or the board meeting wiki page

==~suggest==

==~tests==

==~time==
Syntax: 
~time location 
Related commands: 
~time-add 
~time-del 
~location 
Developer(s): 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php

==~time-add==

==~time-del==

==~title==

==~translate==
~translate tolang text (auto-detects source lang, eg: ~translate en prueba)

==~translate-sl==
~translate-sl fromlang tolang text (eg: ~translate-sl es en prueba)

==~unignore==

==~unlock==
Syntax: 
~unlock 
Related commands: 
~lock 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

==~up==

==~users==

==~voice==

==~weather==
Syntax: 
~weather location 
Examples: 
~weather JFK 
~weather vostok, aq 
Related commands: 
~weather-add 
~time-add 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php

==~weather-add==
Syntax: ~weather-add name location 
Developer(s): crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php 
Related commands: 
~weather 
~time 
~time-add 
~location 
Description: 
Enables storing a short name to refer to a longer location description when using the ~weather or ~time commands. 
If a name already exists, setting it again will overwrite the existing named location. 
Names cannot be deleted at this stage. 
A few thousand ICAO and IATA/FAA airport codes have been imported into the codes file thanks to OpenFlights. 
<crutchy> ~weather-add crutchy melbourne australia 
<exec> code "crutchy" set for location "melbourne australia"

==~weather-del==

==~welcome==

==~wiki==

==~x==

the "~x" alias allows a bot operator to create and manage scripts from within IRC (dubbed "live scripts")

scripts created using this alias are stored in a bucket by the bot instead of a file

the handler uses php's eval to run live scripts

to prevent anyone from executing arbitrary commands on the bot host, a whois command is issued to verify that the NickServ account of the user of the ~x alias is the bot operator (by settling the userlist parameter of the alias definition line to "@")

the general form of the command is:

~x %action% [%param%] [%code%]

in a nutshell the possible actions and params are:
"global on|off" (enables or disables all live scripts)
"kill" (a shorcut for disabling all live scripts)
"enable %script-name%" (enables an individual live script)
"disable %script-name%" (disables an individual live script)
"delete-script %script-name%" (deletes a live script from memory)
"open %script-name%" (opens a live script for editing in the active channel)
"close" (closes the currently open live script in the active channel)
"code" (outputs a line-numbered code listing of the currently open live script in the active channel)
"list" (outputs a listing of available live scripts, and highlights enabled scripts)
"replace [L]%line-number% %old-code%|%new-code%" (replaces a line of code in the currently open live script)
"delete-line [L]%line-number%" (deletes a line of code in the currently open live script)
"insert [L]%line-number% %code%" (inserts a line of code in the currently open live script)
"add %code%" (adds a line of code to the currently open live script)

import and export (from/to file) actions are also proposed but not yet implemented.

live scripts have access to common lib functions used by other scripts, and also have direct access to $nick, $dest (channel), $trailing. the privmsg lib function doesn't work for live scripts as the live script handler is triggered internally by the bot using a registered privmsg event handler, so to privmsg the channel that the sender ($nick) is in you simply call pm($dest,"message) instead.

when a new live script is created, it must be enabled before it will run, but once enabled any changes will come into affect immediately.

whilst the code is currently limited to php, it could potentially be adapted to execute code in other languages using their command-line interpreters. it also doesn't have to be limited to code. it could potentially be used to collaborate on lines of non-executing text (such as for collaborative editing of SN submissions). with some tweaks it could be possible to collaborate on code as well, with other users being able to add/edit/delete lines but requiring the operator to re-enable the script for changes to come into effect.

==.macro==

syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>

syntax to delete: .macro <trigger> -

<chanlist> is comma-separated or * for any

Used to set a PRIVMSG or INTERNAL macro.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130

==.relays==
Outputs a list of freenode channel relays currently active.
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec aliases

2015-09-09T08:47:36Z

Crutchy: /* .macro */

[[IRC:exec]]

==~==

==~bot==

==~bucket==

==~buckets-dump==

==~buckets-flush==

==~buckets-list==

==~buckets-load==

==~buckets-save==

==~chart==

==~cid==

==~comments==
https://soylentnews.org/~crutchy/journal/1098

==~count==
~count <nick>

==~cowsay==

==~define==
~define term

==~define-add==
~define-add term, meaning

==~define-count==

==~define-delete==

==~define-list==

==~define-source-edit==

==~define-source-param==

==~define-sources==

==~deop==

==~dest-clear==

==~dest-override==

==~devoice==

==~find-first==
~find-first <text>

==~find-last==
~find-last <text>

==~first==
~first <nick>

==~fortune==

==~g'day==

==~gday==

==~header==
~header <header> <url> 
returns value of header (if found) 
fails silently if error occurs or header not found

==~header-login==

==~help==

==~ignore==

==~invite==

==~ircd==

==~isup==
~isup host[:port] (checks connection, returns http status if found)

==~join==
~join #channel (don't have to be channel op)

==~kick==

==~kill==

==~killall==

==~last==
~last <nick>

==~list==
~list (lists available commands)

==~list-auth==
~list-auth (lists available commands requiring NickServ account authorization)

==~location==
~location code

==~lock==
~lock alias (treats all lines entered as being prefixed with alias, channel-specific)

==~log==

==~moo==

==~op==

==~part==
instruct bot to leave the current channel, or a different channel with optional parameter 
syntax: ~part [channel]

==~php==

==~ps==

==~q==

==~queue==
~queue (returns number of SN submissions in the queue)

==~rainbow==
~rainbow text

==~rehash==

==~remind==

==~restart==

==rofl==

==~say==

==~scramble==

==~sed==
~sed on|off 
[nick[:|,|>|.] ]s/pattern/replace[/[g]] (similar to SedBot)

==~staff==
syntax: ~staff meeting 
displays meeting info from either the site news slashbox or the board meeting wiki page

==~suggest==

==~tests==

==~time==
Syntax: 
~time location 
Related commands: 
~time-add 
~time-del 
~location 
Developer(s): 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/time_lib.php

==~time-add==

==~time-del==

==~title==

==~translate==
~translate tolang text (auto-detects source lang, eg: ~translate en prueba)

==~translate-sl==
~translate-sl fromlang tolang text (eg: ~translate-sl es en prueba)

==~unignore==

==~unlock==
Syntax: 
~unlock 
Related commands: 
~lock 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

==~up==

==~users==

==~voice==

==~weather==
Syntax: 
~weather location 
Examples: 
~weather JFK 
~weather vostok, aq 
Related commands: 
~weather-add 
~time-add 
Developers: 
crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php

==~weather-add==
Syntax: ~weather-add name location 
Developer(s): crutchy 
Sources: 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather.php 
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/weather_lib.php 
Related commands: 
~weather 
~time 
~time-add 
~location 
Description: 
Enables storing a short name to refer to a longer location description when using the ~weather or ~time commands. 
If a name already exists, setting it again will overwrite the existing named location. 
Names cannot be deleted at this stage. 
A few thousand ICAO and IATA/FAA airport codes have been imported into the codes file thanks to OpenFlights. 
<crutchy> ~weather-add crutchy melbourne australia 
<exec> code "crutchy" set for location "melbourne australia"

==~weather-del==

==~welcome==

==~wiki==

==~x==

the "~x" alias allows a bot operator to create and manage scripts from within IRC (dubbed "live scripts")

scripts created using this alias are stored in a bucket by the bot instead of a file

the handler uses php's eval to run live scripts

to prevent anyone from executing arbitrary commands on the bot host, a whois command is issued to verify that the NickServ account of the user of the ~x alias is the bot operator (by settling the userlist parameter of the alias definition line to "@")

the general form of the command is:

~x %action% [%param%] [%code%]

in a nutshell the possible actions and params are:
"global on|off" (enables or disables all live scripts)
"kill" (a shorcut for disabling all live scripts)
"enable %script-name%" (enables an individual live script)
"disable %script-name%" (disables an individual live script)
"delete-script %script-name%" (deletes a live script from memory)
"open %script-name%" (opens a live script for editing in the active channel)
"close" (closes the currently open live script in the active channel)
"code" (outputs a line-numbered code listing of the currently open live script in the active channel)
"list" (outputs a listing of available live scripts, and highlights enabled scripts)
"replace [L]%line-number% %old-code%|%new-code%" (replaces a line of code in the currently open live script)
"delete-line [L]%line-number%" (deletes a line of code in the currently open live script)
"insert [L]%line-number% %code%" (inserts a line of code in the currently open live script)
"add %code%" (adds a line of code to the currently open live script)

import and export (from/to file) actions are also proposed but not yet implemented.

live scripts have access to common lib functions used by other scripts, and also have direct access to $nick, $dest (channel), $trailing. the privmsg lib function doesn't work for live scripts as the live script handler is triggered internally by the bot using a registered privmsg event handler, so to privmsg the channel that the sender ($nick) is in you simply call pm($dest,"message) instead.

when a new live script is created, it must be enabled before it will run, but once enabled any changes will come into affect immediately.

whilst the code is currently limited to php, it could potentially be adapted to execute code in other languages using their command-line interpreters. it also doesn't have to be limited to code. it could potentially be used to collaborate on lines of non-executing text (such as for collaborative editing of SN submissions). with some tweaks it could be possible to collaborate on code as well, with other users being able to add/edit/delete lines but requiring the operator to re-enable the script for changes to come into effect.

==.macro==

syntax to add: .macro <trigger> <chanlist> PRIVMSG|INTERNAL <command_template>
syntax to delete: .macro <trigger> -
<chanlist> is comma-separated or * for any

Used to set a PRIVMSG or INTERNAL macro.
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/cmd.php#L130

==.relays==
Outputs a list of freenode channel relays currently active.
https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/activity.php#L111

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-09-05T11:02:00Z

Crutchy: /* Buckets */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

Once you have your settings sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

===Accessing process templates===

Process templates that are normally accessed using command-line arguments can also be accessed like ordinary buckets, using the index prefix "process_template_" followed by the name of the template.
For example, getting a bucket with index "process_template_nick" will return the nick of the caller.

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-09-04T17:44:40Z

Crutchy: /* Available exec templates */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

Once you have your settings sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)
*%%server%% = the irc server host (such as "irc.sylnt.us")

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

[[Category:IRC]]
[[Category:IRC:exec]]

IRCiv

2015-08-24T12:23:54Z

Crutchy: /* Commands */

'''IRCiv''' is a little Civilization-like strategy game under development.

It's run as a script by the exec IRC bot, which usually lurks in the #civ channel on the irc.sylnt.us server. Anyone welcome to come check out progress or have a tinker. Must be registered and identified with NickServ to be an IRCiv player.
[[File:irciv.png|100px|IRCiv logo|right]]

[[IRC]] | [[IRC:exec]]

[[File:irciv_map.png|600px|sample IRCiv map]] [[http://irciv.bot.nu/?pid=3]]

==Starting a new game==
* ensure game bot is in proposed game channel with /invite or ~join
* gm issues "~civ register-channel" command to generate map for channel
* each player in channel that wishes to join game issues "~civ init" command

==Commands==

IRCiv commands must start with the [[IRC:exec|exec]] alias "~civ" unless an alias lock is set.

===Quick start guide===

<pre>
help or ?
</pre>

===game-list===

===player-list===

===status===
Outputs a status message to either PM (default) or the game channel if "public_status" flag is set.

<pre>
<crutchy> ~civ status
<exec> #civ crutchy => http://irciv.bot.nu/?pid=1
<exec> #civ crutchy => 1/2, warrior, +100, (45,41)
</pre>

During testing exec auto sets the public_status flag for every player.

Adding a space-delimited x y coordinate after the status command will return the status of that coordinate.

<pre>
<crutchy> ~civ status 45 42
<exec> status for coordinate 45,42: occupied by crutchy
<exec> city: fart
<exec> units: 0
</pre>

===flag===

syntax: [~civ] flag name

flags recognised:

- public_status

outputs player active unit status to game channel instead of private message (ignored during development)

- grid

paints gridlines on map images

- coords

paints terrain grid coordinates on map images

- city_names

paints city names under cities using player color on map images

- logging

logs status messages to a file in the irciv data directory

- irc_messages

enables/disables status message output to irc

example:
<pre>
~civ flag public_status
</pre>

===unflag===
syntax: [~civ] unflag name

===set===
syntax: [~civ] set key=value

===unset===
syntax: [~civ] unset key

===Active unit movement===

<pre>
up or u
down or d
left or l
right or r
</pre>

after movement command, status is automatically shown

if unit successfully moves, the active unit will be cycled to the next available unit

units can't move off map or off landmasses

if "public_status" flag isn't set, it's probably easier to enter movement commands in the exec PM window, though they will still be recognised in the game channel; you will just have to change to PM window to see status

===Building a city===

<pre>
build or b
</pre>

only settlers can build cities

===Administration commands===

- dev-op

test command for development

- register-channel

- save-data

- load-data

- init-ai

- test-ai

- player-unset

- player-data

- move-unit

- object-edit

- player-edit

==Website==

A simple website @ http://irciv.bot.nu/ has been set up to access map images output by the IRC script.

A demo can be accessed here: http://irciv.bot.nu/?pid=1

==Development==

Developer(s): [[User:Crutchy|crutchy]]

===Development journal entries===

http://soylentnews.org/~crutchy/journal/901

http://soylentnews.org/~crutchy/journal/441

http://soylentnews.org/~crutchy/journal/419

http://soylentnews.org/~crutchy/journal/397

http://soylentnews.org/~crutchy/journal/393

http://soylentnews.org/~crutchy/journal/386

http://soylentnews.org/~crutchy/journal/381

http://soylentnews.org/~crutchy/journal/379

http://soylentnews.org/~crutchy/journal/367

http://soylentnews.org/~crutchy/journal/357

http://soylentnews.org/~crutchy/journal/355

http://soylentnews.org/~crutchy/journal/352

==TO DO LIST==
# unit attacking
# city capturing
# city build queue
# diplomacy
# finances
# tech advancement
# new units

== Development notes ==

Have a "set color = R,G,B" setting, and publicly announce if a player changes color.

Paint health bars above unit shields like civ2.

Create attack_strength and defense_strength unit properties (for air,sea and land).

If a unit moves into same coord as foreign unit and attack_strength > 0, initiate attack.

Alliance settings? (use account name instead of nick)

Don't allow player to move any unit with attack_strength of zero onto same coord as foreign unit/city.

Attacking: for both units, health (0-100) = health - rand(attack/2,attack) + rand(defense/2,defense)
The defense rand must be no greater than the attack rand.
Modify attack/defense with terrain bonuses (as applicable).

Map image filenames to be stored in bucket for each game/player (separate from player data bucket as doesn't need to be loaded each execute). Bucket index: "irciv_webmaps_%%game_id%%_%%player_id%%"

Improve map output
- include flags for various features: units, cities, fog, etc

Goto command, using migrated delphi pathfinding algorithm.

Territory: fixed radius around cities and coords occupied for certain time.

Player negotiation/interaction/diplomacy.

Tech advancement

Finance/tax

More units/city improvements

Documentation

===Website===

Limit map file uploads to IP address (security by obscurity).

Floating absolute positioned box in top left corner with mouse click data (scrollable?).
Highlighted map tile selection image (floating, absolute).
Use js (refer to old civ code) to show coordinates on mousemove, and tile info on mouseclick.
Put logo in floating div in top left corner (above data div).
No margins/padding around map image.

===TODO: Delphi IRCiv client===

Develop a client using Delphi that downloads map, communicates with exec using GUI controls and allows player to chat with other players (include IRC client features).
Make a web server query (to be polled by delphi client) that returns the name of the latest map file, which contains a timestamp so that the client can determine if a new map needs to be downloaded. This is to account for actions by other players.
When the local player takes an action, download a new map.

===Exec notes===

Conf file for each script (optional) contains key=value for lib.php function that sets constants for scripts.

Add a socket interface for buckets.

[[Category:IRC]]
[[Category:IRC:exec]]

IRCiv

2015-08-24T12:22:43Z

Crutchy: /* Administration commands */

'''IRCiv''' is a little Civilization-like strategy game under development.

It's run as a script by the exec IRC bot, which usually lurks in the #civ channel on the irc.sylnt.us server. Anyone welcome to come check out progress or have a tinker. Must be registered and identified with NickServ to be an IRCiv player.
[[File:irciv.png|100px|IRCiv logo|right]]

[[IRC]] | [[IRC:exec]]

[[File:irciv_map.png|600px|sample IRCiv map]] [[http://irciv.bot.nu/?pid=3]]

==Starting a new game==
* ensure game bot is in proposed game channel with /invite or ~join
* gm issues "~civ register-channel" command to generate map for channel
* each player in channel that wishes to join game issues "~civ init" command

==Commands==

IRCiv commands must start with the [[IRC:exec|exec]] alias "~civ" unless an alias lock is set.

===Quick start guide===

<pre>
help or ?
</pre>

===status===
Outputs a status message to either PM (default) or the game channel if "public_status" flag is set.

<pre>
<crutchy> ~civ status
<exec> #civ crutchy => http://irciv.bot.nu/?pid=1
<exec> #civ crutchy => 1/2, warrior, +100, (45,41)
</pre>

During testing exec auto sets the public_status flag for every player.

Adding a space-delimited x y coordinate after the status command will return the status of that coordinate.

<pre>
<crutchy> ~civ status 45 42
<exec> status for coordinate 45,42: occupied by crutchy
<exec> city: fart
<exec> units: 0
</pre>

===flag===

syntax: [~civ] flag name

flags recognised:

- public_status

outputs player active unit status to game channel instead of private message (ignored during development)

- grid

paints gridlines on map images

- coords

paints terrain grid coordinates on map images

- city_names

paints city names under cities using player color on map images

- logging

logs status messages to a file in the irciv data directory

- irc_messages

enables/disables status message output to irc

example:
<pre>
~civ flag public_status
</pre>

===unflag===
syntax: [~civ] unflag name

===set===
syntax: [~civ] set key=value

===unset===
syntax: [~civ] unset key

===Active unit movement===

<pre>
up or u
down or d
left or l
right or r
</pre>

after movement command, status is automatically shown

if unit successfully moves, the active unit will be cycled to the next available unit

units can't move off map or off landmasses

if "public_status" flag isn't set, it's probably easier to enter movement commands in the exec PM window, though they will still be recognised in the game channel; you will just have to change to PM window to see status

===Building a city===

<pre>
build or b
</pre>

only settlers can build cities

===Administration commands===

- dev-op

test command for development

- register-channel

- save-data

- load-data

- init-ai

- test-ai

- player-unset

- player-data

- move-unit

- object-edit

- player-edit

==Website==

A simple website @ http://irciv.bot.nu/ has been set up to access map images output by the IRC script.

A demo can be accessed here: http://irciv.bot.nu/?pid=1

==Development==

Developer(s): [[User:Crutchy|crutchy]]

===Development journal entries===

http://soylentnews.org/~crutchy/journal/901

http://soylentnews.org/~crutchy/journal/441

http://soylentnews.org/~crutchy/journal/419

http://soylentnews.org/~crutchy/journal/397

http://soylentnews.org/~crutchy/journal/393

http://soylentnews.org/~crutchy/journal/386

http://soylentnews.org/~crutchy/journal/381

http://soylentnews.org/~crutchy/journal/379

http://soylentnews.org/~crutchy/journal/367

http://soylentnews.org/~crutchy/journal/357

http://soylentnews.org/~crutchy/journal/355

http://soylentnews.org/~crutchy/journal/352

==TO DO LIST==
# unit attacking
# city capturing
# city build queue
# diplomacy
# finances
# tech advancement
# new units

== Development notes ==

Have a "set color = R,G,B" setting, and publicly announce if a player changes color.

Paint health bars above unit shields like civ2.

Create attack_strength and defense_strength unit properties (for air,sea and land).

If a unit moves into same coord as foreign unit and attack_strength > 0, initiate attack.

Alliance settings? (use account name instead of nick)

Don't allow player to move any unit with attack_strength of zero onto same coord as foreign unit/city.

Attacking: for both units, health (0-100) = health - rand(attack/2,attack) + rand(defense/2,defense)
The defense rand must be no greater than the attack rand.
Modify attack/defense with terrain bonuses (as applicable).

Map image filenames to be stored in bucket for each game/player (separate from player data bucket as doesn't need to be loaded each execute). Bucket index: "irciv_webmaps_%%game_id%%_%%player_id%%"

Improve map output
- include flags for various features: units, cities, fog, etc

Goto command, using migrated delphi pathfinding algorithm.

Territory: fixed radius around cities and coords occupied for certain time.

Player negotiation/interaction/diplomacy.

Tech advancement

Finance/tax

More units/city improvements

Documentation

===Website===

Limit map file uploads to IP address (security by obscurity).

Floating absolute positioned box in top left corner with mouse click data (scrollable?).
Highlighted map tile selection image (floating, absolute).
Use js (refer to old civ code) to show coordinates on mousemove, and tile info on mouseclick.
Put logo in floating div in top left corner (above data div).
No margins/padding around map image.

===TODO: Delphi IRCiv client===

Develop a client using Delphi that downloads map, communicates with exec using GUI controls and allows player to chat with other players (include IRC client features).
Make a web server query (to be polled by delphi client) that returns the name of the latest map file, which contains a timestamp so that the client can determine if a new map needs to be downloaded. This is to account for actions by other players.
When the local player takes an action, download a new map.

===Exec notes===

Conf file for each script (optional) contains key=value for lib.php function that sets constants for scripts.

Add a socket interface for buckets.

[[Category:IRC]]
[[Category:IRC:exec]]

IRCiv

2015-08-24T12:22:20Z

Crutchy: /* Administration commands */

'''IRCiv''' is a little Civilization-like strategy game under development.

It's run as a script by the exec IRC bot, which usually lurks in the #civ channel on the irc.sylnt.us server. Anyone welcome to come check out progress or have a tinker. Must be registered and identified with NickServ to be an IRCiv player.
[[File:irciv.png|100px|IRCiv logo|right]]

[[IRC]] | [[IRC:exec]]

[[File:irciv_map.png|600px|sample IRCiv map]] [[http://irciv.bot.nu/?pid=3]]

==Starting a new game==
* ensure game bot is in proposed game channel with /invite or ~join
* gm issues "~civ register-channel" command to generate map for channel
* each player in channel that wishes to join game issues "~civ init" command

==Commands==

IRCiv commands must start with the [[IRC:exec|exec]] alias "~civ" unless an alias lock is set.

===Quick start guide===

<pre>
help or ?
</pre>

===status===
Outputs a status message to either PM (default) or the game channel if "public_status" flag is set.

<pre>
<crutchy> ~civ status
<exec> #civ crutchy => http://irciv.bot.nu/?pid=1
<exec> #civ crutchy => 1/2, warrior, +100, (45,41)
</pre>

During testing exec auto sets the public_status flag for every player.

Adding a space-delimited x y coordinate after the status command will return the status of that coordinate.

<pre>
<crutchy> ~civ status 45 42
<exec> status for coordinate 45,42: occupied by crutchy
<exec> city: fart
<exec> units: 0
</pre>

===flag===

syntax: [~civ] flag name

flags recognised:

- public_status

outputs player active unit status to game channel instead of private message (ignored during development)

- grid

paints gridlines on map images

- coords

paints terrain grid coordinates on map images

- city_names

paints city names under cities using player color on map images

- logging

logs status messages to a file in the irciv data directory

- irc_messages

enables/disables status message output to irc

example:
<pre>
~civ flag public_status
</pre>

===unflag===
syntax: [~civ] unflag name

===set===
syntax: [~civ] set key=value

===unset===
syntax: [~civ] unset key

===Active unit movement===

<pre>
up or u
down or d
left or l
right or r
</pre>

after movement command, status is automatically shown

if unit successfully moves, the active unit will be cycled to the next available unit

units can't move off map or off landmasses

if "public_status" flag isn't set, it's probably easier to enter movement commands in the exec PM window, though they will still be recognised in the game channel; you will just have to change to PM window to see status

===Building a city===

<pre>
build or b
</pre>

only settlers can build cities

===Administration commands===

- dev-op

test command for development

- register-channel

- save-data
- load-data

- init-ai
- test-ai

- player-unset
- player-data
- move-unit
- object-edit
- player-edit

==Website==

A simple website @ http://irciv.bot.nu/ has been set up to access map images output by the IRC script.

A demo can be accessed here: http://irciv.bot.nu/?pid=1

==Development==

Developer(s): [[User:Crutchy|crutchy]]

===Development journal entries===

http://soylentnews.org/~crutchy/journal/901

http://soylentnews.org/~crutchy/journal/441

http://soylentnews.org/~crutchy/journal/419

http://soylentnews.org/~crutchy/journal/397

http://soylentnews.org/~crutchy/journal/393

http://soylentnews.org/~crutchy/journal/386

http://soylentnews.org/~crutchy/journal/381

http://soylentnews.org/~crutchy/journal/379

http://soylentnews.org/~crutchy/journal/367

http://soylentnews.org/~crutchy/journal/357

http://soylentnews.org/~crutchy/journal/355

http://soylentnews.org/~crutchy/journal/352

==TO DO LIST==
# unit attacking
# city capturing
# city build queue
# diplomacy
# finances
# tech advancement
# new units

== Development notes ==

Have a "set color = R,G,B" setting, and publicly announce if a player changes color.

Paint health bars above unit shields like civ2.

Create attack_strength and defense_strength unit properties (for air,sea and land).

If a unit moves into same coord as foreign unit and attack_strength > 0, initiate attack.

Alliance settings? (use account name instead of nick)

Don't allow player to move any unit with attack_strength of zero onto same coord as foreign unit/city.

Attacking: for both units, health (0-100) = health - rand(attack/2,attack) + rand(defense/2,defense)
The defense rand must be no greater than the attack rand.
Modify attack/defense with terrain bonuses (as applicable).

Map image filenames to be stored in bucket for each game/player (separate from player data bucket as doesn't need to be loaded each execute). Bucket index: "irciv_webmaps_%%game_id%%_%%player_id%%"

Improve map output
- include flags for various features: units, cities, fog, etc

Goto command, using migrated delphi pathfinding algorithm.

Territory: fixed radius around cities and coords occupied for certain time.

Player negotiation/interaction/diplomacy.

Tech advancement

Finance/tax

More units/city improvements

Documentation

===Website===

Limit map file uploads to IP address (security by obscurity).

Floating absolute positioned box in top left corner with mouse click data (scrollable?).
Highlighted map tile selection image (floating, absolute).
Use js (refer to old civ code) to show coordinates on mousemove, and tile info on mouseclick.
Put logo in floating div in top left corner (above data div).
No margins/padding around map image.

===TODO: Delphi IRCiv client===

Develop a client using Delphi that downloads map, communicates with exec using GUI controls and allows player to chat with other players (include IRC client features).
Make a web server query (to be polled by delphi client) that returns the name of the latest map file, which contains a timestamp so that the client can determine if a new map needs to be downloaded. This is to account for actions by other players.
When the local player takes an action, download a new map.

===Exec notes===

Conf file for each script (optional) contains key=value for lib.php function that sets constants for scripts.

Add a socket interface for buckets.

[[Category:IRC]]
[[Category:IRC:exec]]

IRCiv

2015-08-24T12:17:26Z

Crutchy: added logging and irc_messages flags

'''IRCiv''' is a little Civilization-like strategy game under development.

It's run as a script by the exec IRC bot, which usually lurks in the #civ channel on the irc.sylnt.us server. Anyone welcome to come check out progress or have a tinker. Must be registered and identified with NickServ to be an IRCiv player.
[[File:irciv.png|100px|IRCiv logo|right]]

[[IRC]] | [[IRC:exec]]

[[File:irciv_map.png|600px|sample IRCiv map]] [[http://irciv.bot.nu/?pid=3]]

==Starting a new game==
* ensure game bot is in proposed game channel with /invite or ~join
* gm issues "~civ register-channel" command to generate map for channel
* each player in channel that wishes to join game issues "~civ init" command

==Commands==

IRCiv commands must start with the [[IRC:exec|exec]] alias "~civ" unless an alias lock is set.

===Quick start guide===

<pre>
help or ?
</pre>

===status===
Outputs a status message to either PM (default) or the game channel if "public_status" flag is set.

<pre>
<crutchy> ~civ status
<exec> #civ crutchy => http://irciv.bot.nu/?pid=1
<exec> #civ crutchy => 1/2, warrior, +100, (45,41)
</pre>

During testing exec auto sets the public_status flag for every player.

Adding a space-delimited x y coordinate after the status command will return the status of that coordinate.

<pre>
<crutchy> ~civ status 45 42
<exec> status for coordinate 45,42: occupied by crutchy
<exec> city: fart
<exec> units: 0
</pre>

===flag===

syntax: [~civ] flag name

flags recognised:

- public_status

outputs player active unit status to game channel instead of private message (ignored during development)

- grid

paints gridlines on map images

- coords

paints terrain grid coordinates on map images

- city_names

paints city names under cities using player color on map images

- logging

logs status messages to a file in the irciv data directory

- irc_messages

enables/disables status message output to irc

example:
<pre>
~civ flag public_status
</pre>

===unflag===
syntax: [~civ] unflag name

===set===
syntax: [~civ] set key=value

===unset===
syntax: [~civ] unset key

===Active unit movement===

<pre>
up or u
down or d
left or l
right or r
</pre>

after movement command, status is automatically shown

if unit successfully moves, the active unit will be cycled to the next available unit

units can't move off map or off landmasses

if "public_status" flag isn't set, it's probably easier to enter movement commands in the exec PM window, though they will still be recognised in the game channel; you will just have to change to PM window to see status

===Building a city===

<pre>
build or b
</pre>

only settlers can build cities

===Administration commands===

Under development.

==Website==

A simple website @ http://irciv.bot.nu/ has been set up to access map images output by the IRC script.

A demo can be accessed here: http://irciv.bot.nu/?pid=1

==Development==

Developer(s): [[User:Crutchy|crutchy]]

===Development journal entries===

http://soylentnews.org/~crutchy/journal/901

http://soylentnews.org/~crutchy/journal/441

http://soylentnews.org/~crutchy/journal/419

http://soylentnews.org/~crutchy/journal/397

http://soylentnews.org/~crutchy/journal/393

http://soylentnews.org/~crutchy/journal/386

http://soylentnews.org/~crutchy/journal/381

http://soylentnews.org/~crutchy/journal/379

http://soylentnews.org/~crutchy/journal/367

http://soylentnews.org/~crutchy/journal/357

http://soylentnews.org/~crutchy/journal/355

http://soylentnews.org/~crutchy/journal/352

==TO DO LIST==
# unit attacking
# city capturing
# city build queue
# diplomacy
# finances
# tech advancement
# new units

== Development notes ==

Have a "set color = R,G,B" setting, and publicly announce if a player changes color.

Paint health bars above unit shields like civ2.

Create attack_strength and defense_strength unit properties (for air,sea and land).

If a unit moves into same coord as foreign unit and attack_strength > 0, initiate attack.

Alliance settings? (use account name instead of nick)

Don't allow player to move any unit with attack_strength of zero onto same coord as foreign unit/city.

Attacking: for both units, health (0-100) = health - rand(attack/2,attack) + rand(defense/2,defense)
The defense rand must be no greater than the attack rand.
Modify attack/defense with terrain bonuses (as applicable).

Map image filenames to be stored in bucket for each game/player (separate from player data bucket as doesn't need to be loaded each execute). Bucket index: "irciv_webmaps_%%game_id%%_%%player_id%%"

Improve map output
- include flags for various features: units, cities, fog, etc

Goto command, using migrated delphi pathfinding algorithm.

Territory: fixed radius around cities and coords occupied for certain time.

Player negotiation/interaction/diplomacy.

Tech advancement

Finance/tax

More units/city improvements

Documentation

===Website===

Limit map file uploads to IP address (security by obscurity).

Floating absolute positioned box in top left corner with mouse click data (scrollable?).
Highlighted map tile selection image (floating, absolute).
Use js (refer to old civ code) to show coordinates on mousemove, and tile info on mouseclick.
Put logo in floating div in top left corner (above data div).
No margins/padding around map image.

===TODO: Delphi IRCiv client===

Develop a client using Delphi that downloads map, communicates with exec using GUI controls and allows player to chat with other players (include IRC client features).
Make a web server query (to be polled by delphi client) that returns the name of the latest map file, which contains a timestamp so that the client can determine if a new map needs to be downloaded. This is to account for actions by other players.
When the local player takes an action, download a new map.

===Exec notes===

Conf file for each script (optional) contains key=value for lib.php function that sets constants for scripts.

Add a socket interface for buckets.

[[Category:IRC]]
[[Category:IRC:exec]]

IRCiv

2015-08-18T10:18:13Z

Crutchy: changed dns

'''IRCiv''' is a little Civilization-like strategy game under development.

It's run as a script by the exec IRC bot, which usually lurks in the #civ channel on the irc.sylnt.us server. Anyone welcome to come check out progress or have a tinker. Must be registered and identified with NickServ to be an IRCiv player.
[[File:irciv.png|100px|IRCiv logo|right]]

[[IRC]] | [[IRC:exec]]

[[File:irciv_map.png|600px|sample IRCiv map]] [[http://irciv.bot.nu/?pid=3]]

==Starting a new game==
* ensure game bot is in proposed game channel with /invite or ~join
* gm issues "~civ register-channel" command to generate map for channel
* each player in channel that wishes to join game issues "~civ init" command

==Commands==

IRCiv commands must start with the [[IRC:exec|exec]] alias "~civ" unless an alias lock is set.

===Quick start guide===

<pre>
help or ?
</pre>

===status===
Outputs a status message to either PM (default) or the game channel if "public_status" flag is set.

<pre>
<crutchy> ~civ status
<exec> #civ crutchy => http://irciv.bot.nu/?pid=1
<exec> #civ crutchy => 1/2, warrior, +100, (45,41)
</pre>

During testing exec auto sets the public_status flag for every player.

Adding a space-delimited x y coordinate after the status command will return the status of that coordinate.

<pre>
<crutchy> ~civ status 45 42
<exec> status for coordinate 45,42: occupied by crutchy
<exec> city: fart
<exec> units: 0
</pre>

===flag===

syntax: [~civ] flag name

flags recognised:

- public_status

outputs player active unit status to game channel instead of private message (ignored during development)

- grid

paints gridlines on map images

- coords

paints terrain grid coordinates on map images

- city_names

paints city names under cities using player color on map images

example:
<pre>
~civ flag public_status
</pre>

===unflag===
syntax: [~civ] unflag name

===set===
syntax: [~civ] set key=value

===unset===
syntax: [~civ] unset key

===Active unit movement===

<pre>
up or u
down or d
left or l
right or r
</pre>

after movement command, status is automatically shown

if unit successfully moves, the active unit will be cycled to the next available unit

units can't move off map or off landmasses

if "public_status" flag isn't set, it's probably easier to enter movement commands in the exec PM window, though they will still be recognised in the game channel; you will just have to change to PM window to see status

===Building a city===

<pre>
build or b
</pre>

only settlers can build cities

===Administration commands===

Under development.

==Website==

A simple website @ http://irciv.bot.nu/ has been set up to access map images output by the IRC script.

A demo can be accessed here: http://irciv.bot.nu/?pid=1

==Development==

Developer(s): [[User:Crutchy|crutchy]]

===Development journal entries===

http://soylentnews.org/~crutchy/journal/901

http://soylentnews.org/~crutchy/journal/441

http://soylentnews.org/~crutchy/journal/419

http://soylentnews.org/~crutchy/journal/397

http://soylentnews.org/~crutchy/journal/393

http://soylentnews.org/~crutchy/journal/386

http://soylentnews.org/~crutchy/journal/381

http://soylentnews.org/~crutchy/journal/379

http://soylentnews.org/~crutchy/journal/367

http://soylentnews.org/~crutchy/journal/357

http://soylentnews.org/~crutchy/journal/355

http://soylentnews.org/~crutchy/journal/352

==TO DO LIST==
# unit attacking
# city capturing
# city build queue
# diplomacy
# finances
# tech advancement
# new units

== Development notes ==

Have a "set color = R,G,B" setting, and publicly announce if a player changes color.

Paint health bars above unit shields like civ2.

Create attack_strength and defense_strength unit properties (for air,sea and land).

If a unit moves into same coord as foreign unit and attack_strength > 0, initiate attack.

Alliance settings? (use account name instead of nick)

Don't allow player to move any unit with attack_strength of zero onto same coord as foreign unit/city.

Attacking: for both units, health (0-100) = health - rand(attack/2,attack) + rand(defense/2,defense)
The defense rand must be no greater than the attack rand.
Modify attack/defense with terrain bonuses (as applicable).

Map image filenames to be stored in bucket for each game/player (separate from player data bucket as doesn't need to be loaded each execute). Bucket index: "irciv_webmaps_%%game_id%%_%%player_id%%"

Improve map output
- include flags for various features: units, cities, fog, etc

Goto command, using migrated delphi pathfinding algorithm.

Territory: fixed radius around cities and coords occupied for certain time.

Player negotiation/interaction/diplomacy.

Tech advancement

Finance/tax

More units/city improvements

Documentation

===Website===

Limit map file uploads to IP address (security by obscurity).

Floating absolute positioned box in top left corner with mouse click data (scrollable?).
Highlighted map tile selection image (floating, absolute).
Use js (refer to old civ code) to show coordinates on mousemove, and tile info on mouseclick.
Put logo in floating div in top left corner (above data div).
No margins/padding around map image.

===TODO: Delphi IRCiv client===

Develop a client using Delphi that downloads map, communicates with exec using GUI controls and allows player to chat with other players (include IRC client features).
Make a web server query (to be polled by delphi client) that returns the name of the latest map file, which contains a timestamp so that the client can determine if a new map needs to be downloaded. This is to account for actions by other players.
When the local player takes an action, download a new map.

===Exec notes===

Conf file for each script (optional) contains key=value for lib.php function that sets constants for scripts.

Add a socket interface for buckets.

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-06-25T22:03:20Z

Crutchy: /* Quick start */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

Once you have your settings sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~title]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

[[Category:IRC]]
[[Category:IRC:exec]]

IRC:exec

2015-06-25T22:02:53Z

Crutchy: /* Quick start */

"'''[[User:exec|exec]]'''" is a bot that runs in a CLI that connects to the Soylent [[SoylentNews:IRC|IRC server]] (irc.sylnt.us) and executes other programs and facilitates their interaction with IRC.

[[File:exec.png|right]]

http://sylnt.us/exec

[[IRC:exec_aliases|IRC:exec aliases]] | [[IRC]] | [[IRCiv]] | [[Suggestions]] | [[Test page]] | [[IRC:exec_suggestions|IRC:exec suggestions]] | [[ApiDocs|SlashCode API]] 
http://soylentnews.org/~crutchy/journal/

==Installing and running your own 'exec' bot==

Register a nick with NickServ on the IRC server. In these instructions, %nick% is a placeholder for your bot's actual nick. Other placeholders should hopefully be self-explanatory. If you have any issues, hop onto irc.sylnt.us and ping 'crutchy'.

<pre>
$ mkdir %nick%
$ cd %nick%
$ mkdir data
$ mkdir log
$ mkdir pwd
$ cd pwd
$ echo "%bot_nickserv_password%" > %nick%
$ cd ..
$ git clone https://github.com/crutchy-/exec-irc-bot.git
$ cd exec-irc-bot
</pre>

You can edit default settings in irc.php, or create a settings file containing similar to the following:
<pre>
NICK=%nick%
USER_NAME=%nick%
FULL_NAME=%nick%.bot
PASSWORD_FILE=../pwd/%nick%
BUCKETS_FILE=../data/buckets
IGNORE_FILE=../data/ignore
EXEC_FILE=exec.txt
INIT_CHAN_LIST=#
EXEC_LOG_PATH=../log
IRC_LOG_URL=
IRC_HOST_CONNECT=irc.sylnt.us
IRC_HOST=irc.sylnt.us
IRC_PORT=6667
MEMORY_LIMIT=128M
OPERATOR_ACCOUNT=%your_personal_nickserv_account_name%
DEBUG_CHAN=#debug
NICKSERV_IDENTIFY_PROMPT=You have 60 seconds to identify to your nickname before it is changed.
ADMIN_ACCOUNTS=
</pre>
You can store this file anywhere, but its recommended that it be stored in the same directory as irc.php. In this example the config filename is 'sylnt'.

Once you have your settings sorted out, run:
<pre>php irc.php sylnt</pre>

==Quick start==

These commands can be triggered by anyone in a channel with the bot.

* /invite exec (must be channel op) 
* [[IRC:exec_aliases#.7Ejoin|~join]] #channel (don't have to be channel op) 

* [[IRC:exec_aliases#.7Epart|~part]] (bot leaves channel) 
* [[IRC:exec_aliases#.7Elist|~list]] (lists available commands) 
* [[IRC:exec_aliases#.7Elist-auth|~list-auth]] (lists available commands requiring NickServ account authorization) 
 
* [[IRC:exec_aliases#.7Edefine|~define]] term 
* [[IRC:exec_aliases#.7Edefine-add|~define-add]] term, meaning 
* [[IRC:exec_aliases#.7Edefine-delete|~define-delete]] 
 
* [[IRC:exec_aliases#.7Eisup|~isup]] host[:port] (checks connection, returns http status if found) 
* [[IRC:exec_aliases#.7Etranslate|~translate]] tolang text (auto-detects source lang, eg: ~translate en prueba) 
* [[IRC:exec_aliases#.7Etranslate-sl|~translate-sl]] fromlang tolang text (eg: ~translate-sl es en prueba) 
* [[IRC:exec_aliases#.7Equeue|~queue]] (returns number of SN submissions in the queue) 
* [[IRC:exec_aliases#.7Elock|~lock]] alias (treats all lines entered as being prefixed with alias, channel-specific) 
* [[IRC:exec_aliases#.7Eunlock|~unlock]] 
 
* [[IRC:exec_aliases#.7Ecount|~count]] <nick> 
* [[IRC:exec_aliases#.7Efirst|~first]] <nick> 
* [[IRC:exec_aliases#.7Elast|~last]] <nick> 
* [[IRC:exec_aliases#.7Efind-first|~find-first]] <text> 
* [[IRC:exec_aliases#.7Efind-last|~find-last]] <text> 
 
* [[IRC:exec_aliases#.7Etitle|~count]] on|off|<url> 

==Commands requiring NickServ account authorization==

A whois command is issued to verify the account name of a user identified with NickServ for authentication purposes.

===Commands that anyone identified with NickServ can use===

* ~suggest <text> 
* ~suggest-api <text> 
* ~suggest-exec <text>

===Commands limited to specific NickServ accounts===

* ~wiki login 
* ~wiki title[|section] (gets [section] content) 
* ~wiki edit title|section|text 
* ~wiki edit title|section| (deletes section) 
* ~wiki logout 
 
* ~say text (say as exec with no amendments) 
 
* ~bucket <index> 
* ~bucket <index> <data> 
* ~bucket <index> unset 

==Administration commands==

These internal bot commands are restricted to accounts in a hardcoded admin account list.

* ~q (bot quits, all child processes including SedBot2 are terminated) 
* ~restart (bot process restarts, all child processes including SedBot2 are terminated) 
* ~rehash (reloads exec configuration file) 
 
* ~ps (list process id and command for all currently running child processes) 
* ~kill <pid> (kills child process) 
* ~killall 
 
* ~dest-override 
* ~dest-clear 
 
* ~buckets-dump (var_dumps bucket data to terminal) 
* ~buckets-save (saves bucket data to file) 
* ~buckets-load (loads bucket data from file) 
* ~buckets-flush (clears all bucket data) 
* ~buckets-list (lists bucket indexes in terminal) 

* ~ignore 
* ~unignore

==Operator commands==

The operator's NickServ account is hardcoded.
Operator-only aliases are designated with @ in the exec line account list.

* ~exec-add 
* ~exec-del 
* ~exec-save 
* ~startup 
* [[IRC:exec_aliases#.7Ex|~x]] (live scripting)

==Bot development==

Developer(s): [[User:Crutchy|crutchy]]

Source: https://github.com/crutchy-/exec-irc-bot

Bot source files:
* https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc.php 
* https://github.com/crutchy-/exec-irc-bot/blob/master/irc_lib.php

Download above files, open a terminal and change to that directory, and run "php irc.php" to start the bot. 
There are also a few constants at the top of irc.php that you'll need to change before starting: 
* NICK 
* PASSWORD_FILE 
* BUCKETS_FILE 
* IGNORE_FILE 
* EXEC_FILE 
* INIT_CHAN_LIST 
* EXEC_LOG_PATH 
* IRC_LOG_URL 
* IRC_HOST_CONNECT 
* IRC_HOST 
* IRC_PORT 
* MEMORY_LIMIT 
* OPERATOR_ACCOUNT 
* DEBUG_CHAN

Scripts may be stored anywhere that is accessible to the bot script for CLI execution. If stored in a different location, the script path must be included in the exec file line.

Input to a script/program is via command line arguments only. Communication with a program through stdin is supported, but only using a similar syntax to IRC messages and currently stdin is used only to respond to bucket get messages (php scripts can use the lib.php get_bucket function).

stdout of an executed script/program may be passed to an IRC channel or output to exec's stdout (terminal), depending on the value of ''auto-privmsg'' in the exec line. If ''auto-privmsg=0'', stdout from the script/program must begin with ''IRC_MSG '' or ''IRC_RAW '' for it to be sent to IRC.
If ''auto-privmsg=1'', all stdout from the script/program is assumed to be prefixed with ''IRC_MSG '' and is sent to IRC; this is generally required for programs that can't be easily edited, such as shell binaries (''cowsay'', ''fortune'', etc).

Programs executed may be anything accessible from the CLI of the machine running the exec script. They may be shell programs (such as ''cowsay'' and ''fortune''), php scripts (executed using the CLI ''php'' command) or scripts in any other language executable by their respective CLI interpreters (python, perl, haskell, etc).

==Buckets==

"Buckets" are a feature of exec that allow scripts to store data in a common location which is accessible from any script and is retained/persistent between script executions. Each bucket consists of an array element in the main bot program that is read, written and cleared using IRC-like commands (see below) passed through stdout/stdin pipes from/to executed scripts - buckets are filled by pipes hahaha :-P

Complex data in array form may be stored using php's serialize/unserialize (or equivalent in other languages).

Buckets are referenced by an index string. Index strings cannot contain spaces.
<source lang="dot">
:exec BUCKET_GET :index
:exec BUCKET_SET :index data
:exec BUCKET_UNSET :index
</source>

For PHP scripts, there are basic get_bucket, set_bucket and unset_bucket functions available, along with get_array_bucket, append_array_bucket, set_array_bucket, and bucket_list functions, which can be found here: https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/lib_buckets.php

==exec.txt==

The '''exec.txt''' file resides in the same directory as the bot script (irc.php) file and links aliases (triggers typed in IRC) to scripts to be executed, and contains usage parameters and restrictions.

https://github.com/crutchy-/exec-irc-bot/blob/master/exec.txt

===Syntax===

<source lang="dot">alias|timeout|repeat|auto-privmsg|empty-trailing-allowed|account-list|cmd-list|dest-list|reserved|shell-cmd</source>

===Parameters===

'''alias''' is the trigger typed in IRC at the start of a message that will trigger a script to be executed.
* All aliases should start with a common trigger character (such as ~) but can be any lowercase string without spaces.
* Aliases must be unique, but multiple scripts may be executed per alias by separating shell commands with '''&&'''.
* The aliases '''*''', '''<init>''', '''<startup>''', '''<quit>''' and '''<log>''' are reserved and have special meanings to the bot.
* The '''*''' reserved alias occurs on every IRC message received. The '''exec''' bot in Soylent IRC uses a single script for this alias. '''cmd.php''' is executed on every line and contains a switch statement to dispatch internal trigger messages on various IRC events (such as numerics, PRIVMSG, NOTICE, JOIN, PART, NICK, etc). The bot then parses these internal messages to further trigger other scripts.
* The '''<<init>>''' reserved alias is triggered on bot startup before the IRC connection is made. It is useful for initializing data buckets for particular scripts. Buckets and internal trigger messages may be called at this point, but IRC functionality is not yet available.
* The '''<<startup>>''' reserved alias is triggered immediately after the bot sends an identify message to NickServ, but is not yet identified. It is useful for running scripts that require an IRC connection.
* The '''<<quit>>''' reserved alias is triggered on bot shutdown and restart. IRC functionality is still available to this alias script. It is useful for saving data buckets to file so that data can persist when the bot is restarted.
* The '''<<log>>''' reserved alias is triggered on every IRC message received (similar to *) but is executed immediately after the message is received (before other script triggers are processed) so is more stable for logging purposes due to a lower probability of messages being out of order.

A non-zero '''timeout''' is the number of seconds a script is allowed to run for before being terminated by the bot.
* If a script times out a message is sent to the destination from which the alias was triggered to inform the user.
* It is always a good idea to set a timeout to prevent infinite loops in scripts from chewing up bot host resources.
* A timeout of 5 seconds is typical except for http-enabled scripts which sometimes require more time to complete.

A non-zero '''repeat''' is the number of seconds between each automated alias trigger.
* Aliases with repeats may still be triggered manually.
* The first trigger will occur after the repeat has elapsed on startup (repeat triggers don't trigger immediately on startup).

'''auto-privmsg''' may be 0 or 1.
* A value of 1 will automatically privmsg every line of text output to a script's stdout or stderr so must be used with caution.
* This is useful for running programs that aren't scripted, such as compiled binaries that can't be changed (apt-get, fortune, etc).
* A value of 0 won't privmsg stdout/stderr and is required if a script needs to triggger other commands, send customized messages to IRC or use buckets.

'''empty-trailing-allowed''' may be 0 or 1.
* A value of 1 will allow an alias to trigger if there is no text following the alias.
* A value of 0 will require more text after the alias.
* If an alias requires more text and a user enters only the alias itself with no other text, a privmsg is sent to inform the user.
* If there is a chance that an alias may be entered without further text without intending to trigger the bot, this should be set to 0 and if need be handled silently within the triggered script.

'''account-list''' is a comma-delimited list of NickServ account names permitted to trigger the alias.
* If a user attempts to trigger an account-restricted alias and their account isn't listed or they aren't identified with NickServ, a message is output to the terminal but not to IRC.
* An empty list is unrestricted.
* A value of "*" will allow any NickServ-registered user to trigger alias.

'''cmd-list''' is a comma-delimited list of commands that the alias may be triggered on, including IRC commands (PRIVMSG, NOTICE, NICK, etc) but also internal and bucket commands intercepted by the bot (INTERNAL, BUCKET_GET, etc).
* Attempts to trigger a cmd-restricted alias on an unspecified cmd fail silently.
* An empty list is unrestricted.

'''dest-list''' is a comma-delimited list of destinations that the alias may be triggered from, including channel names and nicks.
* Attempts to trigger a dest-restricted alias from an unspecified destination fail silently.
* An empty list is unrestricted.

'''reserved''' is an unused parameter reserved for future use, and may be 0 or 1.

'''shell-cmd''' is the cli command executed in a separate process by the bot when the assocated alias is triggered and all requirements are met.

===Notes===

* %%trailing%% excludes alias
* aliases here must be all lower case letters
* cmd list and dest list is not case sensitive, but conventionally use uppercase for cmd
* account, cmd and dest lists are all comma-separated
* set cmd list to PRIVMSG to enable alias to only be called by PRIVMSG cmd (NOTICE etc won't trigger)
* set dest list to #soylent to restrict triggering of alias to the #soylent channel (can also use a nick to restrict to PM)

===Available exec templates===

*%%trailing%% = the message string visible in an IRC client
*%%dest%% = the channel/pm nick where the message originated
*%%nick%% = the nickname of the sender
*%%start%% = microtime(True) result when bot was started
*%%alias%% = the command alias that triggered the script
*%%cmd%% = the IRC command (PRIVMSG,NOTICE,QUIT,PART,NICK,JOIN,numeric,etc)
*%%data%% = the entire IRC line (refer below)
*%%exec%% = the exec line for the trigger alias
*%%params%% = the params part of the IRC line (refer below; usually same as %%dest%% except when %%cmd%% is a numeric)

IRC line syntax: 
<source lang="dot">:<prefix> <command> <params> :<trailing></source>

==Script development==

===PHP script template===

https://github.com/crutchy-/test/blob/master/script_template.php

If anyone is interested in adding their own script, talk to crutchy (usually hangs out in #soylent and #test) who will be happy to help as best he can.

===Internal commands===

===IRC commands===

IRC commands maybe manually constructed by echoing a string to stdout using the ":<prefix> <command> <params> :<trailing>" syntax, but there is also a selection of shortcuts available to make scripting easier. The following commands may be called using a "/command <trailing>" syntax.

==Usage in IRC==

To invoke a script in IRC client:
<source lang="dot">alias [trailing]</source>
Example:
<source lang="dot">
<crutchy> ~define atlantic ocean
<exec> 1 | noun | the 2nd largest ocean; separates North and South America on the west from Europe and Africa on the east\n2 | adjective | relating to or bordering the Atlantic Ocean
</source>
In the above example, "~define" is the alias, "atlantic ocean" is passed to the script as %%trailing%% and can be accessed in PHP scripts using the $argv global array variable.

[[Feeds]]
[[Feed sources]]

==IRCiv==

See [[IRCiv]].

==IRC voting system==

http://sylnt.us/vote

===Objectives===
* simple to use
* simple to access
* simple to get help
* secure as practicable
* difficult to vote more than once
* secret ballot

===Features/usage/limitations===
* user can get help on voting using ~vote, ~vote help or ~vote ?
* user must be identified with NickServ to use voting system
* user can get list of available polls using ~vote list|l
* user can register a new poll using ~vote <poll_id> register [<description>] - description is optional and may contain spaces
* <poll_id> can only contain alphanumeric characters or _-.
* poll founder can unregister a poll using ~vote <poll_id> unregister (this will delete all data for <poll_id>)
* poll founder is automatically added to list of admins for poll
* poll founder can add a poll admin using ~vote <poll_id> add-admin <admin_nickserv_account>
* poll founder can delete a poll admin using ~vote <poll_id> del-admin <admin_nickserv_account>
* poll can be opened for voting by poll admin using ~vote <poll_id> open
* poll can be closed for voting by poll admin using ~vote <poll_id> close
* poll admin can add a poll option using ~vote <poll_id> add-option <poll_option> [<description>] - description is optional and may contain spaces
* poll admin can delete a poll option using ~vote <poll_id> del-option <poll_option>
* user votes using ~vote <poll_id> <poll_option>
* user votes secretly using /msg exec ~vote <poll_id> <poll_option>
* user may vote any number of times, but only one vote is registered per NickServ account (to prevent ballot stuffing)
* poll admin can output a breakdown of votes with ~vote <poll_id> breakdown
* anyone identified with NickServ can output the current poll result using ~vote <poll_id>

==Meeting assistant==

This feature is currently under development.

https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/meeting.php

Proof-of-concept script for development of a tool to assist Soylent PBC Board Meeting conduct, and also possibly to assist team meetings.

Intended to automate minute-taking and posting of minutes on the wiki.
Meeting minutes will be posted automatically on the wiki on meeting close, with formatted sections for:
* basic details such as start time, finish time, chair(s), etc
* attendees with any notes regarding voiced/non-voiced nicks, speakers, authorized voters, admins, and anyone that joined/left partway through the meeting, etc
* formatted IRC script
* table of motions with vote counts, carried status, oppositions, who raised and who seconded etc
* other data may be added as the feature is evolved

<pre>
~meeting open
~meeting close
~meeting chair <nick>
~meeting motion <description>
aye|nay
</pre>

There can only be one meeting per channel.
Any number of meetings (in different channels) can occcur simultaneously.

The bot stores a list of meeting data bucket indexes in the <<MEETING_LIST>> bucket.

Meeting data buckets have indexes named <<MEETING_DATA $dest>> where $dest is the channel name.

Meeting data buckets are arrays, each containing the following elements:

<pre>
channel = name of channel where meeting is being conducted
chairs = array containing chair data
finish = meeting close timestamp
messages = array of privmsg data
events = array of event data (quits/joins/kicks/nicks/etc)
initial nicks = list of nicks at meeting open
initial nicks complete = boolean
final nicks = list of nicks at meeting close
final nicks complete = boolean
quorum = boolean
</pre>

Each chair data element contains an array with the following elements. A new chair array is added whenever the chair position is handed over.
<pre>
nick = NickServ account name of chair
start = timestamp that chair commenced
</pre>

==execfs==

Currently under development.

Source code available here:
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs.php
* https://github.com/crutchy-/exec-irc-bot/blob/master/scripts/execfs_lib.php

Ideas for future development:
* make an import/export command to bring in data subtrees in text line format with tab prefixes for levels
* flexible permissions system that allows/denies based on alias, nick, account, alias permissions, creator, etc
* permissions system should have easy way to jail a script from being able to access any bucket/directory except down from a certain path
* develop feature to synchronize data between instances of exec that are authorized

==Soylent IRCd==

Currently under development. Source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/ircd.php

Will be very simple. Likely won't implement all ircd functionality, but may implement some non-standard Soylent-specific features.

==Remote listener==

A basic remote listener has been developed, with source code available here: https://github.com/crutchy-/exec-irc-bot/blob/master/website/listen.php

Ideas for future development:
* provide easy access to buckets from scripts running outside of exec (such as apache php scripts that serve web content)
* provide api from remote sources (on a designated port) to control the bot similarly as from irc
* provide interface by which remote scripts (such as apache web scripts) can interact with scripts run by exec

==Distributed web service==

This is just a pipe dream at the moment, with some ideas jotted down for future development.

* templating system based on execfs. html is built from separate hierarchical data structures containing templates and content
* templates and content are maintained from IRC, though would be nice to develop clients and web interfaces for viewing and editing
* content and templates stored in separate execfs directories
* template directory to be protected using permissions
* any client can edit content (if permitted)
* develop a script to generate html from template and content execfs directories, or use an apache php script to construct web content on the fly

[[Category:IRC]]
[[Category:IRC:exec]]

ZNC

2015-06-23T06:08:15Z

Crutchy: Undo revision 9062 by Exec (talk)

SoylentNews runs its own IRC bouncer (ZNC) for staff use.

== What is an IRC bouncer? ==
An IRC bouncer is benign. It acts as your proxy to IRC servers of your choice, a concierge if you will. While you are away, the bouncer stays connected to all your IRC networks and channels as your representative then (optionally) tells you everything that went on while you were away.
Rather than your connection to an IRC server being client >> IRC server(s) it becomes client >> Bouncer >> IRC server(s). The nice thing is the bouncer never sleeps so Bouncer >> IRC server(s) is always maintained, the client can come and go at will. When you reconnect your IRC client to the Bouncer you can (optionally) get scrollback for all the channels you were in prior to your client disconnection.

== What is ZNC? ==
ZNC is a popular IRC bouncer. See [http://wiki.znc.in/ZNC ZNC] Along with [http://www.psybnc.at/ psyBNC] these two are the most commonly used IRC Bouncers. psyBNC seems unmaintained right now unfortunately.

== Setting up ZNC - for Staff ==
Assumptions at this point are that you have a SoylentNews IRC nick, have it registered with nickserv, have an irc client (rather than using the web interface) and are SN staff.. so let's get on with the nuts and bolts... 
* An IRC Admin will notify you of your ZNC username and initial password.
* Go to [https://irc.soylentnews.org:60000/ SN ZNC Web Interface] with a web browser and login with your shiny new ZNC credentials.
* Go to Your Settings in the right hand menu and change your password in the subsequent screen by populating the Password and Confirm password fields, scroll all the way down and hit Save.
* Probably want to go ahead and Logout & log back in with your new password at this point.

* Return to Your Settings and populate the IRC Information section (same kind of info you'd use in an IRC client).
* Scroll down to the Modules section - as a minimum you probably want chansaver and ctcpflood checked, you may want to check some of the others n.b. the name of each module is clickable to bring up a ZNC wiki page on what they each do.
* Further down the page still, in Flags - you probably want to check Prepend Timestamps - this prepends played back messages with their time/date on client reconnection after a time away.
* Nearly done - ZNC Behaviour section - probably want to set a Timezone there so replayed messages carry your localised time rather than UTC. You can also have some fun with CTCP replies. e.g.
<nowiki>CLIENTINFO No
FINGER Kinky
PING No
TIME No
USERINFO No
VERSION No
</nowiki>
* Finally... hit Save :)


THIS ARTICLE NEEDS A LOT OF WORK STILL! :D