reciple 3.0.1 → 3.1.0

package/bin/reciple/modules.d.ts

@@ -1,15 +1,21 @@
-import { RecipleCommandBuilders } from './types/builders';
 import { RecipleClient } from './classes/RecipleClient';
+import { RecipleCommandBuilder } from './types/builders';
 export declare type LoadedModules = {
-    commands: RecipleCommandBuilders[];
+    commands: RecipleCommandBuilder[];
     modules: RecipleModule[];
 };
+/**
+ * Reciple script object interface
+ */
 export declare class RecipleScript {
     versions: string | string[];
-    commands?: RecipleCommandBuilders[];
+    commands?: RecipleCommandBuilder[];
     onLoad?(reciple: RecipleClient): void | Promise<void>;
     onStart(reciple: RecipleClient): boolean | Promise<boolean>;
 }
+/**
+ * Reciple module object interface
+ */
 export interface RecipleModule {
     script: RecipleScript;
     info: {
@@ -20,5 +26,7 @@ export interface RecipleModule {
 }
 /**
  * Load modules from folder
+ * @param client Reciple client
+ * @param folder Modules folder
  */
 export declare function loadModules(client: RecipleClient, folder?: string): Promise<LoadedModules>;

package/bin/reciple/modules.js

@@ -14,12 +14,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadModules = void 0;
 const builders_1 = require("./types/builders");
-const fs_1 = require("fs");
 const version_1 = require("./version");
-const wildcard_match_1 = __importDefault(require("wildcard-match"));
+const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
+const wildcard_match_1 = __importDefault(require("wildcard-match"));
 /**
  * Load modules from folder
+ * @param client Reciple client
+ * @param folder Modules folder
  */
 function loadModules(client, folder) {
     var _a, _b;

package/bin/reciple/permissions.d.ts

@@ -1,15 +1,20 @@
-import { Guild, PermissionResolvable, PermissionsBitField } from 'discord.js';
-import { RecipleCommandBuilders } from './types/builders';
 import { Config } from './classes/RecipleConfig';
+import { RecipleUserHasCommandPermissionsOptions } from './types/paramOptions';
+import { Guild, PermissionResolvable } from 'discord.js';
 /**
  * Check if the user has permissions to execute the given command name
+ * @param options options
  */
-export declare function userHasCommandPermissions(commandName: string, memberPermissions?: PermissionsBitField, configConmmandPermissions?: Config['commands']['messageCommand']['permissions'] | Config['commands']['interactionCommand']['permissions'], builder?: RecipleCommandBuilders): boolean;
+export declare function userHasCommandPermissions(options: RecipleUserHasCommandPermissionsOptions): boolean;
 /**
  * Check if the bot has the required permissions in a guild
+ * @param guild Guild
+ * @param requiredPermissions Required guild bot permissions
  */
 export declare function botHasExecutePermissions(guild?: Guild, requiredPermissions?: PermissionResolvable[]): boolean;
 /**
  * Check if the channel id is ignored in config file
+ * @param channelId Check if channel id is in ignore list
+ * @param ignoredChannelsConfig Ignored channels config
  */
 export declare function isIgnoredChannel(channelId: string, ignoredChannelsConfig?: Config["ignoredChannels"]): boolean;

package/bin/reciple/permissions.js

@@ -3,29 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isIgnoredChannel = exports.botHasExecutePermissions = exports.userHasCommandPermissions = void 0;
 /**
  * Check if the user has permissions to execute the given command name
+ * @param options options
  */
-function userHasCommandPermissions(commandName, memberPermissions, configConmmandPermissions, builder) {
-    var _a, _b;
-    if (!(configConmmandPermissions === null || configConmmandPermissions === void 0 ? void 0 : configConmmandPermissions.enabled))
-        return true;
-    const command = (_a = configConmmandPermissions.commands.find(c => c.command.toLowerCase() === commandName.toLowerCase())) !== null && _a !== void 0 ? _a : { permissions: (_b = builder === null || builder === void 0 ? void 0 : builder.RequiredUserPermissions) !== null && _b !== void 0 ? _b : [] };
+function userHasCommandPermissions(options) {
+    var _a, _b, _c;
+    const command = (_c = (((_a = options.commandPermissions) === null || _a === void 0 ? void 0 : _a.enabled)
+        ? (_b = options.commandPermissions) === null || _b === void 0 ? void 0 : _b.commands.find(c => c.command.toLowerCase() === options.builder.name.toLowerCase())
+        : null)) !== null && _c !== void 0 ? _c : { permissions: options.builder.requiredMemberPermissions };
     if (!command.permissions.length)
         return true;
-    return memberPermissions ? memberPermissions.has(command.permissions) : false;
+    return options.memberPermissions ? options.memberPermissions.has(command.permissions) : false;
 }
 exports.userHasCommandPermissions = userHasCommandPermissions;
 /**
  * Check if the bot has the required permissions in a guild
+ * @param guild Guild
+ * @param requiredPermissions Required guild bot permissions
  */
 function botHasExecutePermissions(guild, requiredPermissions) {
-    var _a;
     if (!(requiredPermissions === null || requiredPermissions === void 0 ? void 0 : requiredPermissions.length))
         return true;
-    return (guild === null || guild === void 0 ? void 0 : guild.members.me) ? (_a = guild.members.me) === null || _a === void 0 ? void 0 : _a.permissions.has(requiredPermissions) : false;
+    return (guild === null || guild === void 0 ? void 0 : guild.members.me) ? guild.members.me.permissions.has(requiredPermissions) : false;
 }
 exports.botHasExecutePermissions = botHasExecutePermissions;
 /**
  * Check if the channel id is ignored in config file
+ * @param channelId Check if channel id is in ignore list
+ * @param ignoredChannelsConfig Ignored channels config
  */
 function isIgnoredChannel(channelId, ignoredChannelsConfig) {
     if (!(ignoredChannelsConfig === null || ignoredChannelsConfig === void 0 ? void 0 : ignoredChannelsConfig.enabled))

package/bin/reciple/registerInteractionCommands.d.ts

@@ -1,8 +1,9 @@
 import { InteractionCommandBuilder } from './classes/builders/InteractionCommandBuilder';
+import { RecipleRegisterInteractionCommandsOptions } from './types/paramOptions';
 import { ContextMenuCommandBuilder, SlashCommandBuilder } from '@discordjs/builders';
-import { RegisterInteractionCommandsOptions } from './types/paramOptions';
-export declare type InteractionBuilder = ContextMenuCommandBuilder | InteractionCommandBuilder | SlashCommandBuilder;
+export declare type ApplicationCommandBuilder = InteractionCommandBuilder | ContextMenuCommandBuilder | SlashCommandBuilder;
 /**
  * Register interaction commands
+ * @param options Register interaction commands options
  */
-export declare function registerInteractionCommands(options: RegisterInteractionCommandsOptions): Promise<void>;
+export declare function registerInteractionCommands(options: RecipleRegisterInteractionCommandsOptions): Promise<void>;

package/bin/reciple/registerInteractionCommands.js

@@ -13,6 +13,7 @@ exports.registerInteractionCommands = void 0;
 const InteractionCommandBuilder_1 = require("./classes/builders/InteractionCommandBuilder");
 /**
  * Register interaction commands
+ * @param options Register interaction commands options
  */
 function registerInteractionCommands(options) {
     var _a, _b, _c, _d;
@@ -20,15 +21,16 @@ function registerInteractionCommands(options) {
         const client = options.client;
         const guilds = typeof options.guilds == 'string' ? [options.guilds] : options.guilds;
         const commands = (_b = Object.values((_a = options.commands) !== null && _a !== void 0 ? _a : client.commands.interactionCommands).map(cmd => {
-            var _a, _b;
+            var _a;
             if (typeof (cmd === null || cmd === void 0 ? void 0 : cmd.toJSON) == 'undefined')
                 return cmd;
             cmd = cmd;
             if (cmd instanceof InteractionCommandBuilder_1.InteractionCommandBuilder && client.config.commands.interactionCommand.setRequiredPermissions) {
-                const permissions = (_b = (client.config.commands.interactionCommand.permissions.enabled ?
-                    (_a = client.config.commands.interactionCommand.permissions.commands.find(cmd_ => cmd_.command.toLowerCase() === cmd.name.toLowerCase())) === null || _a === void 0 ? void 0 : _a.permissions :
-                    undefined)) !== null && _b !== void 0 ? _b : cmd.requiredBotPermissions;
-                cmd.setRequiredMemberPermissions(permissions);
+                const permissions = client.config.commands.interactionCommand.permissions.enabled
+                    ? (_a = client.config.commands.interactionCommand.permissions.commands.find(cmd_ => cmd_.command.toLowerCase() === cmd.name.toLowerCase())) === null || _a === void 0 ? void 0 : _a.permissions
+                    : undefined;
+                if (permissions)
+                    cmd.setRequiredMemberPermissions(...permissions);
                 client.commands.interactionCommands[cmd.name] = cmd;
                 if (client.isClientLogsEnabled())
                     client.logger.debug(`Set required permissions for ${cmd.name}`);

package/bin/reciple/types/builders.d.ts

@@ -1,7 +1,16 @@
-import { InteractionCommandBuilder, RecipleInteractionCommandExecuteData } from '../classes/builders/InteractionCommandBuilder';
-import { MessageCommandBuilder, RecipleMessageCommandExecuteData } from '../classes/builders/MessageCommandBuilder';
-export declare type RecipleCommandBuilders = MessageCommandBuilder | InteractionCommandBuilder;
-export declare type RecipleCommandBuildersExecuteData = RecipleInteractionCommandExecuteData | RecipleMessageCommandExecuteData;
+import { InteractionCommandBuilder, InteractionCommandExecuteData } from '../classes/builders/InteractionCommandBuilder';
+import { MessageCommandBuilder, MessageCommandExecuteData } from '../classes/builders/MessageCommandBuilder';
+/**
+ * Reciple command builders
+ */
+export declare type RecipleCommandBuilder = MessageCommandBuilder | InteractionCommandBuilder;
+/**
+ * Reciple command builders execute data
+ */
+export declare type RecipleCommandBuildersExecuteData = InteractionCommandExecuteData | MessageCommandExecuteData;
+/**
+ * Types of Reciple command builders
+ */
 export declare enum RecipleCommandBuilderType {
     MessageCommand = 0,
     InteractionCommand = 1

package/bin/reciple/types/builders.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RecipleCommandBuilderType = void 0;
+/**
+ * Types of Reciple command builders
+ */
 var RecipleCommandBuilderType;
 (function (RecipleCommandBuilderType) {
     RecipleCommandBuilderType[RecipleCommandBuilderType["MessageCommand"] = 0] = "MessageCommand";

package/bin/reciple/types/commands.d.ts

@@ -1,33 +1,39 @@
-import { InteractionCommandBuilder, RecipleInteractionCommandExecuteData } from '../classes/builders/InteractionCommandBuilder';
-import { RecipleMessageCommandExecuteData } from '../classes/builders/MessageCommandBuilder';
-import { MessageCommandOptionManager } from '../classes/MessageCommandOptionManager';
+import { InteractionCommandBuilder, InteractionCommandExecuteData } from '../classes/builders/InteractionCommandBuilder';
+import { MessageCommandExecuteData } from '../classes/builders/MessageCommandBuilder';
 import { CooledDownUser } from '../classes/CommandCooldownManager';
-import { RecipleCommandBuilders } from '../types/builders';
-export declare type RecipleHaltedCommandData<Builder extends RecipleCommandBuilders> = CommandErrorData<Builder> | CommandCooldownData<Builder> | (Builder extends InteractionCommandBuilder ? never : CommandInvalidArguments<Builder> | CommandMissingArguments<Builder>) | CommandMissingMemberPermissions<Builder> | CommandMissingBotPermissions<Builder>;
-export interface CommandHaltBaseData<Builder extends RecipleCommandBuilders> {
-    executeData: Builder extends InteractionCommandBuilder ? RecipleInteractionCommandExecuteData : RecipleMessageCommandExecuteData;
-}
-export interface CommandErrorData<Builder extends RecipleCommandBuilders> extends CommandHaltBaseData<Builder> {
+import { MessageCommandOptionManager } from '../classes/MessageCommandOptionManager';
+import { RecipleCommandBuilder } from '../types/builders';
+/**
+ * Halted command's data
+ */
+export declare type RecipleHaltedCommandData<Builder extends RecipleCommandBuilder = RecipleCommandBuilder> = RecipleCommandErrorData<Builder> | RecipleCommandCooldownData<Builder> | (Builder extends InteractionCommandBuilder ? never : RecipleCommandInvalidArguments<Builder> | RecipleCommandMissingArguments<Builder>) | RecipleCommandMissingMemberPermissions<Builder> | RecipleCommandMissingBotPermissions<Builder>;
+export interface RecipleCommandHaltBaseData<Builder extends RecipleCommandBuilder> {
+    executeData: Builder extends InteractionCommandBuilder ? InteractionCommandExecuteData : MessageCommandExecuteData;
+}
+export interface RecipleCommandErrorData<Builder extends RecipleCommandBuilder> extends RecipleCommandHaltBaseData<Builder> {
     reason: RecipleHaltedCommandReason.Error;
     error: any;
 }
-export interface CommandCooldownData<Builder extends RecipleCommandBuilders> extends CommandHaltBaseData<Builder>, CooledDownUser {
+export interface RecipleCommandCooldownData<Builder extends RecipleCommandBuilder> extends RecipleCommandHaltBaseData<Builder>, CooledDownUser {
     reason: RecipleHaltedCommandReason.Cooldown;
 }
-export interface CommandInvalidArguments<Builder extends RecipleCommandBuilders> extends CommandHaltBaseData<Builder> {
+export interface RecipleCommandInvalidArguments<Builder extends RecipleCommandBuilder> extends RecipleCommandHaltBaseData<Builder> {
     reason: RecipleHaltedCommandReason.InvalidArguments;
     invalidArguments: MessageCommandOptionManager;
 }
-export interface CommandMissingArguments<Builder extends RecipleCommandBuilders> extends CommandHaltBaseData<Builder> {
+export interface RecipleCommandMissingArguments<Builder extends RecipleCommandBuilder> extends RecipleCommandHaltBaseData<Builder> {
     reason: RecipleHaltedCommandReason.MissingArguments;
     missingArguments: MessageCommandOptionManager;
 }
-export interface CommandMissingMemberPermissions<Builder extends RecipleCommandBuilders> extends CommandHaltBaseData<Builder> {
+export interface RecipleCommandMissingMemberPermissions<Builder extends RecipleCommandBuilder> extends RecipleCommandHaltBaseData<Builder> {
     reason: RecipleHaltedCommandReason.MissingMemberPermissions;
 }
-export interface CommandMissingBotPermissions<Builder extends RecipleCommandBuilders> extends CommandHaltBaseData<Builder> {
+export interface RecipleCommandMissingBotPermissions<Builder extends RecipleCommandBuilder> extends RecipleCommandHaltBaseData<Builder> {
     reason: RecipleHaltedCommandReason.MissingBotPermissions;
 }
+/**
+ * Command halt reasons
+ */
 export declare enum RecipleHaltedCommandReason {
     Error = 0,
     Cooldown = 1,

package/bin/reciple/types/commands.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RecipleHaltedCommandReason = void 0;
+/**
+ * Command halt reasons
+ */
 var RecipleHaltedCommandReason;
 (function (RecipleHaltedCommandReason) {
     RecipleHaltedCommandReason[RecipleHaltedCommandReason["Error"] = 0] = "Error";

package/bin/reciple/types/paramOptions.d.ts

@@ -1,8 +1,10 @@
-import { InteractionBuilder } from '../registerInteractionCommands';
-import { RecipleModule, RecipleScript } from '../modules';
 import { RecipleClient } from '../classes/RecipleClient';
-import { ApplicationCommandData } from 'discord.js';
-export interface AddModuleOptions {
+import { Config } from '../classes/RecipleConfig';
+import { RecipleModule, RecipleScript } from '../modules';
+import { ApplicationCommandBuilder } from '../registerInteractionCommands';
+import { RecipleCommandBuilder } from './builders';
+import { ApplicationCommandData, PermissionsBitField } from 'discord.js';
+export interface RecipleAddModuleOptions {
     /**
      * The Module script
      */
@@ -16,7 +18,7 @@ export interface AddModuleOptions {
      */
     moduleInfo?: RecipleModule["info"];
 }
-export interface RegisterInteractionCommandsOptions {
+export interface RecipleRegisterInteractionCommandsOptions {
     /**
      * Bot client
      */
@@ -24,9 +26,14 @@ export interface RegisterInteractionCommandsOptions {
     /**
      * Commands to register
      */
-    commands: (ApplicationCommandData | InteractionBuilder)[];
-    /**
+    commands: (ApplicationCommandData | ApplicationCommandBuilder)[];
+    /**PermissionResolvable
      * Set guild to not register commands globally
      */
     guilds?: string | string[];
 }
+export interface RecipleUserHasCommandPermissionsOptions {
+    builder: RecipleCommandBuilder;
+    memberPermissions?: PermissionsBitField;
+    commandPermissions?: Config["commands"]["interactionCommand"]["permissions"] | Config["commands"]["messageCommand"]["permissions"];
+}

package/bin/reciple/version.d.ts

@@ -1,20 +1,21 @@
+import semver from 'semver';
 /**
  * Current reciple version
  */
 export declare const version: string;
 /**
  * Check if the version is valid
+ * @param ver Version string to validated
  */
 export declare function isValidVersion(ver: string): boolean;
 /**
  * Parse the version string
+ * @param ver Parse version string
  */
-export declare function parseVersion(ver: string): {
-    major: number;
-    minor: number;
-    patch: number;
-};
+export declare function parseVersion(ver: string): semver.SemVer | null;
 /**
  * Check if the given version is supported by the given version range
+ * @param versionRange Version range
+ * @param supportedVersion Version to match given version range
  */
 export declare function isSupportedVersion(versionRange: string, supportedVersion?: string): boolean;

package/bin/reciple/version.js

@@ -11,6 +11,7 @@ const semver_1 = __importDefault(require("semver"));
 exports.version = `${semver_1.default.coerce(require('../../package.json').version)}`;
 /**
  * Check if the version is valid
+ * @param ver Version string to validated
  */
 function isValidVersion(ver) {
     return semver_1.default.valid(semver_1.default.coerce(ver)) !== null;
@@ -18,17 +19,18 @@ function isValidVersion(ver) {
 exports.isValidVersion = isValidVersion;
 /**
  * Parse the version string
+ * @param ver Parse version string
  */
 function parseVersion(ver) {
-    var _a, _b;
     if (!isValidVersion(ver))
         throw new TypeError(`Invalid version: ${ver}`);
-    const [major, minor, patch] = (_b = (_a = `${semver_1.default.coerce(ver)}`) === null || _a === void 0 ? void 0 : _a.split('.')) !== null && _b !== void 0 ? _b : [];
-    return { major: parseInt(major), minor: parseInt(minor), patch: parseInt(patch) };
+    return semver_1.default.parse(ver);
 }
 exports.parseVersion = parseVersion;
 /**
  * Check if the given version is supported by the given version range
+ * @param versionRange Version range
+ * @param supportedVersion Version to match given version range
  */
 function isSupportedVersion(versionRange, supportedVersion) {
     supportedVersion = supportedVersion || exports.version;

package/package.json

@@ -1,24 +1,41 @@
 {
   "name": "reciple",
-  "version": "3.0.1",
-  "description": "Handler for Discord.js",
+  "version": "3.1.0",
+  "bin": "bin/bin.js",
+  "license": "GPL-3.0",
+  "main": "bin/index.js",
   "author": "FalloutStudios",
+  "description": "Handler for Discord.js",
   "homepage": "https://reciple.js.org",
+  "keywords": [
+    "Discord",
+    "Discord.js handler",
+    "Reciple"
+  ],
   "contributors": [
     "GhexterCortes <cortesghexter@gmail.com>"
   ],
   "bugs": {
     "url": "https://github.com/FalloutStudios/reciple/issues"
   },
+  "scripts": {
+    "clean": "rm -rf bin",
+    "build": "yarn clean && yarn exec tsc",
+    "build:publish": "yarn build && yarn npm publish && yarn build:docs && yarn publish:docs",
+    "build:pub-prerelease": "yarn build && yarn publish --tag pre",
+    "build:docs": "yarn workspace docs build",
+    "update:docs": "yarn workspace docs update",
+    "test": "yarn build && yarn test:start",
+    "test:start": "cd test && yarn exec reciple -D",
+    "publish:docs": "yarn build:docs && yarn update:docs"
+  },
+  "workspaces": [
+    "./docs/"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/FalloutStudios/reciple.git"
   },
-  "license": "GPL-3.0",
-  "main": "bin/index.js",
-  "bin": {
-    "reciple": "bin/bin.js"
-  },
   "engines": {
     "node": ">=16.9.0"
   },
@@ -29,18 +46,6 @@
     "LICENSE",
     "README.md"
   ],
-  "scripts": {
-    "clean": "rm -rf bin",
-    "build": "yarn run clean && npx tsc && yarn run reinstall",
-    "build:publish": "yarn run build && yarn publish && yarn run publish:docs",
-    "build:pub-prerelease": "yarn run build && yarn publish --tag pre",
-    "reinstall": "npm un reciple -g && npm i ./ -g",
-    "publish:docs": "yarn run build:docs && yarn run update:docs",
-    "test": "yarn run build && yarn run test:start",
-    "test:start": "cd test && npx reciple",
-    "build:docs": "cd docs && yarn run build",
-    "update:docs": "cd docs && yarn run update"
-  },
   "dependencies": {
     "chalk": "4.1.2",
     "commander": "^9.4.0",
@@ -59,5 +64,5 @@
   "peerDependencies": {
     "discord.js": "14.0.x"
   },
-  "packageManager": "yarn@1.22.19"
-}
+  "packageManager": "yarn@3.2.2"
+}

package/resource/reciple.yml

@@ -2,9 +2,9 @@
 # To use env variable as a token just do it like this env:TOKEN_ENV
 token: TOKEN
 
-
 # Commands options
 commands:
+  # message command options
   messageCommand:
     # enable message commands
     enabled: true
@@ -12,25 +12,27 @@ commands:
     prefix: '!'
     # reply when an error occured
     replyOnError: false
-    # Enable the use of command cooldowns
+    # enable the use of command cooldowns
     enableCooldown: true
-    # Allow executing commands via aliases
+    # allow executing commands via aliases
     allowCommandAlias: true
     # command argument separator
     commandArgumentSeparator: ' '
-    # Overwrite command permissions
+    # overwrite command permissions
     permissions:
       # enable overwriten command permissions
       enabled: false
       commands:
         - command: 'example-command'
           permissions: ['Administrator']
+
+  # Interaction command options
   interactionCommand:
     # enable interaction commands
     enabled: true
     # reply when an error occured
     replyOnError: false
-    # Enable the use of command cooldowns
+    # enable the use of command cooldowns
     enableCooldown: true
     # register interaction commands on bot ready
     registerCommands: true
@@ -38,7 +40,7 @@ commands:
     setRequiredPermissions: true
     # register commands to specific guild(s) empty to make it global
     guilds: []
-    # Overwrite command permissions
+    # overwrite command permissions
     permissions:
       # enable overwriten command permissions
       enabled: false
@@ -71,6 +73,7 @@ fileLogging:
   logFilePath: './logs/latest.log'
 
 # Client options
+# Learn more about client options at https://discord.js.org/#/docs/discord.js/main/typedef/ClientOptions
 client:
   intents:
     - 'Guilds'
@@ -78,7 +81,7 @@ client:
     - 'GuildMessages'
     - 'MessageContent'
 
-# Bot replies
+# Bot messages
 messages:
   missingArguments: 'Not enough arguments.'
   invalidArguments: 'Invalid argument(s) given.'
@@ -99,16 +102,16 @@ messages:
 ignoredFiles: []
 
 
-###################################################
-#                                                 #
-#   #####  #####  #    #   ###   #####  ####      #
-#   #   #  #   #  # #  #  #      #      #   #     #
-#   #   #  #####  #  # #  # ###  ###    ####      #
-#   #  #   #   #  #    #  #   #  #      #   #     #
-#   ###    #   #  #    #   ###   #####  #    #    #
-#                                                 #
-###################################################
-## Modifying these values below can cause errors ##
+####################################################
+#                                                  #
+#    #####  #####  #    #   ###   #####  ####      #
+#    #   #  #   #  # #  #  #      #      #   #     #
+#    #   #  #####  #  # #  # ###  ###    ####      #
+#    #  #   #   #  #    #  #   #  #      #   #     #
+#    ###    #   #  #    #   ###   #####  #    #    #
+#                                                  #
+####################################################
+## Modifying the values below could break reciple ##
 
 # Modules folder
 modulesFolder: 'modules'