chariot.js/docs/assets/js/20.51a2d7db.js

An extremely lightweight and extensible Eris client framework

(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{207:function(t,s,e){"use strict";e.r(s);var a=e(0),n=Object(a.a)({},(function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("div",{staticClass:"content"},[t._m(0),t._v(" "),e("p",[t._v("A config class for Chariot.js holding all vital instantiation information needed.")]),t._v(" "),t._m(1),t._v(" "),t._m(2),t._v(" "),e("div",{staticClass:"table"},[e("table",[t._m(3),t._v(" "),e("tbody",[e("tr",[t._m(4),t._v(" "),t._m(5),t._v(" "),e("td",[e("Fa-Times")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("Your Discord API bot application token")])]),t._v(" "),e("tr",[t._m(6),t._v(" "),t._m(7),t._v(" "),e("td",[e("Fa-Times")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("Chariot.js options & configuration")])]),t._v(" "),e("tr",[t._m(8),t._v(" "),t._m(9),t._v(" "),e("td",[e("Fa-Times")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("Prefix(es) for triggering commands")])]),t._v(" "),e("tr",[t._m(10),t._v(" "),t._m(11),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("Custom per-guild prefixes")])]),t._v(" "),e("tr",[t._m(12),t._v(" "),t._m(13),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),t._m(14),t._v(" "),e("td",[t._v("Use the default Help command or not")])]),t._v(" "),e("tr",[t._m(15),t._v(" "),e("td",[e("router-link",{attrs:{to:"./../constants/colors.html"}},[t._v("Color")])],1),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),e("td",[t._v("Random")]),t._v(" "),e("td",[t._v("Main color for the default help embed")])]),t._v(" "),e("tr",[t._m(16),t._v(" "),t._m(17),t._v(" "),e("td",[e("Fa-Times")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v('An array with all IDs "owning" the bot')])]),t._v(" "),e("tr",[t._m(18),t._v(" "),t._m(19),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("An array with all folder names to ignore")])]),t._v(" "),e("tr",[t._m(20),t._v(" "),t._m(21),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("Custom locales. See "),e("router-link",{attrs:{to:"./../constants/locales.html"}},[t._v("Locales")]),t._v(".")],1)]),t._v(" "),e("tr",[t._m(22),t._v(" "),t._m(23),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("All Eris options. "),e("a",{attrs:{href:"https://abal.moe/Eris/docs/Client",target:"_blank",rel:"noopener noreferrer"}},[t._v("Reference"),e("OutboundLink")],1)])])])])]),t._v(" "),t._m(24),t._v(" "),t._m(25),t._v(" "),e("p",[t._v("Per-Guild Prefixes are passed as an array of object(s) with following API:")]),t._v(" "),e("div",{staticClass:"table"},[e("table",[t._m(26),t._v(" "),e("tbody",[e("tr",[t._m(27),t._v(" "),t._m(28),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("A Per-Guild prefix object")])]),t._v(" "),e("tr",[t._m(29),t._v(" "),t._m(30),t._v(" "),e("td",[e("Fa-Times")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("The ID of the Guild for the custom prefix")])]),t._v(" "),e("tr",[t._m(31),t._v(" "),t._m(32),t._v(" "),e("td",[e("Fa-Times")],1),t._v(" "),e("td",[t._v("N/A")]),t._v(" "),e("td",[t._v("The new custom prefix for the guild specified")])])])])]),t._v(" "),e("p",[t._v("If more than 1 custom prefix is wished to be registered for a single guild, simply add another object with the same Guild ID and a new prefix. Chariot.js will automatically assign and filter all prefixes to their corresponding Guild IDs.")]),t._v(" "),t._m(33),t._v(" "),t._m(34),t._v(" "),t._m(35),t._v(" "),t._m(36),t._v(" "),t._m(37),t._v(" "),e("p",[t._v("Chariot.js automatically injects the logged-in client's user credentials for a super simple and dynamic per-client use and respects that data dynamically across the entire application, even in the default Help command!")]),t._v(" "),t._m(38),t._v(" "),t._m(39),t._v(" "),t._m(40)])}),[function(){var t=this.$createElement,s=this._self._c||t;return s("h1",{attrs:{id:"config"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#config"}},[this._v("#")]),this._v(" Config")])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"constructor"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[this._v("#")]),this._v(" Constructor")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("Instantiation: "),s("span",{staticStyle:{"font-weight":"bold"}},[s("code",[this._v("new Config(token, chariotOptions [,erisOptions]);")])])])},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("thead",[e("tr",[e("th",[t._v("Parameter")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Optional")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("token")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("chariotOptions")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("Object")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("chariotOptions.prefix")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String[]")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("chariotOptions.guildPrefixes")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("Object[]")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("chariotOptions.defaultHelpCommand")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("Boolean")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("false")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("chariotOptions.primaryColor")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("chariotOptions.owner")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String[]")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("chariotOptions.excludeDirectories")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String[]")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("chariotOptions.customLocales")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("Object")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("erisOptions")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("Object")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"per-guild-prefixes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#per-guild-prefixes"}},[this._v("#")]),this._v(" Per-Guild Prefixes")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("Chariot.js supports per-guild prefixes in addition to the default set of prefixes as of version "),s("code",[this._v("3.4.0")]),this._v(".")])},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("thead",[e("tr",[e("th",[t._v("Parameter")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Optional")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("guildPrefixes")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("Object")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("guildPrefixes.guildID")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("guildPrefixes.prefix")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("Specifying an array of prefixes in a single object like "),s("code",[this._v("{ guildID: 'ID', prefix: ['!', ';'] }")]),this._v(" isn't supported!")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("Please see the "),s("a",{attrs:{href:"#example"}},[this._v("Example")]),this._v(" down below for a practical use-case.")])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"mention-prefix"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#mention-prefix"}},[this._v("#")]),this._v(" Mention Prefix")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("Chariot.js supports the use of a mention prefix as of version "),s("code",[this._v("3.4.0")]),this._v(" in order to ping the bot for command invocation.")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("Simply pass "),s("code",[this._v("@mention")]),this._v(" in the Array of default prefixes as shown in the "),s("a",{attrs:{href:"#example"}},[this._v("Example")]),this._v(" below.")])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"example"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[this._v("#")]),this._v(" Example")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("Here's a super simple example for a "),s("a",{attrs:{href:"#"}},[this._v("Chariot.Config")]),this._v(" object:")])},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("div",{staticClass:"language-js extra-class"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chariot"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Config")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n    "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'<TOKEN>'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" \n    "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n        prefix"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'c!'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'!'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@mention'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        guildPrefixes"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" guildID"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0123456789'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" prefix"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'&'")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" guildID"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'0123456789'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" prefix"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'?'")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" guildID"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'9876543210'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" prefix"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("';'")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n        "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        defaultHelpCommand"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        primaryColor"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ORANGE'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        owner"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'<Discord Snowflake 1>'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'<Discord Snowflake 2>'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'<Discord Snowflake n>'")]),t._v("\n        "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        excludeDirectories"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'super_secret_folder_1'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'super_secret_folder_2'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'super_secret_folder_n'")]),t._v("\n        "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        customLocales"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n            missingPermissions"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Command **{command}** requires following permissions: **{missingPermissions}**'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            owner"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'You should not be playing around with this!'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            cooldown"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Just wait **{timeLeftFormatted}** before spamming **{command}** yet again ...'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            nsfw"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'**{command}** is an NSFW command and cannot be used here.'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            userPermissions"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n                title"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Hold up ...'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n                description"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'I need you to make sure you have following permissions before using this command: **{missingUserPermissions}**'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n        "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n    "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n        messageLimit"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        defaultImageFormat"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'png'")]),t._v("\n    "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])}],!1,null,null,null);s.default=n.exports}}]);