help.js 6.0 KB

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