Browse Source

improved project layout and began documentation

master
Rachel Fae Fox 4 weeks ago
parent
commit
288797833f
  1. 7
      README.md
  2. 17
      config/config.exs
  3. 0
      config/test.exs
  4. 30
      docs/todo.org
  5. 0
      lib/discord/discordhandler.ex
  6. 0
      lib/discord/discordinfo.ex
  7. 0
      lib/discord/webhookservice.ex
  8. 0
      lib/discordirc/channel_map.ex
  9. 0
      lib/discordirc/formatter.ex
  10. 0
      lib/irc/irc_bot.ex
  11. 0
      lib/irc/irc_supervisor.ex
  12. 0
      lib/irc/splitter.ex
  13. 3
      mix.exs
  14. BIN
      priv/defaultavatar.jpg
  15. BIN
      priv/defaultavatar.png

7
README.md

@ -2,7 +2,7 @@
## Installation
you need to configure this with a config.exs
you need to configure this with a dev.exs like such
```elixir
import Config
@ -26,10 +26,7 @@ config :discordirc,
]
config :nostrum,
# The token of your bot as a string
token: "666",
# The number of shards you want to run your bot under, or :auto.
num_shards: :auto
token: "YOUR TOKEN HERE",
```
## Running

17
config/config.exs

@ -0,0 +1,17 @@
import Config
config :discordirc,
channels: [
],
networks: [
]
config :nostrum,
# The token of your bot as a string
token: "",
# The number of shards you want to run your bot under, or :auto.
num_shards: :auto,
gateway_intents: :all
import_config "#{config_env()}.exs"

0
config/test.exs

30
docs/todo.org

@ -0,0 +1,30 @@
* DONE warning: variable "nick" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/formatter.ex:10: Discordirc.Formatter.from_irc/3
CLOSED: [2022-11-10 Thu 12:51]
* DONE warning: variable "e" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/discordhandler.ex:26: Discordirc.DiscordHandler.is_me_or_my_webhook/1
CLOSED: [2022-11-10 Thu 12:51]
* DONE warning: variable "me" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/discordhandler.ex:36: Discordirc.DiscordHandler.handle_event/1
CLOSED: [2022-11-10 Thu 12:51]
* DONE warning: unused alias DiscordAPI lib/formatter.ex:5
CLOSED: [2022-11-10 Thu 12:58]
* DONE warning: variable "e" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/webhookservice.ex:96: Discordirc.WebhookService.handle_info/2
CLOSED: [2022-11-10 Thu 12:53]
* DONE warning: variable "e" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/webhookservice.ex:99: Discordirc.WebhookService.handle_info/2
CLOSED: [2022-11-10 Thu 12:53]
* DONE warning: variable "users" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/irc_bot.ex:115: Discordirc.IRC.handle_info/1
CLOSED: [2022-11-10 Thu 12:57]
* DONE warning: variable "users" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/irc_bot.ex:118: Discordirc.IRC.handle_info/1
CLOSED: [2022-11-10 Thu 12:57]
* DONE warning: variable "modestr" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/irc_bot.ex:121: Discordirc.IRC.handle_info/1
CLOSED: [2022-11-10 Thu 12:57]
* DONE warning: variable "topic" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/irc_bot.ex:124: Discordirc.IRC.handle_info/1
CLOSED: [2022-11-10 Thu 12:57]
* DONE warning: clauses with the same name should be grouped together, "def handle_info/2" was previously defined (lib/irc_bot.ex:64) lib/irc_bot.ex:127
CLOSED: [2022-11-10 Thu 12:56]
* DONE warning: unused alias ApiError lib/webhookservice.ex:10
CLOSED: [2022-11-10 Thu 12:59]
* DONE warning: unused alias DiscordCache lib/webhookservice.ex:9
CLOSED: [2022-11-10 Thu 12:59]
* DONE warning: variable "args" is unused (if the variable is not meant to be used, prefix it with an underscore) lib/irc_bot.ex:161: Discordirc.IRC.handle_info/2
CLOSED: [2022-11-10 Thu 12:58]
* DONE warning: unused alias DiscordAPI lib/irc_bot.ex:37
CLOSED: [2022-11-10 Thu 12:58]

0
lib/discordhandler.ex → lib/discord/discordhandler.ex

0
lib/discordinfo.ex → lib/discord/discordinfo.ex

0
lib/webhookservice.ex → lib/discord/webhookservice.ex

0
lib/channel_map.ex → lib/discordirc/channel_map.ex

0
lib/formatter.ex → lib/discordirc/formatter.ex

0
lib/irc_bot.ex → lib/irc/irc_bot.ex

0
lib/irc_supervisor.ex → lib/irc/irc_supervisor.ex

0
lib/splitter.ex → lib/irc/splitter.ex

3
mix.exs

@ -7,7 +7,8 @@ defmodule Discordirc.MixProject do
version: "0.1.0",
elixir: "~> 1.10",
start_permanent: Mix.env() == :prod,
deps: deps()
deps: deps(),
aliases: [test: "test --no-start"]
]
end

BIN
priv/defaultavatar.jpg

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
priv/defaultavatar.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Loading…
Cancel
Save