help.js 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. import { Util } from 'discord.js';
  2. import help_server from '../functions/helpserver.js';
  3. import { createRequire } from 'module';
  4. const require = createRequire(import.meta.url);
  5. const {wikis: mcw} = require('./minecraft/commands.json');
  6. const helpmap = {
  7. linkHelp: ['default', 'inline.link', 'inline.template', 'gamepedia', 'fandom', 'wikia'],
  8. link: ['default', 'inline.link', 'inline.template', 'gamepedia', 'fandom', 'wikia', 'mwprojects'],
  9. inline: ['inline.link', 'inline.template'],
  10. user: ['user'],
  11. overview: ['overview'],
  12. random: ['random'],
  13. diff: ['diff.name', 'diff.id'],
  14. page: ['page'],
  15. search: ['search'],
  16. minecraftHelp: ['minecraft.default', 'minecraft.bug'],
  17. command: ['minecraft.default', 'minecraft.command'],
  18. bug: ['minecraft.bug'],
  19. discussion: ['discussion.thread', 'discussion.post'],
  20. //info: ['info'],
  21. help: ['help.default', 'help.command', 'help.admin'],
  22. settings: ['settings.default', 'settings.wiki', 'settings.lang', 'settings.role', 'settings.inline', 'settings.prefix', 'settings.channel'],
  23. verify: ['verify'],
  24. verification: ['verification.default', 'verification.add', 'verification.channel', 'verification.role', 'verification.editcount', 'verification.postcount', 'verification.usergroup', 'verification.accountage', 'verification.rename', 'verification.delete'],
  25. rcscript: ['rcscript.default', 'rcscript.add', 'rcscript.wiki', 'rcscript.lang', 'rcscript.display', 'rcscript.feeds', 'rcscript.delete'],
  26. voice: ['voice'],
  27. pause: ['pause.inactive'],
  28. test: ['test'],
  29. }
  30. const helplist = {
  31. default: [
  32. 'linkHelp',
  33. 'user',
  34. 'overview',
  35. 'random',
  36. 'diff',
  37. 'minecraftHelp',
  38. 'discussion',
  39. //'info',
  40. 'help',
  41. 'test'
  42. ],
  43. admin: [
  44. 'help.admin',
  45. 'settings.default',
  46. 'verification.default',
  47. 'rcscript.default',
  48. 'voice',
  49. 'pause.inactive'
  50. ],
  51. pause: [
  52. 'pause.active',
  53. 'settings.default',
  54. 'verification.default',
  55. 'rcscript.default',
  56. 'voice',
  57. 'test'
  58. ],
  59. minecraft: [
  60. 'minecraft.default',
  61. 'minecraft.bug'
  62. ]
  63. }
  64. const restrictions = {
  65. fandom: ['discussion'],
  66. minecraft: ['minecraftHelp', 'command', 'bug'],
  67. admin: ['settings', 'verification', 'rcscript', 'voice', 'pause'],
  68. inline: ['inline.link', 'inline.template'],
  69. patreon: ['settings.prefix'],
  70. experimental: []
  71. }
  72. /**
  73. * Processes the "help" command.
  74. * @param {import('../util/i18n.js').default} lang - The user language.
  75. * @param {import('discord.js').Message} msg - The Discord message.
  76. * @param {String[]} args - The command arguments.
  77. * @param {String} line - The command as plain text.
  78. * @param {import('../util/wiki.js').default} wiki - The wiki for the message.
  79. */
  80. function cmd_help(lang, msg, args, line, wiki) {
  81. if ( msg.inGuild() && pausedGuilds.has(msg.guildId) && ( args.join('') || !msg.isAdmin() ) ) return;
  82. if ( msg.isAdmin() && msg.defaultSettings ) help_server(lang, msg);
  83. var isMinecraft = mcw.hasOwnProperty(wiki.href);
  84. var maxLength = ( ['hi', 'bn'].includes( lang.lang ) ? 480 : 2000 );
  85. if ( args.join('') ) {
  86. if ( args.join(' ').isMention(msg.guild) ) {
  87. if ( !( msg.isAdmin() && msg.defaultSettings ) ) help_server(lang, msg);
  88. return;
  89. }
  90. var invoke = args[0].toLowerCase();
  91. var cmd = ( lang.aliases[invoke] || invoke );
  92. if ( cmd === 'admin' ) {
  93. if ( !msg.inGuild() || msg.isAdmin() ) {
  94. var cmdlist = lang.get('help.admin') + '\n';
  95. if ( process.env.READONLY ) cmdlist = msg.author.toString() + ', ' + lang.get('general.readonly') + '\n' + process.env.invite + '\n\n' + cmdlist;
  96. cmdlist += formathelp(helplist.admin, msg, lang);
  97. cmdlist += '\n\n🔸 ' + lang.get('help.adminfooter');
  98. if ( process.env.dashboard ) cmdlist += '\n\t\t' + new URL(( msg.inGuild() ? `/guild/${msg.guildId}/settings` : '/' ), process.env.dashboard).href;
  99. Util.splitMessage( cmdlist, {char: '\n🔹', maxLength, prepend: '🔹'} ).forEach( textpart => msg.sendChannel( textpart ) );
  100. }
  101. else {
  102. msg.replyMsg( {content: lang.get('help.noadmin'), allowedMentions: {repliedUser: false}} );
  103. }
  104. }
  105. else if ( cmd === 'minecraft' ) {
  106. var cmdlist = '<' + ( isMinecraft ? wiki : 'https://minecraft.fandom.com/' ) + '>\n';
  107. cmdlist += formathelp(helplist.minecraft, msg, lang);
  108. Util.splitMessage( cmdlist, {char: '\n🔹', maxLength, prepend: '🔹'} ).forEach( textpart => msg.sendChannel( textpart ) );
  109. }
  110. else if ( helpmap.hasOwnProperty(cmd) &&
  111. ( !restrictions.fandom.includes( cmd ) || wiki.isFandom(false) ) &&
  112. ( !restrictions.minecraft.includes( cmd ) || isMinecraft ) &&
  113. ( !restrictions.admin.includes( cmd ) || msg.isAdmin() ) ) {
  114. var cmdlist = formathelp(helpmap[cmd], msg, lang);
  115. if ( !cmdlist.length ) msg.reactEmoji('❓');
  116. else Util.splitMessage( cmdlist, {char: '\n🔹', maxLength, prepend: '🔹'} ).forEach( textpart => msg.sendChannel( textpart ) );
  117. }
  118. else msg.reactEmoji('❓');
  119. }
  120. else if ( msg.isAdmin() && pausedGuilds.has(msg.guildId) ) {
  121. var cmdlist = lang.get('help.pause') + '\n';
  122. cmdlist += formathelp(helplist.pause, msg, lang);
  123. Util.splitMessage( cmdlist, {char: '\n🔹', maxLength, prepend: '🔹'} ).forEach( textpart => msg.sendChannel( textpart ) );
  124. }
  125. else {
  126. var cmdlist = lang.get('help.all') + '\n';
  127. helplist.default.forEach( cmd => {
  128. if ( ( !restrictions.fandom.includes( cmd ) || wiki.isFandom(false) ) &&
  129. ( !restrictions.minecraft.includes( cmd ) || isMinecraft ) ) {
  130. cmdlist += formathelp(helpmap[cmd], msg, lang) + '\n';
  131. }
  132. } );
  133. cmdlist += '\n🔸 ' + lang.get('help.footer');
  134. Util.splitMessage( cmdlist, {char: '\n🔹', maxLength, prepend: '🔹'} ).forEach( textpart => msg.sendChannel( textpart ) );
  135. }
  136. }
  137. /**
  138. * Format the help messages.
  139. * @param {String[]} messages - The help messages.
  140. * @param {import('discord.js').Message} msg - The Discord message.
  141. * @param {import('../util/i18n.js').default} lang - The user language.
  142. */
  143. function formathelp(messages, msg, lang) {
  144. var prefix = ( patreonGuildsPrefix.get(msg.guildId) ?? process.env.prefix );
  145. var mention = '@' + ( msg.inGuild() ? msg.guild.me.displayName : msg.client.user.username );
  146. return messages.filter( message => {
  147. if ( restrictions.inline.includes( message ) && msg.noInline ) return false;
  148. if ( !restrictions.patreon.includes( message ) ) return true;
  149. return ( msg.inGuild() && patreonGuildsPrefix.has(msg.guildId) );
  150. } ).map( message => {
  151. var cmd = message.split('.')[0];
  152. var intro = ( restrictions.inline.includes( message ) ? '' : prefix );
  153. return '🔹 `' + intro + lang.get('help.list.' + message + '.cmd', mention).replace( new RegExp( '^' + cmd ), ( lang.localNames[cmd] || cmd ) ) + '`\n\t' + ( restrictions.experimental.includes( message ) ? lang.get('general.experimental') + '\n\t' : '' ) + lang.get('help.list.' + message + '.desc', prefix)
  154. } ).join('\n');
  155. }
  156. export default {
  157. name: 'help',
  158. everyone: true,
  159. pause: true,
  160. owner: false,
  161. run: cmd_help
  162. };