1
- EV0002
2
- ======
1
+ # EV0002
3
2
4
- The channel bot in #easyrpg on freenode, provides logs, pizza and a lot of other stuff.
3
+ The channel bot in [ #easyrpg] [ webchat ] on freenode, provides logs, pizza and a lot of
4
+ other stuff.
5
+ It is using the [ cinch] [ cinch ] bot framework and is written in ruby, like the legacy
6
+ EV0001.
5
7
6
- It is using the [ cinch] ( https://github.com/cinchrb/cinch ) bot framework and is written
7
- in ruby, like the legacy EV0001.
8
-
9
- Installation
10
- ------------
8
+ # Installation
11
9
12
10
Needed gems besides ` cinch ` are (see Gemfile for details):
13
11
14
- * [ cinch-seen] ( https://github.com/bhaberer/ cinch-seen)
15
- * [ cinch-identify] ( https://github.com/cinchrb/ cinch-identify)
16
- * [ json] ( http://flori.github.io/ json/ )
17
- * [ thin] ( http://code.macournoyer.com/ thin/ )
18
- * [ sinatra] ( http://sinatrarb.com/ )
19
- * [ chronic] ( https://github.com/mojombo/ chronic)
12
+ * [ cinch-seen] [ cinch-seen ]
13
+ * [ cinch-identify] [ cinch-identify ]
14
+ * [ json] [ json ]
15
+ * [ thin] [ thin ]
16
+ * [ sinatra] [ sinatra ]
17
+ * [ chronic] [ chronic ]
20
18
21
19
You can use bundler to install the dependencies.
22
20
23
- $ bundle install [ --path .gems ]
21
+ $ bundle install --path vendor/bundle [--shebang="ruby1.9" ]
24
22
25
23
If you provide the path argument, gems will be installed locally.
26
24
27
25
Secret values (passwords and such) are read from a file ` secrets.yml ` on startup.
28
26
A template is provided, you need to copy it and fill in the values or remove all
29
27
references to ` $secrets ` and fill in the values directly.
30
28
31
- Running
32
- -------
29
+ # Running
33
30
34
- $ bundle exec ./EV0002.rb
31
+ $ ./EV0002
35
32
36
- If you did not install the gems locally with bundler, you can leave out the ` bundle exec ` .
33
+ This helper script tries to detect if you installed the gems locally with bundler and
34
+ will run EV0002 in bundler environment if needed.
37
35
38
- LICENSE
39
- -------
36
+ # LICENSE
40
37
41
- This bot and its plugins were written by carstene1ns and are licensed under the MIT
42
- license, see LICENSE file for details.
38
+ This bot and plugins were written by carstene1ns and the EV0002 authors.
39
+ They are licensed under the MIT license, see LICENSE file for details.
43
40
There are a few exceptions to the license, see ` Acknowledgements ` sections for details.
44
41
45
- Acknowledgements
46
- ----------------
42
+ # Acknowledgements
47
43
48
- plugins/http_server.rb by [ Quintus] ( https://github.com/Quintus ) , under LGPL license -
49
- from https://github.com/Quintus/cinch-plugins
44
+ plugins/http_server.rb by [ Quintus] [ quintus ] , under LGPL license - from
45
+ https://github.com/Quintus/cinch-plugins
50
46
51
- plugins/logplus.rb by [ Quintus] ( https://github.com/Quintus ) , under LGPL license -
52
- from https://github.com/Quintus/cinch-plugins
47
+ plugins/logplus.rb by [ Quintus] [ quintus ] , under LGPL license - from
48
+ https://github.com/Quintus/cinch-plugins
53
49
54
- Plugins
55
- -------
50
+ # Plugins
56
51
57
52
* plugins/link_github_issues.rb:
58
53
59
- Takes a list of available projects and links corresponding issues when an user sends
60
- a message containing ` <project>#<number> ` . Uses GitHub json api to find issue title,
54
+ Takes a list of available projects and links corresponding issues when an user sends a
55
+ message containing ` <project>#<number> ` . Uses GitHub json api to find issue title,
61
56
state and URL.
62
57
63
58
* plugins/logplus.rb:
64
59
65
- Heavily modified version of Quintus' plugin, see above. Generates HTML logs and links
66
- a corresponding log file, when a user uses the ` log ` command with a human readable
67
- time specification, e.g. ` log monday last week ` .
60
+ Heavily modified version of Quintus' plugin, see above. Generates HTML logs and links a
61
+ corresponding log file, when a user uses the ` log ` command with a human readable time
62
+ specification, e.g. ` log monday last week ` .
68
63
69
64
* plugins/http_server.rb:
70
65
71
- Helper plugin by Quintus, see above. Provides the webserver used by the Webhook
72
- plugins.
66
+ Helper plugin by Quintus, see above. Provides the webserver used by the Webhook plugins.
73
67
74
68
* plugins/dokuwiki_xmlrpc.rb:
75
69
@@ -88,7 +82,7 @@ Plugins
88
82
89
83
Uses GitHub webhooks to provide channel notifications, when something happens on a
90
84
monitored GitHub project. This uses the webserver provided by http_server.rb and
91
- relies on the GitHub api of course. Similiar plugins are names ` octospy ` for other
85
+ relies on the GitHub api of course. Similiar plugins are named ` octospy ` for other
92
86
bot frameworks.
93
87
94
88
* plugins/blog_webhooks.rb:
@@ -98,3 +92,13 @@ Plugins
98
92
http_server.rb and relies on the hookpress wordpress plugin or a hosted setup at
99
93
wordpress.com. Currently, it does not display full information, as the hooks are
100
94
limited to specific fields.
95
+
96
+ [ webchat ] : https://webchat.freenode.net/?channels=easyrpg
97
+ [ cinch ] : https://github.com/cinchrb/cinch
98
+ [ cinch-seen ] : https://github.com/bhaberer/cinch-seen
99
+ [ cinch-identify ] : https://github.com/cinchrb/cinch-identify
100
+ [ json ] : http://flori.github.io/json/
101
+ [ thin ] : http://code.macournoyer.com/thin/
102
+ [ sinatra ] : http://sinatrarb.com/
103
+ [ chronic ] : https://github.com/mojombo/chronic
104
+ [ quintus ] : https://github.com/Quintus
0 commit comments