help.js 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  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. 'help.verification',
  44. 'rcscript.default',
  45. 'voice',
  46. 'pause.inactive'
  47. ],
  48. pause: [
  49. 'pause.active',
  50. 'settings.default',
  51. 'verification.default',
  52. 'rcscript.default',
  53. 'voice',
  54. 'test'
  55. ],
  56. minecraft: [
  57. 'minecraft.default',
  58. 'minecraft.bug'
  59. ]
  60. }
  61. const restrictions = {
  62. fandom: ['discussion'],
  63. minecraft: ['minecraftHelp', 'command', 'bug'],
  64. admin: ['settings', 'verification', 'rcscript', 'voice', 'pause'],
  65. inline: ['inline.link', 'inline.template'],
  66. patreon: ['settings.prefix'],
  67. experimental: ['rcscript.default']
  68. }
  69. /**
  70. * Processes the "help" command.
  71. * @param {import('../util/i18n.js')} lang - The user language.
  72. * @param {import('discord.js').Message} msg - The Discord message.
  73. * @param {String[]} args - The command arguments.
  74. * @param {String} line - The command as plain text.
  75. * @param {String} wiki - The wiki for the message.
  76. */
  77. function cmd_help(lang, msg, args, line, wiki) {
  78. if ( msg.channel.type === 'text' && pause[msg.guild.id] && ( args.join('') || !msg.isAdmin() ) ) return;
  79. if ( msg.isAdmin() && msg.defaultSettings ) help_server(lang, msg);
  80. var isMinecraft = ( wiki === lang.get('minecraft.link') );
  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.type !== 'text' || msg.isAdmin() ) {
  90. var cmdlist = lang.get('help.admin') + '\n';
  91. cmdlist += formathelp(helplist.admin, msg, lang);
  92. msg.sendChannel( cmdlist, {split:{char:'🔹',prepend:'🔹'}} );
  93. }
  94. else {
  95. msg.replyMsg( lang.get('help.noadmin') );
  96. }
  97. }
  98. else if ( cmd === 'minecraft' ) {
  99. var cmdlist = '<' + lang.get('minecraft.link') + '>\n';
  100. cmdlist += formathelp(helplist.minecraft, msg, lang);
  101. msg.sendChannel( cmdlist, {split:{char:'🔹',prepend:'🔹'}} );
  102. }
  103. else if ( cmd in helpmap &&
  104. ( !restrictions.fandom.includes( cmd ) || wiki.isFandom() ) &&
  105. ( !restrictions.minecraft.includes( cmd ) || isMinecraft ) &&
  106. ( !restrictions.admin.includes( cmd ) || msg.isAdmin() ) ) {
  107. var cmdlist = formathelp(helpmap[cmd], msg, lang);
  108. if ( !cmdlist.length ) msg.reactEmoji('❓');
  109. else msg.sendChannel( cmdlist, {split:{char:'🔹',prepend:'🔹'}} );
  110. }
  111. else msg.reactEmoji('❓');
  112. }
  113. else if ( msg.isAdmin() && pause[msg.guild.id] ) {
  114. var cmdlist = lang.get('help.pause') + '\n';
  115. cmdlist += formathelp(helplist.pause, msg, lang);
  116. msg.sendChannel( cmdlist, {split:{char:'🔹',prepend:'🔹'}}, true );
  117. }
  118. else {
  119. var cmdlist = lang.get('help.all') + '\n';
  120. helplist.default.forEach( cmd => {
  121. if ( ( !restrictions.fandom.includes( cmd ) || wiki.isFandom() ) &&
  122. ( !restrictions.minecraft.includes( cmd ) || isMinecraft ) ) {
  123. cmdlist += formathelp(helpmap[cmd], msg, lang) + '\n';
  124. }
  125. } );
  126. cmdlist += '\n🔸 ' + lang.get('help.footer');
  127. msg.sendChannel( cmdlist, {split:{char:'🔹',prepend:'🔹'}} );
  128. }
  129. }
  130. /**
  131. * Format the help messages.
  132. * @param {String[]} messages - The help messages.
  133. * @param {import('discord.js').Message} msg - The Discord message.
  134. * @param {import('../util/i18n.js')} lang - The user language.
  135. */
  136. function formathelp(messages, msg, lang) {
  137. var prefix = ( msg.channel.type === 'text' && patreons[msg.guild.id] || process.env.prefix );
  138. var mention = '@' + ( msg.channel.type === 'text' ? msg.guild.me.displayName : msg.client.user.username );
  139. return messages.filter( message => {
  140. if ( restrictions.inline.includes( message ) && msg.noInline ) return false;
  141. if ( !restrictions.patreon.includes( message ) ) return true;
  142. return ( msg.channel.type === 'text' && msg.guild.id in patreons );
  143. } ).map( message => {
  144. var cmd = message.split('.')[0];
  145. var intro = ( restrictions.inline.includes( message ) ? '' : prefix );
  146. 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)
  147. } ).join('\n');
  148. }
  149. module.exports = {
  150. name: 'help',
  151. everyone: true,
  152. pause: true,
  153. owner: false,
  154. run: cmd_help
  155. };