Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skateman/hwping

IRC bot for HW pinging with the Dream Cheeky Thunder missile launcher
https://github.com/skateman/hwping

bot irc irc-bot rocketlauncher ruby

Last synced: about 2 months ago
JSON representation

IRC bot for HW pinging with the Dream Cheeky Thunder missile launcher

Host: GitHub
URL: https://github.com/skateman/hwping
Owner: skateman
License: gpl-2.0
Created: 2015-03-19T10:14:35.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2017-04-08T09:14:07.000Z (almost 8 years ago)
Last Synced: 2024-03-29T04:23:18.070Z (10 months ago)
Topics: bot, irc, irc-bot, rocketlauncher, ruby
Language: Ruby
Homepage:
Size: 45.9 KB
Stars: 1
Watchers: 4
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# hwping

[![Gem Version](https://badge.fury.io/rb/hwping.svg)](http://badge.fury.io/rb/hwping)
[![Dependency Status](https://gemnasium.com/skateman/hwping.svg)](https://gemnasium.com/skateman/hwping)
[![Build Status](https://travis-ci.org/skateman/hwping.svg)](https://travis-ci.org/skateman/hwping)
[![Inline docs](http://inch-ci.org/github/skateman/hwping.svg?branch=master)](http://inch-ci.org/github/skateman/hwping)

IRC bot for HW pinging with the Dream Cheeky Thunder missile launcher.

## Installation
The bot was tested on **ruby 2.0.0-p643**, but it should work with other versions. It uses `libusb` for the USB communication and `cinch` as the IRC client.
```bash
gem install hwping
```

## Usage
```bash
hwping [options]
```

### Configuration
The bot uses `./config.yml` as a configuration file, which is automatically saved upon exit. An alternative configuration file can be specified with the `-c/--config-file` argument.

The default settings are those:

```yaml
---
nick: hwping
server: irc.freenode.net
port: 6667
channels: # an array of channels to listen without the beginning # symbol
- hwping-test
auth_nicks: # an array of nicks to obey
targets: # a hash in {nick => [x, y]} format specifying the possible targets
webcam:
path: /tmp # the folder where the image will be saved
```

### Channel message commands:
- `hwping ` - fire a rocket at <nick> when he has been set as a target and is present in the channel's user list

### Private message commands:
- `help` - displays a help text
- `snap` - creates a snapshot with the attached webcamera and returns with its URL
- `panorama` - creates a panorama with the attached webcamera and returns with its URL
- `fire` - fires a rocket
- `reset` - resets the launcher into the default position (bottom-left)
- `position` - returns the actual position of the rocket launcher
- ` ` - rotates the launcher into the given direction (up, down, left, right) for the given milliseconds
- `target list` - displays the list of the available targets
- `target get ` - displays the coordinates of <nick>
- `target del ` - deletes the coordinates of <nick>
- `target set ` - sets the coordinates of <nick> to the actual position
- `target set ` - sets the coordinates of <nick> to right(X), up(Y)

## TODO
- Listen to a nick other than `hwping`
- High-precision timer for better positioning
- Event-based solution instead of threads
- Add a superuser to modify the list of authorized users during runtime

## License
This project is released under the GPLv2 license.

## Credits
The launcher code in `lib/hwping/launcher.rb` was inspired by [robhurring/thunder](https://github.com/robhurring/thunder).