diff --git a/README.md b/README.md index 56845a4..0ea2a2e 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,68 @@ -# maubot -A plugin-based [Matrix](https://matrix.org) bot system written in Python. - -## Documentation - -All setup and usage instructions are located on -[docs.mau.fi](https://docs.mau.fi/maubot/index.html). Some quick links: - -* [Setup](https://docs.mau.fi/maubot/usage/setup/index.html) - (or [with Docker](https://docs.mau.fi/maubot/usage/setup/docker.html)) -* [Basic usage](https://docs.mau.fi/maubot/usage/basic.html) -* [Encryption](https://docs.mau.fi/maubot/usage/encryption.html) - -## Discussion -Matrix room: [#maubot:maunium.net](https://matrix.to/#/#maubot:maunium.net) - -## Plugins -Open a pull request or join the Matrix room linked above to get your plugin listed here. - -The plugin wishlist lives at . - -### Official plugins -* [sed](https://github.com/maubot/sed) - A bot to do sed-like replacements. -* [factorial](https://github.com/maubot/factorial) - A bot to calculate unexpected factorials. -* [media](https://github.com/maubot/media) - A bot that replies with the MXC URI of images you send it. -* [dice](https://github.com/maubot/dice) - A combined dice rolling and calculator bot. -* [karma](https://github.com/maubot/karma) - A user karma tracker bot. -* [xkcd](https://github.com/maubot/xkcd) - A bot to view xkcd comics. -* [echo](https://github.com/maubot/echo) - A bot that echoes pings and other stuff. -* [rss](https://github.com/maubot/rss) - A bot that posts RSS feed updates to Matrix. -* [reminder](https://github.com/maubot/reminder) - A bot to remind you about things. -* [translate](https://github.com/maubot/translate) - A bot to translate words. -* [reactbot](https://github.com/maubot/reactbot) - A bot that responds to messages that match predefined rules. -* [exec](https://github.com/maubot/exec) - A bot that executes code. -* [commitstrip](https://github.com/maubot/commitstrip) - A bot to view CommitStrips. -* [supportportal](https://github.com/maubot/supportportal) - A bot to manage customer support on Matrix. -* †[gitlab](https://github.com/maubot/gitlab) - A GitLab client and webhook receiver. -* [github](https://github.com/maubot/github) - A GitHub client and webhook receiver. -* [tex](https://github.com/maubot/tex) - A bot that renders LaTeX. -* [altalias](https://github.com/maubot/altalias) - A bot that lets users publish alternate aliases in rooms. -* [satwcomic](https://github.com/maubot/satwcomic) - A bot to view SatWComics. -* [songwhip](https://github.com/maubot/songwhip) - A bot to post Songwhip links. -* [manhole](https://github.com/maubot/manhole) - A plugin that lets you access a Python shell inside maubot. - -### 3rd party plugins -* [subreddit linkifier](https://github.com/TomCasavant/RedditMaubot) - A bot that condescendingly corrects a user when they enter an r/subreddit without providing a link to that subreddit -* [giphy](https://github.com/TomCasavant/GiphyMaubot) - A bot that generates a gif (from giphy) given search terms -* [trump](https://github.com/jeffcasavant/MaubotTrumpTweet) - A bot that generates a Trump tweet with the given content -* [poll](https://github.com/TomCasavant/PollMaubot) - A bot that will create a simple poll for users in a room -* [urban](https://github.com/dvdgsng/UrbanMaubot) - A bot that fetches definitions from [Urban Dictionary](https://www.urbandictionary.com/). -* [twilio](https://github.com/jeffcasavant/MaubotTwilio) - Maubot-based SMS bridge -* [tmdb](https://codeberg.org/lomion/tmdb-bot) - A bot that posts information about movies fetched from TheMovieDB.org. -* [invite](https://github.com/williamkray/maubot-invite) - A bot to generate invitation tokens from [matrix-registration](https://github.com/ZerataX/matrix-registration) -* [wolframalpha](https://github.com/ggogel/WolframAlphaMaubot) - A bot that allows requesting information from [WolframAlpha](https://www.wolframalpha.com/). -* †[pingcheck](https://edugit.org/nik/maubot-pingcheck) - A bot to ping the echo bot and send rtt to Icinga passive check -* [ticker](https://github.com/williamkray/maubot-ticker) - A bot to return financial data about a stock or cryptocurrency. -* [weather](https://github.com/kellya/maubot-weather) - A bot to get the weather from wttr.in and return a single line of text for the location specified -* †[youtube previewer](https://github.com/ggogel/YoutubePreviewMaubot) - A bot that responds to a YouTube link with the video title and thumbnail. -* †[reddit previewer](https://github.com/ggogel/RedditPreviewMaubot) - A bot that responds to a link of a reddit post with the sub name and title. If available, uploads the image or video. -* [pocket](https://github.com/jaywink/maubot-pocket) - A bot integrating with Pocket to fetch articles and archive them. - -† Uses a synchronous library which can block the whole maubot process (e.g. requests instead of aiohttp) - -### Deprecated/unmaintained plugins -* [jesaribot](https://github.com/maubot/jesaribot) - A simple bot that replies with an image when you say "jesari". - * Superseded by reactbot -* [gitea](https://github.com/saces/maugitea) - A Gitea client and webhook receiver. +# maubot +A plugin-based [Matrix](https://matrix.org) bot system written in Python. + +## Documentation + +All setup and usage instructions are located on +[docs.mau.fi](https://docs.mau.fi/maubot/index.html). Some quick links: + +* [Setup](https://docs.mau.fi/maubot/usage/setup/index.html) + (or [with Docker](https://docs.mau.fi/maubot/usage/setup/docker.html)) +* [Basic usage](https://docs.mau.fi/maubot/usage/basic.html) +* [Encryption](https://docs.mau.fi/maubot/usage/encryption.html) + +## Discussion +Matrix room: [#maubot:maunium.net](https://matrix.to/#/#maubot:maunium.net) + +## Plugins +Open a pull request or join the Matrix room linked above to get your plugin listed here. + +The plugin wishlist lives at . + +### Official plugins +* [sed](https://github.com/maubot/sed) - A bot to do sed-like replacements. +* [factorial](https://github.com/maubot/factorial) - A bot to calculate unexpected factorials. +* [media](https://github.com/maubot/media) - A bot that replies with the MXC URI of images you send it. +* [dice](https://github.com/maubot/dice) - A combined dice rolling and calculator bot. +* [karma](https://github.com/maubot/karma) - A user karma tracker bot. +* [xkcd](https://github.com/maubot/xkcd) - A bot to view xkcd comics. +* [echo](https://github.com/maubot/echo) - A bot that echoes pings and other stuff. +* [rss](https://github.com/maubot/rss) - A bot that posts RSS feed updates to Matrix. +* [reminder](https://github.com/maubot/reminder) - A bot to remind you about things. +* [translate](https://github.com/maubot/translate) - A bot to translate words. +* [reactbot](https://github.com/maubot/reactbot) - A bot that responds to messages that match predefined rules. +* [exec](https://github.com/maubot/exec) - A bot that executes code. +* [commitstrip](https://github.com/maubot/commitstrip) - A bot to view CommitStrips. +* [supportportal](https://github.com/maubot/supportportal) - A bot to manage customer support on Matrix. +* †[gitlab](https://github.com/maubot/gitlab) - A GitLab client and webhook receiver. +* [github](https://github.com/maubot/github) - A GitHub client and webhook receiver. +* [tex](https://github.com/maubot/tex) - A bot that renders LaTeX. +* [altalias](https://github.com/maubot/altalias) - A bot that lets users publish alternate aliases in rooms. +* [satwcomic](https://github.com/maubot/satwcomic) - A bot to view SatWComics. +* [songwhip](https://github.com/maubot/songwhip) - A bot to post Songwhip links. +* [manhole](https://github.com/maubot/manhole) - A plugin that lets you access a Python shell inside maubot. + +### 3rd party plugins +* [subreddit linkifier](https://github.com/TomCasavant/RedditMaubot) - A bot that condescendingly corrects a user when they enter an r/subreddit without providing a link to that subreddit +* [giphy](https://github.com/TomCasavant/GiphyMaubot) - A bot that generates a gif (from giphy) given search terms +* [trump](https://github.com/jeffcasavant/MaubotTrumpTweet) - A bot that generates a Trump tweet with the given content +* [poll](https://github.com/TomCasavant/PollMaubot) - A bot that will create a simple poll for users in a room +* [urban](https://github.com/dvdgsng/UrbanMaubot) - A bot that fetches definitions from [Urban Dictionary](https://www.urbandictionary.com/). +* [twilio](https://github.com/jeffcasavant/MaubotTwilio) - Maubot-based SMS bridge +* [tmdb](https://codeberg.org/lomion/tmdb-bot) - A bot that posts information about movies fetched from TheMovieDB.org. +* [invite](https://github.com/williamkray/maubot-invite) - A bot to generate invitation tokens from [matrix-registration](https://github.com/ZerataX/matrix-registration) +* [wolframalpha](https://github.com/ggogel/WolframAlphaMaubot) - A bot that allows requesting information from [WolframAlpha](https://www.wolframalpha.com/). +* †[pingcheck](https://edugit.org/nik/maubot-pingcheck) - A bot to ping the echo bot and send rtt to Icinga passive check +* [ticker](https://github.com/williamkray/maubot-ticker) - A bot to return financial data about a stock or cryptocurrency. +* [weather](https://github.com/kellya/maubot-weather) - A bot to get the weather from wttr.in and return a single line of text for the location specified +* †[youtube previewer](https://github.com/ggogel/YoutubePreviewMaubot) - A bot that responds to a YouTube link with the video title and thumbnail. +* †[reddit previewer](https://github.com/ggogel/RedditPreviewMaubot) - A bot that responds to a link of a reddit post with the sub name and title. If available, uploads the image or video. +* [pocket](https://github.com/jaywink/maubot-pocket) - A bot integrating with Pocket to fetch articles and archive them. +* [metric](https://github.com/edwardsdean/maubot_metric_bot) - A bot that will reply to a message that contains imperial units and replace them with metric units. + +† Uses a synchronous library which can block the whole maubot process (e.g. requests instead of aiohttp) + +### Deprecated/unmaintained plugins +* [jesaribot](https://github.com/maubot/jesaribot) - A simple bot that replies with an image when you say "jesari". + * Superseded by reactbot +* [gitea](https://github.com/saces/maugitea) - A Gitea client and webhook receiver. \ No newline at end of file