- TypeScript 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| src | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
ss14 matrix bot
this bot periodically checks the status of space station 14 (ss14) servers and optionally sends a message (alert) when one is in lobby
setup (dev and prod)
first, register an account on the homeserver of your choice for your bot
then, put USERNAME, PASSWORD and HOMESERVER in .env (for development) or your environment (for production)
lastly, you can add your servers into the enviroment/.env in the SERVERS variable, like this: SERVERS="Lizard|lizard.spacestation14.com,Leviathan|leviathan.spacestation14.com"
your environment (or .env file) should now have SERVERS, TOKEN, USERNAME and PASSWORD
optionally, you may specify REFRESH (for how often the bot should fetch server info) and PREFIX
running
for development, you can run npm run dev to start the bot; this reads from the .env file and skips tsc transpiling (but requires node.js >=24)
for production, npm run start transpiles with tsc but assumes all required env variables are in the environment already (instead of reading from .env)
usage
the bot joins any room that it is invited to (group chats and dms), as is standard for matrix bots. use !help to list all commands.
todo
- store server states and alarms in regex
- ping user that envoked alarm