https://github.com/zerowidth/camper_van

A Campfire to IRC bridge
https://github.com/zerowidth/camper_van

Last synced: 8 months ago
JSON representation

A Campfire to IRC bridge

• Host: GitHub
• URL: https://github.com/zerowidth/camper_van
• Owner: zerowidth
• License: mit
• Created: 2011-06-05T15:34:31.000Z (about 15 years ago)
• Default Branch: master
• Last Pushed: 2014-08-12T20:59:53.000Z (almost 12 years ago)
• Last Synced: 2025-03-30T13:09:51.766Z (about 1 year ago)
• Language: Ruby
• Homepage:
• Size: 904 KB
• Stars: 129
• Watchers: 9
• Forks: 25
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/zerowidth/camper_van.svg?branch=master)](https://travis-ci.org/zerowidth/camper_van)

[![Coverage Status](https://img.shields.io/coveralls/zerowidth/camper_van.svg)](https://coveralls.io/r/zerowidth/camper_van?branch=master)

# CamperVan, a Campfire to IRC bridge

## Features

CamperVan, as far as your IRC client is concerned, is just another ircd.

Campfire rooms and users are mapped as IRC channels and nicks. Campfire

messages, even custom ones such as tweets and sounds, are translated

for an IRC client to understand.

## Mappings

Wherever possible, Campfire messages and IRC commands are translated

bidirectionally. Some of the mappings are:

    IRC                         Campfire

    ---                         --------

    #day_job                    "Day Job" room

    joe_bob (nick)              Joe Bob (user)

    @admin_user (nick)          An admin user

    "joe_bob: hello" (message)  "Joe Bob: hello" (message)

    https://tweet_url           Tweet message

    /me waves                   *waves*

    /LIST                       List rooms

    /JOIN #day_job              Join the "Day Job" room

    /PART #day_job              Leave the "Day Job" room

    /WHO #day_job               List users in "Day Job"

    /MODE +i #day_job           Lock room

    /MODE -i #day_job           Unlock room

    /TOPIC #day_job new topic   Change room's topic to "new topic"

## Usage

### Installation

    gem install camper_van

### Command-line Options

    camper_van --help

### Running CamperVan

    camper_van

From your IRC client, set up a connection to `localhost:6667`. To authenticate

with Campfire, you must configure your connection's password (the IRC PASS

command) to be:

    campfire_subdomain:api_key

Connect, and `/LIST` will show you the IRC channels / campfire rooms you

have access to. To connect to more than one subdomain, make a separate

connection for each.

Your campfire subdomain should be just the subdomain part. If your campfire url

is `mycompany.campfirenow.com`, the subdomain would be `mycompany`.

CamperVan supports multiple simultaneous connections. Simply open a new

connection and use `other_subdomain:other_api_key` for authentication.

If your IRC client (mIRC) doesn't allow `:` in the password, you can use `-`.

## Development

CamperVan uses:

* ruby 1.9.3 + minitest

* [bundler](http://gembundler.com/)

* [eventmachine](http://rubyeventmachine.com/)

* [firering](https://github.com/EmmanuelOga/firering)

* [logging](https://github.com/TwP/logging)

* [trollop](http://trollop.rubyforge.org/)

## License

MIT, See LICENSE for details.

## Contributing

Fork, patch, test, pull request.