binury / github-lines

(forked for PR)

GitHub Lines

GitHub Lines is a minimal and non-intrusive multi-platform bot that displays one or more lines when mentioned in a GitHub (or GitLab) link. It also supports syntax highlighting!

Discord

Example:

Adding to a Discord server

Add the bot to your server by clicking this link.

Discord Commands

GitHub Lines has a few commands that you can use, although no commands are necessary to display the lines. The prefix for the commands is ";"

1. ;help - Returns a list of commands
2. ;about or ;stats - Returns some info about the bot
3. ;invite, ;vote or ;topgg - Returns the link for the bot's top.gg page, from where you can invite the bot to your server
4. ;botsgg - Returns the link for the bot's discord.bots.gg page, from where you can invite the bot to your server
5. ;ping - Returns the bot's latency
6. ;github or ;source - Returns the bot's source GitHub repo

Telegram

Add user githublinesbot to the group.

Running your own

To run the bot yourself, follow these simple steps:

1. Clone the repo (git clone https://github.com/diogoscf/github-lines.git)
2. Copy .env.example into .env and paste your Discord bot token (obtain one here) after DISCORD_TOKEN=
3. Run npm install
4. Run npm start

If you wish to, you may also specify a top.gg token (after TOPGG=in the .env file). You can also specify a GitHub OAuth token (after GITHUB_TOKEN=in the .env file) to avoid rate limits when accessing the API.

Contributing

We'd happily accept any contributions to this project. Open an issue if you have any ideas, or open a PR if you'd like to contribute directly.

Contributors

• Diogo S.C. Fernandes @diogoscf - Creator / Main Dev / Discord bot
• Aadi Bajpai @aadibajpai - Idea for the bot
• Bartek Pacia @bartekpacia - Telegram bot
• Srevin Saju @srevinsaju - Matrix bot