add scripts/funwar.md

Signed-off-by: hwipl <33433250+hwipl@users.noreply.github.com>

scripts/funwar.md

@@ -0,0 +1,139 @@
+# funwar.tcl
+
+## Setup
+
+Run a new postgres container for eggdrop and set the password of the "postgres"
+superuser:
+
+```console
+$ docker run --name eggdropPostgres \
+	-e POSTGRES_PASSWORD=postgresUserPassword -d postgres
+```
+
+In the following steps, we assume that the new postgres server is listening on
+the IP address 172.17.0.3.
+
+Connect to postgres as superuser "postgres":
+
+```console
+$ docker run -it --rm --network bridge postgres psql -h 172.17.0.3 -U postgres
+```
+
+Add test schema for user "eggdrop" and add the user in the postgres session:
+
+```sql
+CREATE SCHEMA test;
+CREATE USER eggdrop PASSWORD 'eggdropPassword';
+GRANT ALL ON SCHEMA test TO eggdrop;
+GRANT ALL ON ALL TABLES IN SCHEMA test TO eggdrop;
+```
+
+Disconnect superuser "postgres" from postgres:
+
+```
+\q
+```
+
+Reconnect to postgres as user "eggdrop":
+
+```console
+$ docker run -it --rm --network bridge postgres psql -h 172.17.0.3 \
+	-d postgres -U eggdrop
+```
+
+Add table consisting of id, date, time, xonx, clantag, irc, www, server, and
+org as user "eggdrop" in the postgres session:
+
+```sql
+CREATE TABLE test.funmatch(
+   id SERIAL PRIMARY KEY,
+   date DATE NOT NULL DEFAULT CURRENT_DATE,
+   time TIME NOT NULL,
+   xonx INTEGER NOT NULL,
+   clantag VARCHAR (16) NOT NULL,
+   irc VARCHAR (16) NOT NULL,
+   www VARCHAR (256) NOT NULL,
+   server VARCHAR (256) NOT NULL,
+   org VARCHAR (128) NOT NULL
+);
+```
+
+Insert some testing entries into the table:
+
+```sql
+INSERT INTO test.funmatch (time, xonx, clantag, irc, www, server, org)
+VALUES
+('18:30', 8, '[WIN]', '#win', 'www.winclan.com', 'et.winclan.com:1337',
+'winrar'),
+('19:30', 16, '[FAIL]', '#fail', 'www.failclan.com', 'et.failclan.com:7331',
+'failbot'),
+('20:30', 32, '<unknown>', '#unknown', 'www.unknownclan.com',
+'et.unknownclan.com:3000', 'incognito');
+```
+
+Disconnect user "eggdrop" from postgres:
+
+```
+\q
+```
+
+### Examples
+
+Example of periodic posting:
+
+```
+15:50 < FooBot> *** Funwars: ***
+15:50 < FooBot> Game:   Date/Time:           XonX:  Clantag:     IRC:
+15:50 < FooBot> RTCW    2020-01-03/20:30:00  32     <unknown>    #unknown
+15:50 < FooBot> RTCW    2020-01-03/19:30:00  16     [FAIL]       #fail
+15:50 < FooBot> RTCW    2020-01-03/18:30:00  8      [WIN]        #win
+15:50 < FooBot> ET      2020-01-03/20:30:00  32     <unknown>    #unknown
+15:50 < FooBot> ET      2020-01-03/19:30:00  16     [FAIL]       #fail
+15:50 < FooBot> ET      2020-01-03/18:30:00  8      [WIN]        #win
+15:50 < FooBot> *** end of funwars list ***
+```
+
+Example of the `!et` command:
+
+```
+16:00 <@hwipl> !et
+16:00 < FooBot> *** Funwars: ***
+16:00 < FooBot> Game:   Date/Time:           XonX:  Clantag:     IRC:
+16:00 < FooBot> ET      2020-01-03/20:30:00  32     <unknown>    #unknown
+16:00 < FooBot> ET      2020-01-03/19:30:00  16     [FAIL]       #fail
+16:00 < FooBot> ET      2020-01-03/18:30:00  8      [WIN]        #win
+16:00 < FooBot> ET      2020-01-03/20:30:00  32     FAIL         #fail
+16:00 < FooBot> ET      2020-01-03/19:30:00  16     FAIL         #fail
+16:00 < FooBot> ET      2020-01-03/18:30:00  8      FAIL         #fail
+16:00 < FooBot> *** end of funwars list ***
+```
+
+Example of the `!rtcw` command:
+
+```
+16:00 <@hwipl> !rtcw
+16:00 < FooBot> *** Funwars: ***
+16:00 < FooBot> Game:   Date/Time:           XonX:  Clantag:     IRC:
+16:00 < FooBot> RTCW    2020-01-03/20:30:00  32     <unknown>    #unknown
+16:00 < FooBot> RTCW    2020-01-03/19:30:00  16     [FAIL]       #fail
+16:00 < FooBot> RTCW    2020-01-03/18:30:00  8      [WIN]        #win
+16:00 < FooBot> RTCW    2020-01-03/20:30:00  32     FAIL         #fail
+16:00 < FooBot> RTCW    2020-01-03/19:30:00  16     FAIL         #fail
+16:00 < FooBot> RTCW    2020-01-03/18:30:00  8      FAIL         #fail
+16:00 < FooBot> *** end of funwars list ***
+```
+
+Example of the `!funwars` command:
+
+```
+16:00 <@hwipl> !funwars
+16:00 < FooBot> *** Funwars: ***
+16:00 < FooBot> Game:   Date/Time:           XonX:  Clantag:     IRC:
+16:00 < FooBot> RTCW    2020-01-03/20:30:00  32     <unknown>    #unknown
+16:00 < FooBot> RTCW    2020-01-03/19:30:00  16     [FAIL]       #fail
+16:00 < FooBot> RTCW    2020-01-03/18:30:00  8      [WIN]        #win
+16:00 < FooBot> ET      2020-01-03/20:30:00  32     <unknown>    #unknown
+16:00 < FooBot> ET      2020-01-03/19:30:00  16     [FAIL]       #fail
+16:00 < FooBot> ET      2020-01-03/18:30:00  8      [WIN]        #win
+16:00 < FooBot> *** end of funwars list ***
+```