https://github.com/deingithub/travelhook
relay checkins from travelynx to a discord channel
https://github.com/deingithub/travelhook
Last synced: 6 months ago
JSON representation
relay checkins from travelynx to a discord channel
- Host: GitHub
- URL: https://github.com/deingithub/travelhook
- Owner: deingithub
- License: other
- Created: 2023-04-30T16:32:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T09:08:47.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T12:08:21.354Z (almost 2 years ago)
- Language: Python
- Homepage:
- Size: 2.09 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# the travelynx relay bot
a bot for [discord](https://en.wikipedia.org/wiki/Apple_of_Discord) and [travelynx](https://travelynx.de), combining the privacy nightmare powers of both to broadcast your live location to your friends and enemies on aforementioned chat programme. it looks something like this:
see [this page](/icons/descriptions.md) for a list of all currently supported train types (it won't break on others, it just looks fancier if the train is supported)
to set up a dev environment or host it yourself:
1. install [nix](https://nixos.org/download#download-nix)
2. clone the source code
3. copy `settings.json.example` to `settings.json` and edit to your liking
4. initialize the database: run `cat migrations/* | sqlite3 -echo travelynx-relay.sqlite3`
5. add your server's and optionally a live feed channel's ids to the database (the bot only works with manually added servers for now): `INSERT INTO servers(server_id, live_channel) VALUES(1234,5678);`
6. run `nix-shell` for your dev environment, in there you can start the bot using `python3 -m travelhook`
when developing please occasionally run `black` and maybe even `pylint`. that would be dope
note: if you want to properly set this bot up you will need to add a whole bunch of train type icons as emoji to servers your bot is on and accordingly edit the source code with its ids because your bot won't have access to the servers my bot's emoji are on. i know this is very annoying. sorry