PsychoticNinja/JLU5-SupyPlugins
1
0
Fork 0
mirror of https://github.com/jlu5/SupyPlugins.git synced 2025-04-26 04:51:08 -05:00
Code Issues Projects Releases Wiki Activity

README update [skip ci]

Browse Source 
- Remove plugins list, as it's basically never up to date
- Prefer using pip over PluginDownloader to install plugins individually
This commit is contained in:
James Lu 2023-03-30 22:25:21 -07:00
parent 45f2639eb6
commit 916122cf65
1 changed files with 4 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -10,72 +10,14 @@ The recommended way of fetching plugins in this repository is to clone the git r
* `$ git clone https://github.com/jlu5/SupyPlugins`
and add the folder to your bot's `config directories.plugins`.
and add the folder to your bot's `config directories.plugins`. Then, you can update your local copy of all plugins by running `git pull`.
**You will need a working copy of [Limnoria](https://github.com/ProgVal/Limnoria) running on Python >= 3.8** (prefer the latest Python 3.x when available).
**You will need a copy of [Limnoria](https://github.com/ProgVal/Limnoria) running on Python >= 3.8** (prefer the latest Python 3.x available).
If you are using a recent version of Limnoria's PluginDownloader, you can also fetch [individual plugins](#list-of-plugins) by running:
* `install jlu5 <plugin>`
on your bot.
You can also install individual plugins using pip: `pip3 install "git+https://github.com/jlu5/SupyPlugins.git#subdirectory=PLUGIN_NAME"`
## Support
Feel free to post to the issue tracker if you have any problems, or find me on IRC: #limnoria @ Libera.chat.
Feel free to post to the issue tracker if you have any problems, or find me on the Limnoria discussion channel `#limnoria @ Libera.chat`.
## License
Unless otherwise noted, all plugins are available under a 3 clause BSD license (inserted at the top of each file).
## List of plugins
Please note that this list may not always be up to date; your best bet is to actually browse the code for yourself! Any specific plugin dependencies should also be listed.
Most of these plugins also have their own READMEs in their folders; you can usually find a usage demonstration or further explanation of what they do.
### AQI
- Retrieves [air quality index](https://en.wikipedia.org/wiki/Air_quality_index) info from the [World Air Quality Index project](https://aqicn.org).
### [Grapnel](Grapnel/README.md)
- Announce Slack-compatible webhooks to IRC
### LastFM
- LastFM plugin, forked from [krf/supybot-lastfm](https://github.com/krf/supybot-lastfm).
### [NoTrigger](NoTrigger/README.md)
- Anti-abuse script; prevents the bot from triggering other bots by modifying its output slightly. For more information, see [NoTrigger/README.md](NoTrigger/README.md).
### [NuWeather](NuWeather/README.md)
- A weather plugin for Limnoria supporting multiple backends.
### [OperUp](OperUp/README.md)
- Allows Limnoria to oper up on configured networks, automatically (on connect) and on demand.
### [PkgInfo](PkgInfo/README.md)
- Fetches package information from various Linux and BSD distros' software repositories.
- **Requires:** [Beautiful Soup 4](http://www.crummy.com/software/BeautifulSoup/bs4/doc/)
### QuakeNet
- Log in to Quakenet's Q Service via CHALLENGEAUTH. This plugin was written by request and not officially supported.
### Restart
- **EXPERIMENTAL**: provides a command to restart Limnoria from IRC.
### [RelayNext](RelayNext/README.md)
- Next generation relayer plugin, designed with two-way relays in mind.
### RhymeZone
- Fetches rhymes from http://rhymezone.com/.
- **Requires:** [Beautiful Soup 4](http://www.crummy.com/software/BeautifulSoup/bs4/doc/)
### SupyMisc
- Some assorted commands that don't seem to fit anywhere else.
### SysDNS
- An alternative to Limnoria's built-in DNS command, using the `host` DNS lookup utility on the host machine.
* **Requires:** `host` DNS lookup binary (as in `/usr/bin/host`)
### [TranslateParty](TranslateParty/README.md)
- Translates text through Google Translate multiple times in order to get amusing results.
### Wikifetch
- Fetch content from MediaWiki-powered sites (Wikipedia, Fandom)
- **Requires:** [Beautiful Soup 4](http://www.crummy.com/software/BeautifulSoup/bs4/doc/), [mwparserfromhell](https://mwparserfromhell.readthedocs.io/)