{"_id":"@21x37/discord-bot","_rev":"1-b6253aa3cef3186ef2b049d315a7990b","name":"@21x37/discord-bot","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@21x37/discord-bot","version":"1.0.0","description":"Easily setup discord bots with some customization!","main":"discordBot.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/21x37/discordBot.git"},"keywords":["discord","bot","chat","greeting","emotes","moderate","21x37"],"author":{"name":"Tyler Mok"},"license":"MIT","bugs":{"url":"https://github.com/21x37/discordBot/issues"},"homepage":"https://github.com/21x37/discordBot#readme","dependencies":{"discord.js":"^11.4.2"},"gitHead":"7e94060a20143ff9994f81aaa1859b61a4ee0679","_id":"@21x37/discord-bot@1.0.0","_npmVersion":"6.4.1","_nodeVersion":"10.15.3","_npmUser":{"name":"21x37","email":"tylermok@outlook.com"},"dist":{"integrity":"sha512-U9bj/rLW6DjAjdbAuGy14dUZvgJg7CZQFs7baUSNsjdilIo5yjJtXIYvFsf9OmvT2o+6jg/d7ZLnGVSO6jyDvw==","shasum":"31a498a4e31723628e61d940567e0b47018ae8fa","tarball":"https://registry.npmjs.org/@21x37/discord-bot/-/discord-bot-1.0.0.tgz","fileCount":3,"unpackedSize":6668,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcynn1CRA9TVsSAnZWagAAtfIP/jxngA7M0KeVTK2MurxG\nlovMdw/B8KNI7cLX47VFHGMy8z1EEy0kMjAPYdqzKXLJaHLrISAwe36QJLjI\nSfmnAcFNrVGkYWyqLljJ2vJgH2hJCWaqlRkr9Lm1Tk7V/fKQ4/5K3jRyE2ve\ndODmQV/Nli0G7lay3j1RBMT8L1jJW9TN6hn7nJBH/qGAb8yyzQkQ7WNSZGA9\nY65S20PBwViZ6ntb4dvspTQNBVRRjF9MfsTKH0QZikH4Y+N+j2VDMJHtRxoz\n9Z9mqiN845P3WjcNGEK/p0mXLtbxxcFV8eaxrdMMeiReNiLyEhzKy3t45StX\n62OZ+bFFUjJb15RtNA4VzI6Sr+gKH9Q6AbRbZ3TsTjVtX4QPEsDGq2xzHIiP\nYJUFRmtdqsFKlYY/jjeBVvtE3DUNJJZ32cgI+NDNAD4GqAYaBe+edbdY/rM3\naFl4e0VCQZO4XgRVMFfTTS59BocFpF9vH6xsdUGaXCnhBzg9XFSl5TiLDcWw\nPgx02jim+4wd2zyj/3iLo9eQ0ppXrjz3GCwyUnyn34lzPKQ1UjO4sfZ0PsyU\nxN51hd/tm4VYsooaxbPfrbTZLxeKXSHEYHZRl12TF7lXXfwsprf33HFbeEmZ\ncyCOpztn+bcG8SWhWBTTqVa9TqtNy0rXLSov58uGLoZ3c4pLY4bFeiYg/h18\nMVo+\r\n=cNi6\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGqDFzKUyzTGTrHSud4Ku6moKyo/4AByLXXgAA/e2WQrAiB83O0OrgV5HlTD446WZC5G4ic9hqqsyP6RG6U6iCqDgg=="}]},"maintainers":[{"name":"21x37","email":"tylermok@outlook.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/discord-bot_1.0.0_1556773364620_0.17802788522565693"},"_hasShrinkwrap":false}},"time":{"created":"2019-05-02T05:02:44.589Z","1.0.0":"2019-05-02T05:02:44.788Z","modified":"2022-04-04T10:35:56.396Z"},"maintainers":[{"name":"21x37","email":"tylermok@outlook.com"}],"description":"Easily setup discord bots with some customization!","homepage":"https://github.com/21x37/discordBot#readme","keywords":["discord","bot","chat","greeting","emotes","moderate","21x37"],"repository":{"type":"git","url":"git+https://github.com/21x37/discordBot.git"},"author":{"name":"Tyler Mok"},"bugs":{"url":"https://github.com/21x37/discordBot/issues"},"license":"MIT","readme":"# @21x37/discord-bot\r\nEasily setup a discord bot with this npm module! 🕹️\r\n\r\n# Install\r\n```\r\nnpm install @21x37/discord-bot\r\n```\r\n\r\n# Usage\r\n```js\r\nconst discordBot = require('@21x37/discord-bot');\r\n\r\nconst options ={\r\n    token: \r\n    isModerating,\r\n    isGreeting,\r\n    emotes\r\n};\r\n```\r\n### Token is the discord token received from https://discordapp.com/developers/applications\r\n```js\r\nconst token = process.env.DISCORD_TOKEN\r\n```\r\n\r\n### isModerating is a boolean, true or false. If you want the bot to have !kick and !ban commands.\r\n```js\r\nconst isModerating = true;\r\n```\r\nIn discord\r\n```\r\n!kick @username\r\n```\r\n\r\n### isGreeting is a object with possibly three properties.\r\n* Boolean is if the greeting is active or not.\r\n* Message is the message you want displayed when a person joins the channel. The username if the new user will immediately be added to the end of the string.\r\n* Channel is the channel name of where you want the greeting to be.\r\n\r\n```js\r\nconst isGreeting = { boolean: true, message: 'Welcome!', 'general' };\r\n```\r\n### Emotes is an ARRAY of objects where each object will have the command and a url to the image.\r\n\r\n```js\r\nconst emotes = [\r\n  { command: '!foo', url: 'https://www.bar.com/thevalueofbar.jpg' }\r\n]\r\n```\r\n### To start the bot.\r\n```js\r\nconst bot = new discordBot(options);\r\nbot.start();\r\n```\r\n\r\n# Example\r\n\r\n```js\r\nconst discordBot = require('@21x37/discord-bot');\r\n\r\nconst options = {\r\n    token: process.env.DISCORD_TOKEN,\r\n    isModerating: true,\r\n    isGreeting: { active: true, message: 'Welcome to our server!', channelName: 'general' },\r\n    emotes: [{ command: '!pepeHands', url: 'https://i.kym-cdn.com/entries/icons/original/000/025/382/Screen_Shot_2018-02-06_at_3.37.14_PM.png' }],\r\n}\r\n\r\nconst bot = new discordBot(options);\r\n\r\nbot.start();\r\n```\r\nThen just node your file in the cli.\r\n```\r\nnode discordBot.js\r\n```","readmeFilename":"README.md"}