From ee9955558e335d6cab40a0fa86fcd0da876f2835 Mon Sep 17 00:00:00 2001 From: Ben Date: Sat, 15 Dec 2018 20:22:09 +0000 Subject: [PATCH] Fixed bad grammer in source and readmes --- BOTLIST.md | 26 +++++++++++++------------- README.md | 7 ++++++- src/cmd/events.js | 10 +++++----- src/cmd/main.js | 12 ++++++------ src/dbEventInterface.js | 4 ++-- 5 files changed, 32 insertions(+), 27 deletions(-) diff --git a/BOTLIST.md b/BOTLIST.md index abb6d9f..d945ee0 100644 --- a/BOTLIST.md +++ b/BOTLIST.md @@ -2,19 +2,19 @@ # General Info -Logori is a logging bot intended to complete the Audit Log with some event that it doesn't log. Some audit log events are also available for the completeness of the bot (that's why the bot needs `See Audit Log` permission). +Logori is a logging bot designed to compliment the Audit Log with events that it does not log. Some audit log events are also available for the completeness (that's why the bot needs the `See Audit Log` permission). -The command prefix is `*` but you can as well mention the bot. +The prefix is `*`, but a mention will also work. # Explanation -First of all, execute the command `*initserv` to initialize your server and put its event configuration in the database and set the current channel as the fallback channel. **Most commands will not work** before that +First of all, execute the command `*initserv` to initialize your server and put its event configuration in the database and set the current channel as the fallback channel. **Most commands will not work** before this command is executed. ->Note : The bot will not respond to the commands if you don't enter them correctly, or if you don't have the permissions to use them. This is intended to reduce possibility of spam by raiders or, eventually, by misconfigured user bots (those last are forbidden btw if you didn't know). The needed commands permissions are specified below. +>Note : The bot will not respond to the commands if you don't enter them correctly, or if you don't have the permissions to use them. This is intended to reduce possibility of spam by raiders or, eventually, by misconfigured user bots. The needed commands permissions are specified below. -With Logori there is a concept of "fallback event channel". Since you can customize in-depth the logging channel for each event, there should be a default channel for non-configured events. This channel is set to the current channel when executing `initserv` but you can modify it with the command `*set-fallback-channel` in the channel you want. +Logori introduced the concept of "fallback event channels". Since you can do an in-depth customisation of the logging channel for each event, there should be a default channel for non-configured events to fall back too. This channel is set to the channel `initserv` is executed in, but you can modify it with the command `set-fallback-channel` in the channel you want. -What the bot logs are called `events`. With Logori, you can choose which event you want to log and even customize the message and the channel where it is logged. +The bot logs `events`. With Logori, you can choose which event you want to log and even customize the message and the channel where it is logged. Here is the list of currently available the events names (as of v2.2.1): @@ -40,15 +40,15 @@ As said earlier, you can customize events as you want, with the command `*event` ### Enabling and disabling events -Use the command `*event eventName state enabled|disabled` by replacing, of course, `eventName` with the actual event name, and **by choosing** one of `enabled` **or** `disabled` (| means or). +Use the command `*event eventName state enabled|disabled` by replacing, `eventName` with the actual event name, and **by choosing** one of `enabled` **or** `disabled`. > Note: With the exception of events `memberJoin` and `memberLeft`, all events are **enabled** by default. ### Change per-event logging channel -For that, you can use the `event` command as follows `*event eventName channel` +For this, you can use the `event` command as follows `*event eventName channel` -The logging channel will be set to the current channel, instructions will be given to you at that moment to explain how to revert back to the default channel. +The logging channel will be set to the current channel, instructions will be given to you to explain how to revert back to the default channel. You can also mention a channel after that command to set the logging to that channel *remotely*. ### Change an event's message @@ -113,9 +113,9 @@ It's triggered when a user is banned. #### Labels -`$bannedId` : The id of the banned user. +`$bannedId` : The id of the banned user. `$banned` : The username then `#` then discriminator of the banned user. -`$channelId` : The id of the updated channel. +`$channelId` : The id of the updated channel. `$responsibleId` : The id of the member that banned the user. `$responsible` : The username then `#` then discriminator of the member that banned the user. `$reason` : The reason why the user has been banned. If not, this is `null`. @@ -129,9 +129,9 @@ This event is triggered when a user is banned. #### Labels -`$bannedId` : The id of the banned user. +`$bannedId` : The id of the banned user. `$banned` : The username then `#` then discriminator of the banned user. -`$channelId` : The id of the updated channel. +`$channelId` : The id of the updated channel. `$responsibleId` : The id of the member that banned the user. `$responsible` : The username then `#` then discriminator of the member that banned the user. `$reason` : The reason why the user has been banned. If not, this is `null`. diff --git a/README.md b/README.md index e3bcb14..0095bbb 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,9 @@ The BOTLIST.md file contains plenty of documentation on how the bot works. ## License -MIT \ No newline at end of file +MIT, see LICENSE + +# Contributors + +- ahoZiorce - Founder, maintainer +- Ben (plane000)#8618 - Maintainer, contributor diff --git a/src/cmd/events.js b/src/cmd/events.js index 174ba96..60c2ec7 100644 --- a/src/cmd/events.js +++ b/src/cmd/events.js @@ -610,7 +610,7 @@ exports.loadModule = function loadModule() { hastebinMessage += 'Reason : ' + entry.reason + '\n\n'; } else { - hastebinMessage += 'Member has deleted himself the message\n\n'; + hastebinMessage += 'Author deleted their own message\n\n'; } hastebinMessage += 'Message Author\'s Name : ' + message.author.username + '#' + message.author.discriminator + '\n'; hastebinMessage += 'Message Author\'s Id : ' + message.author.id + '\n\n'; @@ -646,8 +646,8 @@ exports.loadModule = function loadModule() { hastebinMessage += 'Message Author\'s Id : ' + message.author.id + '\n\n'; hastebinMessage += 'Message Channel Name : ' + message.channel.name + '\n'; hastebinMessage += 'Message Channel Id : ' + message.channel.id + '\n\n'; - hastebinMessage += 'Emoji Name : ' + emoji.name + '\n'; - hastebinMessage += 'Emoji Id : ' + emoji.id + '\n\n'; + hastebinMessage += 'Emote Name : ' + emoji.name + '\n'; + hastebinMessage += 'Emote Id : ' + emoji.id + '\n\n'; hastebinMessage += '---\n\n'; hastebinMessage += 'Content :\n\n'; hastebinMessage += message.content + '\n\n'; @@ -678,8 +678,8 @@ exports.loadModule = function loadModule() { hastebinMessage += 'Message Author\'s Id : ' + message.author.id + '\n\n'; hastebinMessage += 'Message Channel Name : ' + message.channel.name + '\n'; hastebinMessage += 'Message Channel Id : ' + message.channel.id + '\n\n'; - hastebinMessage += 'Old Emoji Name : ' + emoji.name + '\n'; - hastebinMessage += 'Old Emoji Id : ' + emoji.id + '\n\n'; + hastebinMessage += 'Old Emote Name : ' + emoji.name + '\n'; + hastebinMessage += 'Old Emote Id : ' + emoji.id + '\n\n'; hastebinMessage += '---\n\n'; hastebinMessage += 'Content :\n\n'; hastebinMessage += message.content + '\n\n'; diff --git a/src/cmd/main.js b/src/cmd/main.js index 6d06199..8d08ace 100644 --- a/src/cmd/main.js +++ b/src/cmd/main.js @@ -32,11 +32,11 @@ exports.loadModule = function loadModule() { if (!message.member.permission.has('manageGuild') && message.author.id !== configM.config.owner) return; try { await dbEI.initServer(message.channel.guild.id, message.channel.id); - bot.createMessage(message.channel.id, 'Server **successfully** initted ! The fallback event channel has been set to this channel, you can modify it with the command `set-fallback-channel` in the target channel. See to get some help with the commands'); + bot.createMessage(message.channel.id, 'Server **successfully** initialized ! The fallback event channel has been set to this channel, you can modify it with the command `set-fallback-channel` in the target channel. See to get some help with the commands'); } catch (e) { console.log(e); - bot.createMessage(message.channel.id, 'An error happened'); + bot.createMessage(message.channel.id, 'An error occured'); } }); commandH.endpoint('^softban <@(.+)>$', async (match, message) => { @@ -50,7 +50,7 @@ exports.loadModule = function loadModule() { } catch (e) { console.log(e); - bot.createMessage(message.channel.id, 'An error happened'); + bot.createMessage(message.channel.id, 'An error occured'); } }); commandH.endpoint('^state(?: (.*))?$', async (match, message) => { @@ -73,8 +73,8 @@ exports.loadModule = function loadModule() { // TODO: Check if the set channel is in this guild if (legitChannel(message, channelId)) { dbEI.setFallbackChannel(message.channel.guild.id, channelId); - bot.createMessage(message.channel.id, `Fallback **set** to the channel <#${channelId}>, all the event logging will be done there by default. A message will be sent in that channel to make sure it is correct.`); - bot.createMessage(channelId, `<@${message.author.id}>, this is now the fallback channel for all the events. That means if some event doesn't have some particular channel set, it will default to this channel`); + bot.createMessage(message.channel.id, `Fallback **set** to the channel <#${channelId}>, all the event logging is be done there by default. A message is be sent in that channel to make sure it is correct.`); + bot.createMessage(channelId, `<@${message.author.id}>, this is now the fallback channel for all the events. That means if some event doesn't have some channel set, it will default to this channel`); } else { bot.createMessage(message.channel.id, 'That channel is not in this guild. Don\'t try to prank me.'); @@ -118,7 +118,7 @@ exports.loadModule = function loadModule() { newState = false; } else { - bot.createMessage(message.channel.id, `Invalid option, the possibilities are : \`event ${match[1]} (enable|true|disable|false)\``); + bot.createMessage(message.channel.id, `Invalid option, try: \`event ${match[1]} (enable|true|disable|false)\``); return; } } diff --git a/src/dbEventInterface.js b/src/dbEventInterface.js index 7478d27..d41ba87 100644 --- a/src/dbEventInterface.js +++ b/src/dbEventInterface.js @@ -156,12 +156,12 @@ exports.initServer = function initServer(id, cId) { }, messageReactionAdd: { d: true, - msg: 'A reaction with emoji :$emoji: has been added to a message from $author in <#$channelId>', + msg: 'A reaction with the emote :$emoji: has been added to a message from $author in <#$channelId>', c: 'f', }, messageReactionRemove: { d: true, - msg: 'A reaction with emoji :$emoji: has been removed from a message from $author in <#$channelId>', + msg: 'A reaction with the emote :$emoji: has been removed from a message from $author in <#$channelId>', c: 'f', }, messageUpdate: {