Project

tinyirc

0.0
No commit activity in last 3 years
No release in over 3 years
tinyirchandicraftsman/tinyircHomepageDocumentationSource CodeBug TrackerWiki
A modular IRC bot framework
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
4,940
Stars
0
Forks
0
Watchers
1
 Releases
Current version
0.1.2
Total releases
3
First release
2018-04-03
Latest release
2018-09-08
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2018-08-09
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.16
rake
~> 12.3

Runtime

particlecmd
~> 0.1
particlelog
~> 0.1
sinatra
~> 2.0
sqlite3
~> 1.3
thin
~> 1.7
 Project Readme

Tinyirc

Installation

Add this line to your application's Gemfile:

gem 'particlecmd'

And then execute:

$ bundle

Or install it yourself as:

$ gem install particlecmd

Usage

Sample config file:

plugins:
  path/to/plugin: # The same path as in the `require` function
    # This table can be empty if you want to load the plugin without configuring it
    # Plugins may require some values from this table though
    # You can always load plugins from installed gems (if you are using bundler)
    foo: bar

groups:
  world: # All users belong to this group
    include: # Includes permissions from listed groups into the current one
      - plugin/world
    perms:
      - core/flushq
  admin: # Admins have this group
    include:
      - world
      - plugin/admin
  owner: # Owners have this group
    include:
      - admin
      - plugin/owner

cooldowns:
  plugin: 30 # Sets cooldown for plugin/*/* commands to 30 seconds
  plugin/command: 20 # Sets cooldown for plugin/command/* commands to 20 seconds
  plugin/command/branch: 10 # Sets cooldown for plugin/command/branch command to 10 seconds

servers:
  freenode:
    host: irc.freenode.net
    port: 6667

    nick: YourNicknameHere
    user: YourUsernameHere
    pass: YourPasswordHere
    rnam: YourRealnameHere

    prefix: '@'

    autojoin:
      - '#botters-test'

To start the bot, simply execute:

$ bundler exec tinyirc -c /path/to/config.yaml -d /path/to/db.db # both options are optional

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/handicraftsman/tinyirc.

License

The gem is available as open source under the terms of the MIT License.