Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Fetching latest commit…
Cannot retrieve the latest commit at this time.
|Failed to load latest commit information.|
Botcoin README INTRO ----- This is an IRC bot in PHP that pulls down and organizes various Bitcoin related market data. It also allows setting of triggers / alerts for price points. I plan on adding a bunch of functionality in the comming weeks, so stay tuned. INSTALLATION ------------- 1) Rename config-fillmein.ini to config.ini 2) Edit config.ini and set your options. port = 6667 # an interger port host = irc.whatever.net # a qualified hostname channel = somechannel # channel, no # prefix required key = OPTIONAL # channel (+k) optional name = myName # the name of the bot (whois) nick = My-NickyNick # the nick (shown in channel, /msg, etc) owner = "email@example.com" # the owner. Make sure you get this correct. # should be in the format "firstname.lastname@example.org" triggerUpdateFreq = 30 # How often to check the triggers programmatically. tickerUpdateFreq = 30 # How often to update ticker data (Can't be > MtGox limit). 3) Make bootstrap file executable: shell> chmod +x run.php 4) Run the bot shell> ./run.php >> /dev/null 5) Enjoy! COMMANDS -------- Supported public commands: * Supported public commands: * !help Display the help menu. * !currency Display weighted currency values. * !ticker Display ticker values (high, low, bid, ask, etc). * !trading Displays detailed trading data for today. (MtGox & TradeHill) * !set Set a watch for a high or low price. * !check Inspect each 'set' price and see if it should be triggered. * !clear Removes all 'set's. * !show Display (to nick) the value of the high/low lists. Supported private commands: * Supported private commands: * !join Join the pre-set channel. * !shutdown Quit IRC / leave the server. * !part Leave the channel, stay connected to server. SUPPORT ------- If you enjoy this bot, please donate: 1K2JWmpd75ehXxco1SWtGLaceQsRytpyEv or donate code/features/bug fixes. CHANGE LOG ---------- 0.1: Created. 0.2: Minor fixes / refactoring. Added !check, !clear and !show. 0.3: Added TradeHill trades data. 0.4: Improved bitcoin / currency precision. Cleaned up command output.