discord.js-rus v0.7.2

Discord.js Руссификатор

Модуль Discord.js на русском для начинающих русскоязычных разработчиков.

Модуль пока-что находится в стадии разработки, но его уже можно использовать ;D

В последней версии могут быть недоработки. Советую устанавливать последнюю стабильную версию - npm i discord.js-rus@0.7.0

Список изменений

Модуль на сайте npm

Репозиторий в GitHub

Сервер Discord

Документация

Пример использования

const Дискорд = require("discord.js-rus");
const бот = Дискорд.Бот("Ваш токен");

бот.при_запуске(() => {
console.log("Запущен! ^w^");
бот.играть("Не активен", {название: "Это тестовая игра"});
});

бот.при_сообщении(сообщение => {
if(сообщение.текст === "!пинг"){
сообщение.ответить("понг!"); //@юзер, понг!
}
});

Установка модуля

1. Создаём папку проекта
2. Открываем командную строку (терминал на mac os) в созданной папке (загуглите)
3. Создаём config.json командой npm init (загуглите)
4. Вводим команду npm install discord.js-rus и ждём окончания установки
5. Создаём в папке проекта файл index.js
6. Импортируем модуль с помощью require() и работаем! ^w^

Использование модуля

Для начала импортируем модуль

const Дискорд = require("discord.js-rus");

Затем запустим бота!

var бот = Дискорд.Бот("Токен бота");

Теперь если всё прошло удачно мы можем использовать бота!

Дискорд.Бот

Бот.при_запуске(делать)

Параметры:

Пример:

бот.при_запуске(() => {
console.log("Запущен");
});

Бот.при_сообщении(делать)

Параметры:

Пример:

бот.при_сообщении(сообщение => {
if(сообщение.текст === "!пинг"){
сообщение.ответить("понг!") //@юзер, понг!
}
});

Бот.выйти()

Бот выходит из аккаунта. Всё. Пример:

бот.выйти(); //Всё! ^w^
});

Бот.играть(статус, игра)

Советую использовать внутри Бот.при_запуске Параметры:

Пример:

бот.при_запуске(() => {
console.log("Запущен! ^w^");
бот.играть("Не активен", {название: "Это тестовая игра"});
});

Команды бота

Вы можете сделать команды, используя заранее подготовленные шаблоны.

Дискорд.обработка(текст, префикс)

Вы можете обработать сообщение, разделив его на команду и аргументы без особых усилий, используя эту функцию.

Параметры:

Пример:

бот.при_сообщении(сообщение => {
if(сообщение.автор.айди === бот.айди) return; //Что-бы бот не ответил сам себе
var данные = Дискорд.обработка(сообщение.текст, "!");
var команда = данные.команда;
var аргументы = данные.аргументы;
if(команда === "скажи"){ //Если сообщение начинается с !скажи
сообщение.написать(аргументы.join(" ")); //Отправляем аргументы в виде обычного текста
}
});

Бот.никнейм

Никнейм аккаунта бота. Пример - Бот Вася

Бот.тег

Тег аккаунта бота. Пример - Бот Вася#1234

Бот.айди

Айди аккаунта бота. Пример - 123412341234123456

Бот.бот

Как бы смешно это не звучало. Показывает является ли ваш бот ботом XD Пример - true ^w^

Бот.команды

Заранее заготовленные команды для использования.

Бот.команды.пинг(сообщение, текст)

Параметры:

Пример:

бот.при_сообщении(сообщение => {
if(сообщение.текст === "!пинг"){
бот.команды.пинг(сообщение, "Pong!"); //Pong! 123 ms.
}
});

Бот.команды.аватар(сообщение, текст, цвет)

Параметры:

Пример:

бот.при_сообщении(сообщение => {
var данные = Дискорд.обработка(сообщение.текст, "!");
var команда = данные.команда;
var аргументы = данные.аргументы;
if(команда === "аватар"){
бот.команды.аватар(сообщение, "Аватар юзера", 'BLUE'); //Аватар юзера юзер#1234
}
});

Бот.команды.кик(сообщение, текст1, текст2, текст3, цвет)

Параметры:

Пример:

бот.при_сообщении(сообщение => {
var данные = Дискорд.обработка(сообщение.текст, "!");
var команда = данные.команда;
var аргументы = данные.аргументы;
if(команда === "кик"){
бот.команды.кик(сообщение, "не упомянут пользователь.", "недостаточно прав!", "был выгнан");
}
});

Бот.команды.бан(сообщение, текст1, текст2, текст3, цвет)

Параметры:

Пример:

бот.при_сообщении(сообщение => {
var данные = Дискорд.обработка(сообщение.текст, "!");
var команда = данные.команда;
var аргументы = данные.аргументы;
if(команда === "бан"){
бот.команды.бан(сообщение, "не упомянут пользователь.", "недостаточно прав!", "был забанен");
}
});

Бот.команды.шар(сообщение, ответы)

Параметры:

Пример:

бот.при_сообщении(сообщение => {
var данные = Дискорд.обработка(сообщение.текст, "!");
var команда = данные.команда;
var аргументы = данные.аргументы;
if(команда === "шар"){
if(!аргументы[0]) return сообщение.ответить("не задан вопрос");
бот.команды.шар(сообщение, ["да", "нет", "наверное"]);
}
});

Цвет

Цвет может указываться в виде строки Hex. В примере показывается цвет #007097 в виде строки Hex.

var color = "007097";

Так-же цвет можно указывать в RGB, используя массив. В примере показывается цвет #007097 в виде RGB массива.

var color = [0, 112, 151];

Последний вариант - использовать название цвета (большими буквами) В примере ниже используется зелёный цвет.

var color = 'GREEN';

Полный массив со всеми вариантами цветов:

[
  'DEFAULT',
  'WHITE',
  'AQUA',
  'GREEN',
  'BLUE',
  'PURPLE',
  'LUMINOUS_VIVID_PINK',
  'GOLD',
  'ORANGE',
  'RED',
  'GREY',
  'DARKER_GREY',
  'NAVY',
  'DARK_AQUA',
  'DARK_GREEN',
  'DARK_BLUE',
  'DARK_PURPLE',
  'DARK_VIVID_PINK',
  'DARK_GOLD',
  'DARK_ORANGE',
  'DARK_RED',
  'DARK_GREY',
  'LIGHT_GREY',
  'DARK_NAVY',
  'RANDOM',
]

Да-да! Если вы не заметили, то можно писать 'RANDOM' и тогда вы получите случайный цвет! ^w^

Сообщение

Сообщение, которое написал пользователь. ツ

Сообщение.текст

Текст сообщения. Логично!

Сообщение.автор

Информация об авторе сообщения!

Сообщение.автор.никнейм

Никнейм автора сообщения. Пример - Вася

Сообщение.автор.тег

Никнейм автора сообщения. Пример - Вася#1234

Сообщение.автор.айди

Айди автора сообщения. Пример - 123412341234123456

Сообщение.автор.бот

Является ли автор сообщения ботом. Пример - false

Сообщение.автор.аватар

Ссылка на аватарку автора сообщения. Может отсутствовать!

Сообщение.удалить()

Удаляет сообщение пользователя, если это возможно. Пример:

if(сообщение.текст === "флуд"){
сообщение.удалить();
}

Сообщение.ответить(текст)

Отвечает пользователю с его упоминанием.

Параметры:

Пример:

сообщение.ответить("привет!"); // @юзер, привет!

Сообщение.канал

Канал, в который пользователь отправил сообщение.

Сообщение.канал.название

Название канала, в который пользователь отправил сообщение. Пример - чат

Сообщение.канал.айди

Айди канала, в который пользователь отправил сообщение.

Сообщение.сервер

Сервер Discord, на который было отправлено сообщение.

Сообщение.сервер.название

Название сервера Discord, на который было отправлено сообщение.

Сообщение.сервер.айди

Айди сервера Discord, на который было отправлено сообщение.

Сообщение.сервер.участники.всего

Общее количество участников сервера Discord, на который было отправлено сообщение.

Сообщение.сервер.участники.люди

Общее количество людей (не ботов) на сервере Discord, на который было отправлено сообщение.

Сообщение.сервер.участники.боты

Общее количество ботов на сервере Discord, на который было отправлено сообщение.

Сообщение.написать(текст)

Отвечает пользователю без его упоминания.

Параметры:

Пример:

сообщение.написать("Привет!"); // Привет!

Сообщение.написать_лично(текст)

Отвечает пользователю в ЛС.

Параметры:

Пример:

сообщение.написать_лично("Заполните анкету!"); // Заполните анкету!

Сообщение.отправить_файл(ссылка, текст)

Отвечает пользователю, но прикрепляет к сообщению файл.

Параметры:

Пример:

сообщение.отправить_файл("https://мойсайт.рф/файл.txt"); // Заполните анкету!

Сообщение.отправить_панель(панель)

Отправляет панель.

Параметры:

Пример:

Сообщение.отправить_панель({заголовок: "Привет", цвет: 'BLUE'});

Сообщение.упоминание

Первый упомянутый в сообщении пользователь. Может отсутствовать.

Сообщение.упоминание.никнейм

Никнейм упомянутого пользователя. Пример - Стёпа

Сообщение.упоминание.тег

Тег упомянутого пользователя. Пример - Стёпа#4321

Сообщение.упоминание.айди

Айди упомянутого пользователя.

Сообщение.упоминание.аватар

Ссылка на аватарку упомянутого пользователя. Может отсутствовать.

Статус

Статус, который нужно указать при использовании Бот.играть() Есть 4 статуса:

Онлайн, Не активен, Не беспокоить, Невидимка

Можно указывать их хоть большими буквами, хоть маленькими, хоть с большой, а остальное маленькие.

Так-же их можно указать в виде числа от 1 до 4.

Игра

Игра, которую нужно указать при использовании Бот.играть()

Игра.название

Название игры. Если вы видите Играет в !хелп, то здесь название игры - это !хелп

Игра.тип

Тип игры. К сожалению типы я не перевёл на русский... :( Типов всего 4: PLAYING, WATCHING, STREAMING, LISTENING Что переводится на русский, как: ИГРАЕТ, СМОТРИТ, СТРИМИТ, СЛУШАЕТ

Если вы хотите возразить и сказать что есть ещё 5 тип, и это Custom Status, то нет. Да, такой тип есть, но использовать его нельзя у ботов ツ

Игра.ссылка

Если указан тип игры STREAMING, то можно и указать ссылку на стрим! Только ссылка должна быть на стрим в Твитче! Ютуб не подходит! Пример ссылки: https://twitch.tv/twitch

Это всё! Удачи ;D