Skip to content
This repository was archived by the owner on Feb 21, 2018. It is now read-only.

Commit 290bff5

Browse files
XeXe
committed
Update documentation for release
1 parent 069e4dd commit 290bff5

File tree

4 files changed

+60
-81
lines changed

4 files changed

+60
-81
lines changed

‎README.markdown‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
Cod
22
===
33

4-
Extended IRC services in Python
4+
Extended IRC services in Python
55

6-
[![Bitdeli Badge](https://d2weczhvl823v0.buttfront.net/lyska/cod/trend.png)](https://bitdeli.com/free
7-
"Bitdeli Badge") [![Ohloh
8-
badge](https://www.ohloh.net/p/cod-services/widgets/project_thin_badge.gif)](https://www.ohloh.net/p/cod-services
9-
"Ohlon Badge")
6+
Version 0.1
7+
8+
[![Bitdeli Badge](https://d2weczhvl823v0.buttfront.net/lyska/cod/trend.png)](https://bitdeli.com/free "Bitdeli Badge") [![Ohloh badge](https://www.ohloh.net/p/cod-services/widgets/project_thin_badge.gif)](https://www.ohloh.net/p/cod-services "Ohloh Badge")
109

1110
Installation directions are in `doc/INSTALL.markdown`. Directions for setting
1211
up Atheme integration are in `doc/funserv.markdown`. If you have any questions,
@@ -27,7 +26,6 @@ please ask in `#cod` on `irc.yolo-swag.com`.
2726
- Charybdis 3.4.2 +
2827
- Elemental-IRCd 6.5 +
2928
- InspIRCd 2.0.x
30-
- PleXus 3 +
3129
- Tethys 0.1 +
3230
- Virtual environment support
3331

‎doc/Configuration.markdown‎

Lines changed: 41 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -66,34 +66,6 @@ syntax `level::name` expands to:
6666
}
6767
```
6868

69-
## `bot`
70-
71-
| Name | Command | Oper-only? | Description |
72-
|:---- |:------- |:---------- |:----------- |
73-
| `bf` | `BF` | No | A simple brainfuck interepreter for one-line experimentation. |
74-
| `btc` | `BTC` | No | Grabs the latest prices from MTGox. |
75-
| `choice` | `CHOICE` | No | Randomly chooses from a list of one or more comma-seperated choices. |
76-
| `dice` | `DICE` | No | Simulates dice rolls |
77-
| `dnsbl` | `RBL` | Yes | Does DNSBL lookups on arbitrary users or IP addresses. |
78-
| `fibbonacci` | `FIB` | No | A memoizing fibbonacci calculator. |
79-
| `fpdtest` | `FPDTEST` | Yes | A flash policy daemon tester. |
80-
| `hubstats` | `OSRC` | No | Shows Github stats on the Open Source Report Card.
81-
| `immature` | `IMMATURE` | No | A smart immature phrase appender. |
82-
| `memusage` | `MEM` | Yes | Shows memory usage statistics. |
83-
| `mpdclient` | `MPD` | Some parts | A simple MPD client, shows currently
84-
playing song and lets opers control next/previous. |
85-
| `opname` | `OPNAME` | No | Bad 80's B-movie style military operation name generator. |
86-
| `ponify` | `PONIFY` | No | Makes text easy to read so everypony can understand it by removing all those weird "human" terms. |
87-
| `say` | `SAY` | Yes | Lets an oper have the main client send arbitrary text to an arbitrary channel or user. |
88-
| `sendfile` | `SENDFILE` | Yes | Lets an oper send the contents of a text file to a user or channel. Useful in sharing ascii art. |
89-
| `shibe` | `SHIBE` | No | Generates shibe text from user input. |
90-
| `source` | `SOURCE` | No | Shows information about running version, protocol module and github source repository. |
91-
| `svsoper` | `SVSOPER` | Yes | Forcibly opers someone using SVSOPER. |
92-
| `tfw` | `TFW` | No | Does weather lookups from http://thefuckingweather.com |
93-
| `weather` | `WEATHER` | No | Does weather lookups via http://worldweatheronline.com (API key needed, see configuration document). |
94-
| `whoami` | `WHOAMI` | No | Shows what Cod knows about you. |
95-
96-
9769
### `bot/mpdclient`
9870

9971
The `mpdclient` module uses a `mpd` block for its configuration parameters.
@@ -159,3 +131,44 @@ Example:
159131
},
160132
```
161133

134+
#### `services/autocloak`
135+
136+
`autocloak` allows administrators to specify specific IP addresses that are
137+
bouncer hosts and to apply a randomly generated vhost on connect.
138+
139+
As this is a pesudoclient-introducing module, it requires a nick, user, gecos
140+
and host configuration as well as the list of bouncers.
141+
142+
An example using `bnc.im` and IRCCloud's public IP addresses is shown below:
143+
144+
```javascript
145+
"autocloak": {
146+
"nick": "Gatekeeper",
147+
"user": "guardian",
148+
"host": "services.example.com",
149+
"gecos": "The gatekeeper",
150+
151+
"list": {
152+
"172.246.127.154": "bnc.im",
153+
"172.246.127.176": "bnc.im",
154+
"172.246.127.177": "bnc.im",
155+
"172.246.127.178": "bnc.im",
156+
"172.246.127.179": "bnc.im",
157+
"88.150.203.213": "bnc.im",
158+
"88.150.203.196": "bnc.im",
159+
"198.52.200.15": "bnc.im",
160+
"198.52.200.16": "bnc.im",
161+
"198.52.199.84": "bnc.im",
162+
"198.52.199.85": "bnc.im",
163+
"213.138.108.24": "bnc.im",
164+
"213.138.108.247": "bnc.im",
165+
"192.184.9.108": "irccloud.com",
166+
"192.184.9.110": "irccloud.com",
167+
"192.184.9.112": "irccloud.com",
168+
"192.184.9.114": "irccloud.com"
169+
}
170+
},
171+
172+
```
173+
174+

‎doc/INSTALL.markdown‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,35 @@
22

33
### Installation:
44

5-
1. Set up an IRC network using Charybdis, ShadowIRCD, elemental-ircd or any other
6-
TS6 ircd. Note that regardless of what TS6 irc daemon you end up choosing,
7-
your protocol module will have to be `elemental-ircd`.
5+
1. Set up an IRC network using Charybdis, Tethys, ShadowIRCD, Elemental-IRCd,
6+
InspIRCd, or any other TS6 daemon. If in doubt choose `charybdis` as your
7+
link protocol.
88
2. Create a link block like [this](https://gist.github.com/lyska/9c8a8e1a1102cbee61c7).
99
3. Copy `etc/config.json.example` to a file of your choice. Read `Configuration.markdown`
1010
for more detailed explanation about each of the configuration elements.
1111
4. Set up an account for your pesudoservice inside your IRC services package.
12-
This is needed for the automatic vhost rejection feature as well as many
13-
others waiting to be written.
12+
This is needed at least for the automatic vhost rejection feature..
1413
5. Configure as needed for your deployment.
1514
6. Run `./cod /path/to/your/config.json`. By default it will use the `config.json`
1615
in the current working directory.
1716
7. `@modload` the modules you want, a useful list is:
1817

18+
* ctcp
19+
* dice
1920
* dnsbl
2021
* dnsblannounce
21-
* help
2222
* killannounce
2323
* killonfailoper
2424
* memusage
25+
* reddit
2526
* relayhostserv
27+
* Note that this module only works with Atheme services
2628
* resv
2729
* say
2830
* sendfile
31+
* source
2932
* twitchtv
33+
* vimeo
3034
* youtube
3135

3236
The weather script will require a free API key from [WorldWeatherOnline](http://worldweatheronline.com).

‎doc/Modules.markdown‎

Lines changed: 5 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Announces RESV use and logs it.
6161
| `bf` | `BF` | No | A simple brainfuck interepreter for one-line experimentation. |
6262
| `btc` | `BTC` | No | Grabs the latest prices from MTGox. |
6363
| `choice` | `CHOICE` | No | Randomly chooses from a list of one or more comma-seperated choices. |
64+
| `ctcp` | None | No | Replies to CTCP version requests. |
6465
| `dice` | `DICE` | No | Simulates dice rolls |
6566
| `dnsbl` | `RBL` | Yes | Does DNSBL lookups on arbitrary users or IP addresses. |
6667
| `fibbonacci` | `FIB` | No | A memoizing fibbonacci calculator. |
@@ -110,6 +111,7 @@ not show up to users and are surrounded by parentheses.
110111
| `reddit` | http://reddit.com | Grabs the name and link (if applicable) of a post on reddit. |
111112
| `soundcloud` | http://soundcloud.com | Grabs the artist and title of a song from soundcloud. |
112113
| `twitchtv` | http://twitch.tv | Grabs the stream info from a twitch.tv stream. |
114+
| `vimeo` | http://vimeo.com | Grabs video information from Vimeo. |
113115
| `youtube` | http://youtube.com | Grabs youtube video information and defines a simple search command `YT` |
114116

115117
## `services`
@@ -118,45 +120,7 @@ not show up to users and are surrounded by parentheses.
118120
|:---- |:----------- |
119121
| `faq` | Stores and spits out FAQ entries. |
120122
| `funservjoin` | Listens for FunServ commands to join channels and gives users information about how to use Cod as a bot. |
121-
| `ofc` | The Orbital Friendship Cannon. A stress tester. See `OFC HELP` for usage. |
122-
123-
#### `autocloak`
124-
125-
`autocloak` allows administrators to specify specific IP addresses that are
126-
bouncer hosts and to apply a randomly generated vhost on connect.
127-
128-
As this is a pesudoclient-introducing module, it requires a nick, user, gecos
129-
and host configuration as well as the list of bouncers.
130-
131-
An example using `bnc.im` and IRCCloud's public IP addresses is shown below:
132-
133-
```javascript
134-
"autocloak": {
135-
"nick": "Gatekeeper",
136-
"user": "guardian",
137-
"host": "services.example.com",
138-
"gecos": "The gatekeeper",
139-
140-
"list": {
141-
"172.246.127.154": "bnc.im",
142-
"172.246.127.176": "bnc.im",
143-
"172.246.127.177": "bnc.im",
144-
"172.246.127.178": "bnc.im",
145-
"172.246.127.179": "bnc.im",
146-
"88.150.203.213": "bnc.im",
147-
"88.150.203.196": "bnc.im",
148-
"198.52.200.15": "bnc.im",
149-
"198.52.200.16": "bnc.im",
150-
"198.52.199.84": "bnc.im",
151-
"198.52.199.85": "bnc.im",
152-
"213.138.108.24": "bnc.im",
153-
"213.138.108.247": "bnc.im",
154-
"192.184.9.108": "irccloud.com",
155-
"192.184.9.110": "irccloud.com",
156-
"192.184.9.112": "irccloud.com",
157-
"192.184.9.114": "irccloud.com"
158-
}
159-
},
160-
161-
```
123+
| `ofc` | The Orbital Friendship Cannon. A stress tester. See `OFC HELP` for
124+
usage. |
125+
| `replayserv` | Replays the last 5 lines of chat in a channel to new members.|
162126

0 commit comments

Comments
 (0)