aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorturret <turret@duck.com>2023-11-24 01:22:05 -0600
committerturret <turret@duck.com>2023-11-24 01:22:05 -0600
commit46508afbe5756ce795054482a78c3867a03e819e (patch)
tree74a2a210cfba9a34b5f3904783f99327540604d2
parent68ccb3e03cccd99313ee01cda5772750269c8f73 (diff)
downloaddiscord-bot-skeleton-46508afbe5756ce795054482a78c3867a03e819e.tar.gz
discord-bot-skeleton-46508afbe5756ce795054482a78c3867a03e819e.tar.bz2
discord-bot-skeleton-46508afbe5756ce795054482a78c3867a03e819e.zip
doc: add basic info about repo, and todo list
-rw-r--r--CONTRIBUTING.txt12
-rw-r--r--README.txt18
-rw-r--r--TODO.txt24
3 files changed, 54 insertions, 0 deletions
diff --git a/CONTRIBUTING.txt b/CONTRIBUTING.txt
new file mode 100644
index 0000000..571c5db
--- /dev/null
+++ b/CONTRIBUTING.txt
@@ -0,0 +1,12 @@
+HI! thank you for wanting to contribute to my project.
+
+only asks are that you follow the coding style already established (i try to
+do this aswell so come at me)
+
+i can take patches via github PRs or email (turret@duck.com)
+have something you want to add to, but its not in TODO? go ahead and send in
+your patch anyway!
+
+licensing? at time of writing, i need to find out what license i want to
+release this as. if you're contributing, please make sure to sign-off your
+commit, certifying to the contributor certificate-of-origin
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..cd2848d
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,18 @@
+turret.'s discord bot skeleton for C99
+
+see TODO.txt and CONTRIBUTING.txt if you want to lend a hand!
+
+not finished
+release date unknown at time of writing
+
+- building
+`make`! thats all.
+
+- errors
+uh oh! i have github issues enabled on the github mirror
+(https://github.com/git-turret-cyou/progs-discord-bot-skeleton). you can file
+an issue or email me directly (will likely be placed on the issue tracker)
+(turret@duck.com)
+
+- using
+IDK! wait for release ig..
diff --git a/TODO.txt b/TODO.txt
new file mode 100644
index 0000000..f42f1e6
--- /dev/null
+++ b/TODO.txt
@@ -0,0 +1,24 @@
+TODO:
+
+- Credentials/config system
+ - fetch from SOMEWHERE
+ - env? built-in? header? linked in as txt?
+
+- Discord API Abstraction
+ - GET/POST/DELETE/WHATEVER api that you can send quick requests to the API
+ already authenticated.
+
+- Discord Websockets
+ - authentication
+ - libcurl
+ - reconnecting/resuming
+ - heartbeat
+
+- Event Abstractor
+
+- Name initcall levels
+ - ill figure out a use for all of the levels once i actually get some work
+ in play
+
+- command registration API
+