Skip to content

Commit f390367

Browse files
committedSep 27, 2015
Reformat and rewrite parts of README, add launcher
Update gems, update LICENSE
1 parent 9e1ff9b commit f390367

File tree

5 files changed

+75
-58
lines changed

5 files changed

+75
-58
lines changed
 

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
/.bundle
1212

1313
# local gem folder
14-
/.gems
14+
/vendor

‎EV0002

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#!/bin/bash
2+
3+
if [ -d ".bundle" ]; then
4+
echo "Starting EV0002 in bundler environment..."
5+
exec bundle exec ./EV0002.rb
6+
else
7+
echo "Starting EV0002..."
8+
exec ./EV0002.rb
9+
fi

‎Gemfile.lock

+20-17
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ GEM
22
remote: https://rubygems.org/
33
specs:
44
chronic (0.10.2)
5-
cinch (2.1.0)
5+
cinch (2.2.6)
66
cinch-cooldown (1.1.5)
77
cinch (~> 2)
88
time-lord (~> 1.0, >= 1.0.1)
9-
cinch-identify (1.6.0)
9+
cinch-identify (1.7.0)
1010
cinch (~> 2.0)
1111
cinch-seen (1.0.5)
1212
cinch (~> 2)
@@ -18,25 +18,25 @@ GEM
1818
psych (~> 2.0, >= 2.0.4)
1919
cinch-toolbox (1.1.4)
2020
nokogiri (~> 1.6.0)
21-
daemons (1.1.9)
22-
eventmachine (1.0.3)
23-
json (1.8.1)
24-
mini_portile (0.6.0)
25-
nokogiri (1.6.3.1)
26-
mini_portile (= 0.6.0)
27-
psych (2.0.5)
28-
rack (1.5.2)
21+
daemons (1.2.3)
22+
eventmachine (1.0.8)
23+
json (1.8.3)
24+
mini_portile (0.6.2)
25+
nokogiri (1.6.6.2)
26+
mini_portile (~> 0.6.0)
27+
psych (2.0.15)
28+
rack (1.6.4)
2929
rack-protection (1.5.3)
3030
rack
31-
sinatra (1.4.5)
31+
sinatra (1.4.6)
3232
rack (~> 1.4)
3333
rack-protection (~> 1.4)
34-
tilt (~> 1.3, >= 1.3.4)
35-
thin (1.6.2)
36-
daemons (>= 1.0.9)
37-
eventmachine (>= 1.0.0)
38-
rack (>= 1.0.0)
39-
tilt (1.4.1)
34+
tilt (>= 1.3, < 3)
35+
thin (1.6.4)
36+
daemons (~> 1.0, >= 1.0.9)
37+
eventmachine (~> 1.0, >= 1.0.4)
38+
rack (~> 1.0)
39+
tilt (2.0.1)
4040
time-lord (1.0.1)
4141

4242
PLATFORMS
@@ -50,3 +50,6 @@ DEPENDENCIES
5050
json
5151
sinatra
5252
thin
53+
54+
BUNDLED WITH
55+
1.10.6

‎LICENSE

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
Copyright (c) 2014 Carsten Teibes
1+
Copyright (c) 2015 EV0002 authors
2+
Copyright (c) 2014-2015 Carsten Teibes
23

34
Permission is hereby granted, free of charge, to any person obtaining a copy of this
45
software and associated documentation files (the "Software"), to deal in the Software

‎README.md

+43-39
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,69 @@
1-
EV0002
2-
======
1+
# EV0002
32

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.
57

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
119

1210
Needed gems besides `cinch` are (see Gemfile for details):
1311

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]
2018

2119
You can use bundler to install the dependencies.
2220

23-
$ bundle install [--path .gems]
21+
$ bundle install --path vendor/bundle [--shebang="ruby1.9"]
2422

2523
If you provide the path argument, gems will be installed locally.
2624

2725
Secret values (passwords and such) are read from a file `secrets.yml` on startup.
2826
A template is provided, you need to copy it and fill in the values or remove all
2927
references to `$secrets` and fill in the values directly.
3028

31-
Running
32-
-------
29+
# Running
3330

34-
$ bundle exec ./EV0002.rb
31+
$ ./EV0002
3532

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.
3735

38-
LICENSE
39-
-------
36+
# LICENSE
4037

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.
4340
There are a few exceptions to the license, see `Acknowledgements` sections for details.
4441

45-
Acknowledgements
46-
----------------
42+
# Acknowledgements
4743

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
5046

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
5349

54-
Plugins
55-
-------
50+
# Plugins
5651

5752
* plugins/link_github_issues.rb:
5853

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,
6156
state and URL.
6257

6358
* plugins/logplus.rb:
6459

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`.
6863

6964
* plugins/http_server.rb:
7065

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.
7367

7468
* plugins/dokuwiki_xmlrpc.rb:
7569

@@ -88,7 +82,7 @@ Plugins
8882

8983
Uses GitHub webhooks to provide channel notifications, when something happens on a
9084
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
9286
bot frameworks.
9387

9488
* plugins/blog_webhooks.rb:
@@ -98,3 +92,13 @@ Plugins
9892
http_server.rb and relies on the hookpress wordpress plugin or a hosted setup at
9993
wordpress.com. Currently, it does not display full information, as the hooks are
10094
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

Comments
 (0)
Please sign in to comment.