diff --git a/README.md b/README.md index 1131bfe..0de8c2e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ -# wiktionary-tf2 +# wiktlarp-tf2 -this is a really stupid script to gloss `[[wikilinked]]` words sent in tf2 chat. +larp as en.wiktionary.org. + +![example](demo.png) + +this is a really stupid script to gloss `[[wikilinked]]` words sent in +tf2 chat. it works by reading TF2's console log file for events, and +responding over RCON. + +``` +con_logfile console.log +ip 0.0.0.0 +rcon_password monitor +net_start +``` + +wiktionary entries are discovered via a wiktextract jsonl dump +converted to sqlite via the rust program in `db`. it is also desirable +to create an index for the words: + +```clj +(let [ds (sql/get-datasource {:dbtype "sqlite" :dbname "db/words.db"})] + (with-open [conn (sql/get-connection ds)] + (sql/execute! conn ["create index idx on words(word)"]))) +``` diff --git a/demo.png b/demo.png new file mode 100644 index 0000000..ad2dd7f Binary files /dev/null and b/demo.png differ