qwtf_discord_bot 4.2.3 → 4.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +62 -72
  3. data/VERSION +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d53c052ce01f40e7761bfc20b8697e25685e0babdd3bdd0a329a4474df163539
4
- data.tar.gz: 9bb3000c5ee85114e0051c40a598c29fe98569cda483975bdcc7b6e321f7d4e0
3
+ metadata.gz: 661856af97a44fb0c64acbc7c1bc0f031fe5281c5ed820d5d90e1c0b2e00c4ac
4
+ data.tar.gz: 774aaabd9a66a7a1c230eacd42d9aa6269e373c6f6cc065d42c30cb71ee216b5
5
5
  SHA512:
6
- metadata.gz: c3769891475fa12c53f8959b2eb2c14b008b79cc4ea7816a41be9a09d183a581c30603822fa4095893acbf5114df628cfe0f144a115c2017258f2db9d94962f5
7
- data.tar.gz: 79ce5d9e0f2a77064e26794433c4a0b2d321af89d9b93f7562acfe1d14ba8e25bda36089a8a295111a268daa8d3ad571590c3e489236934ce269324f278547e6
6
+ metadata.gz: aed7958152064cb290c25a5afbcfb287a679a7751a572719b7862e766957cdc21e67274efc551d98cf690a6563a8244c3945855e243660b4427b74d9c96610ff
7
+ data.tar.gz: 545506b13c8b35825e5bc9a882fdb178a7d4ed3ff4856d03059dab292efe4a512143c328226e6629c91e8303094f95d95ee86208b7aceb36901a772c2660dfac
data/README.md CHANGED
@@ -11,7 +11,7 @@ A Discord bot for checking the status of QuakeWorld Team Fortress servers
11
11
 
12
12
  ## Installation
13
13
 
14
- $ gem install qwtf_discord_bot
14
+ gem install qwtf_discord_bot
15
15
 
16
16
 
17
17
  ## Usage
@@ -20,50 +20,48 @@ A Discord bot for checking the status of QuakeWorld Team Fortress servers
20
20
  - Create a `~/.config/qwtf_discord_bot/config.yaml` file containing your bots
21
21
  credentials and server endpoints
22
22
 
23
- ```yaml
24
- ---
25
- token: "dhjksahdkjhhur43hu4hu5b4b5k34j12b4kj3b4kjb4j32kb4kjb4kb3k2b"
26
- client_id: "873298379487294398"
27
- endpoints:
28
- - "sydney.fortressone.org":
29
- - channel_ids:
30
- - 832749832749873298
31
- - 798437748937298448
32
- - "sydney.fortressone.org:27501":
33
- - channel_ids:
34
- - 590204247224745986
35
- - "dallas.fortressone.org":
36
- - channel_ids:
37
- - 480928490328409328
38
- emojis:
39
- red:
40
- scout: "<:scout_red:424097703127941130>"
41
- sniper: "<:sniper_red:424097704076115978>"
42
- soldier: "<:soldier_red:424097704197619712>"
43
- demoman: "<:demoman_red:424097687739301919>"
44
- medic: "<:medic_red:424097695418941451>"
45
- pyro: "<:pyro_red:424097704403271691>"
46
- hwguy: "<:hwguy_red:424097694030757889>"
47
- spy: "<:spy_red:424097704138899466>"
48
- engineer: "<:engineer_red:424097694680612864>"
49
- blue:
50
- scout: "<:scout_blue:456062063983460353>"
51
- sniper: "<:sniper_blue:456062061953417216>"
52
- soldier: "<:soldier_blue:456062062997536801>"
53
- demoman: "<:demoman_blue:456061938636554240>"
54
- medic: "<:medic_blue:456062056710537217>"
55
- pyro: "<:pyro_blue:456062062460928010>"
56
- hwguy: "<:hwguy_blue:456062063190736926>"
57
- spy: "<:spy_blue:456062062032846849>"
58
- engineer: "<:engineer_blue:456062031125020683>"
59
- ```
60
-
61
- - Use the `QWTF_DISCORD_BOT_CONFIG_FILE` environment variable or default to
62
- specify an alternative file
63
-
64
- ```sh
65
- $ export QWTF_DISCORD_BOT_CONFIG_FILE="config.yaml"
66
- ```
23
+ ```yaml
24
+ ---
25
+ token: "dhjksahdkjhhur43hu4hu5b4b5k34j12b4kj3b4kjb4j32kb4kjb4kb3k2b"
26
+ client_id: "873298379487294398"
27
+ endpoints:
28
+ - "sydney.fortressone.org":
29
+ - channel_ids:
30
+ - 832749832749873298
31
+ - 798437748937298448
32
+ - "sydney.fortressone.org:27501":
33
+ - channel_ids:
34
+ - 590204247224745986
35
+ - "dallas.fortressone.org":
36
+ - channel_ids:
37
+ - 480928490328409328
38
+ emojis:
39
+ red:
40
+ scout: "<:scout_red:424097703127941130>"
41
+ sniper: "<:sniper_red:424097704076115978>"
42
+ soldier: "<:soldier_red:424097704197619712>"
43
+ demoman: "<:demoman_red:424097687739301919>"
44
+ medic: "<:medic_red:424097695418941451>"
45
+ pyro: "<:pyro_red:424097704403271691>"
46
+ hwguy: "<:hwguy_red:424097694030757889>"
47
+ spy: "<:spy_red:424097704138899466>"
48
+ engineer: "<:engineer_red:424097694680612864>"
49
+ blue:
50
+ scout: "<:scout_blue:456062063983460353>"
51
+ sniper: "<:sniper_blue:456062061953417216>"
52
+ soldier: "<:soldier_blue:456062062997536801>"
53
+ demoman: "<:demoman_blue:456061938636554240>"
54
+ medic: "<:medic_blue:456062056710537217>"
55
+ pyro: "<:pyro_blue:456062062460928010>"
56
+ hwguy: "<:hwguy_blue:456062063190736926>"
57
+ spy: "<:spy_blue:456062062032846849>"
58
+ engineer: "<:engineer_blue:456062031125020683>"
59
+ ```
60
+
61
+ - Use the `QWTF_DISCORD_BOT_CONFIG_FILE` environment variable to specify an
62
+ alternative config file path
63
+
64
+ export QWTF_DISCORD_BOT_CONFIG_FILE="config.yaml"
67
65
 
68
66
 
69
67
  ### Commands
@@ -73,7 +71,7 @@ There are two modules:
73
71
 
74
72
  #### Server
75
73
 
76
- $ qwtf-discord-bot server
74
+ qwtf-discord-bot server
77
75
 
78
76
  This responds to discord messages:
79
77
  - `!server`
@@ -85,7 +83,7 @@ This responds to discord messages:
85
83
 
86
84
  #### Watcher
87
85
 
88
- $ qwtf-discord-bot watcher
86
+ qwtf-discord-bot watcher
89
87
 
90
88
  This watches the game server and announces if anyone has joined the server. It
91
89
  polls the server once every 30 seconds and will only report a player joining if
@@ -98,44 +96,36 @@ they haven't been connected for more than ten minutes.
98
96
 
99
97
  Build:
100
98
 
101
- ```sh
102
- docker build --tag=discord-bot .
103
- ```
99
+ docker build --tag=discord-bot .
100
+
104
101
 
105
102
  Push:
106
103
 
107
- ```sh
108
- docker tag discord-bot fortressone/discord-bot:latest
109
- docker push fortressone/discord-bot:latest
110
- ```
104
+ docker tag discord-bot fortressone/discord-bot:latest
105
+ docker push fortressone/discord-bot:latest
106
+
111
107
 
112
108
  Run:
113
109
 
114
110
  Assuming a `./config.yaml` file exists:
115
111
 
116
- Server:
112
+ docker-compose up
113
+
117
114
 
118
- ```sh
119
- docker run -it \
120
- --env QWTF_DISCORD_BOT_CONFIG_FILE=config.yaml \
121
- --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml \
122
- discord-bot server
123
- ```
115
+ Only discord-bot server:
124
116
 
125
- Watcher:
117
+ docker run -it \
118
+ --env QWTF_DISCORD_BOT_CONFIG_FILE=config.yaml \
119
+ --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml \
120
+ discord-bot server
126
121
 
127
- ```sh
128
- docker run -it \
129
- --env QWTF_DISCORD_BOT_CONFIG_FILE=config.yaml \
130
- --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml \
131
- discord-bot watcher
132
- ```
133
122
 
134
- Both:
123
+ Only discord-bot watcher:
135
124
 
136
- ```sh
137
- docker-compose up
138
- ```
125
+ docker run -it \
126
+ --env QWTF_DISCORD_BOT_CONFIG_FILE=config.yaml \
127
+ --mount type=bind,source="$(pwd)"/config.yaml,target=/discord-bot/config.yaml \
128
+ discord-bot watcher
139
129
 
140
130
 
141
131
  ## License
data/VERSION CHANGED
@@ -1 +1 @@
1
- 4.2.3
1
+ 4.2.4
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: qwtf_discord_bot
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.2.3
4
+ version: 4.2.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sheldon Johnson