A chatbot for announcing upcoming matches and finding fellow players, written for the LibreGaming community
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Sebastian Crane b1079768ee Set version in build system to 1.1.1-SNAPSHOT 7 months ago
LICENSES Initial commit 11 months ago
src Add build system 8 months ago
test Use strings instead of keywords for game names 8 months ago
CHANGELOG.md Release version 1.1.0 7 months ago
CONTRIBUTING.md Document the release process in CONTRIBUTING.md 7 months ago
README.md Set default test runner function for :test alias 8 months ago
build.clj Set version in build system to 1.1.1-SNAPSHOT 7 months ago
deps.edn Add build system 8 months ago
tests.edn Initial commit 11 months ago

README.md

matchbot

A chatbot for announcing upcoming matches and finding fellow players, written for the LibreGaming community

Running

  1. Install Clojure - you can use Clojure's official installation guide or your distribution's package.

  2. Clone this repository:

git clone https://git.libregaming.org/LibreGaming/matchbot.git
cd matchbot
  1. Create a configuration file, config.yaml, in YAML format:
data-file: "matchbot-data.json"
irc:
  server: example.com
  port: 6667
  nick: matchbot
  channel: "##matchbot-test"
  1. Run matchbot:
clojure -M -m system

Usage

!list - show all the games that have a list of players

!match game - announce a match of game to all of its players

!players game - show all the players of game

!add game - add yourself to the list of players for game

!remove game - remove yourself from the list of players for game

!help - show available commands with their explanations

Development

Running the tests

matchbot includes automated unit tests for many functions, along with a simple test runner configuration with Kaocha. Running the tests is a similar process to running the main application:

clojure -M:test

Starting a development REPL

When developing matchbot, it can be more convenient and efficient to work interactively with a REPL integrated into your text editor. Since matchbot uses Clojure's tools.deps library, the best way to start is by following the relevant part of the nREPL documentation to create a user-level deps.edn file, then install the nREPL extension for your text editor.

You can create, start and stop an instance of the chatbot process with the functions in the system namespace:

;; creating a new instance - an empty Var
(def my-instance nil)

;; starting the instance
(alter-var-root #'my-instance system/start)

;; restarting the instance
(system/restart #'my-instance)

;; stopping and resetting the instance
(alter-var-root #'my-instance system/stop)
(alter-var-root #'my-instance (constantly nil))

Once you are familiar with nREPL, you can additionally use tools.namespace.repl to make reevaluating (reloading) your changes easier:

(require '[clojure.tools.namespace.repl :refer [refresh]])
(refresh)

Make sure that you create your system instance in the REPL, since refresh will forcefully delete the instance if it has been defined in another namespace!