SweeBridge/README.md
2024-12-31 21:10:09 -08:00

37 lines
No EOL
962 B
Markdown

# New SweeBridge
SweeZero's own chat relay/bridge.
To-Do:
* [ ] Matrix support
* [ ] Revolt support
* [ ] Discourse support
* [ ] Add Web Dashboard/Control
* [ ] Allow control if you're an operator/admin of the channel/server
* [ ] Support for other IRC networks (Possibly AnthroChat & SnooNet)
Not planned but thought of:
* [ ] WhatsApp support
Current platforms:
* IRC Libera.Chat
* Discord
* Guilded
Requirements of software:
* Python 3
* Nothing for IRC, since it uses socket.
* [Discord.Py](https://discordpy.readthedocs.io/en/stable/intro.html)
* [Guilded.Py](https://guildedpy.readthedocs.io/en/stable/gettingstarted.html)
* [Python Requests](https://pypi.org/project/requests/)
* A [ZNC instance](https://wiki.znc.in) running on localhost (127.0.0.1) at port 5000
Required enviroment variables:
```bash
IRCNick=SweeBridge
LiberaUser=BridgeUser/Libera # for use in ZNC
ZNCPassword=password # for use in ZNC
DiscordToken=token
GuildedToken=token
```