Replacement for gpy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Agastya Chandrakant d459831d88
Merge pull request #4 from cognitive137/master
11 months ago
.gitignore Add SET option 1 year ago
LICENSE initial commit 1 year ago
README.md initial commit 1 year ago
config.js chaning URL to fix w.wiki blunder for ? 1 year ago
irc.js Update irc.js 11 months ago
package.json Bump node-fetch from 2.6.0 to 2.6.1 1 year ago
promUrlShortener.js thx regex 1 year ago
time.js add way of getting time 1 year ago
utils.js fixing ? 1 year ago
yarn.lock Bump node-fetch from 2.6.0 to 2.6.1 1 year ago

README.md

Converts MediaWiki links and {{templates}} to links.

Installation

To run this project, run the following commands after cloning it.

cd <DIR>
yarn # or `npm i`
yarn start # or `npm run start`

Configuration

Use the config.js to configure the bot.

  • Specify the bot's IRC nick in botName. (eg. linkBot)
  • Mention the list of channels to monitor in channels.
  • Specify IRC channel in server. (eg. irc.freenode.net)
  • API should be specified in URL. (eg. https://en.wikinews.org/w/index.php?title=)

Additionally, the bot reports any errors to its maintainers.

  • Mention the list of maintainers in the maintainers array.
  • PM to the bot will not be forwarded to anyone, unless it starts with a particular string mentioned in report. If the bot gets a PM which starts with report, it will forward the PM to a list of admins. Note: This could be abused, so specifying report as / might be a good idea.
  • Specify the list of admins who would like to receive PM of the forwarded message in admins.

Sample config.js looks like:

const config = {
  admins: ['jdoe', 'samsmith'],
  botName: 'linkBot',
  channels: ['#foo', '##bar'],
  maintainers: ['list', 'of', 'maintainers'],
  report: '!ADMIN',
  server: 'irc.freenode.net',
  URL: 'https://en.wikinews.org/w/index.php?title=',
};

Note: In case if your message contains templates and you don't want the bot to announce the link -- add --nl at the end of the message.