summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Yu <andrew@andrewyu.org>2022-08-12 02:22:26 +0800
committerAndrew Yu <andrew@andrewyu.org>2022-08-12 02:22:26 +0800
commit76bd3f2c09178b1fb29a05f905de391cb1688a3a (patch)
treecb0ef2c250830a2a05fd925d379370c76a085a4e
parente88aab29b4d04e6a44d6bb96f0cba5dd1c0c21c2 (diff)
downloadirc-mod-bot-76bd3f2c09178b1fb29a05f905de391cb1688a3a.tar.gz
irc-mod-bot-76bd3f2c09178b1fb29a05f905de391cb1688a3a.zip
Example configuration + Some TODO items
-rw-r--r--TODO6
-rw-r--r--config.py.example15
2 files changed, 19 insertions, 2 deletions
diff --git a/TODO b/TODO
index ae221c7..5869b60 100644
--- a/TODO
+++ b/TODO
@@ -1,4 +1,6 @@
-- Keep track of channel modes, keep track of QUIT.
+- Track MODE.
+- Track QUIT.
+- Ask ChanServ for operator status when needed.
+ A bit hard considering the current structure of the program? Probably add state handlers or whatever.
- Summon the GNU.
- Reload configuration on-the-fly.
-- Case sensitivity
diff --git a/config.py.example b/config.py.example
new file mode 100644
index 0000000..667cbe6
--- /dev/null
+++ b/config.py.example
@@ -0,0 +1,15 @@
+from __future__ import annotations
+from typing import Optional
+
+SERVER: str = "irc.example.org"
+PORT: int = 6667
+NICK: bytes = b"nickname"
+IDENT: bytes = b"ident"
+GECOS: bytes = b"realname"
+CHANNELS: list[bytes] = [b"#channel"]
+ADMINS: list[bytes] = [b"*!good-person@exampke.org"]
+PREFIX: bytes = b"^"
+
+# If either LOGIN or PASSWORD is set to None, SASL PLAIN is disabled
+LOGIN: Optional[bytes] = b"username"
+PASSWORD: Optional[bytes] = b"password"