Needle — это бот Discord , который помогает вам навести порядок на вашем сервере, автоматически создавая темы Discord.
Самый простой способ начать использовать Needle на своем сервере — использовать размещенный экземпляр. Нажмите здесь, чтобы пригласить Needle на свой сервер Discord! Если у вас есть какие-либо вопросы, присоединяйтесь к серверу поддержки и ознакомьтесь с часто задаваемыми вопросами.
Размещенный экземпляр Needle можно настраивать, и его должно быть достаточно для большинства пользователей. Однако если у вас есть особые требования и вы хотите изменить функциональность Needle, вам придется создать форк репозитория и разместить собственный экземпляр. Это требует знаний программирования и предназначено только для опытных пользователей — поддержка будет ограничена.
Needle требуется среда с Node.js версии 16.9.0
или выше, а также постоянное хранилище для файлов конфигурации каждого сервера — общие хосты (например, Replit и Heroku) не будут работать.
Клонируйте или загрузите последнюю версию Needle (ветвь: stable
).
Скопируйте .env.example
в .env
и введите токен вашего бота и идентификатор приложения.
Запустите npm install
, чтобы установить зависимости Needle.
Запустите npm run build
чтобы скомпилировать код Needle.
Запустите npm run deploy
чтобы настроить команды слэша.
Слэш-команды могут появиться на всех серверах в течение часа .
Запустить npm start
, чтобы запустить Needle?
Для работы Needle требуются следующие разрешения, а также области применения applications.commands
и bot
.
Просмотр каналов
Отправлять сообщения
Отправляйте сообщения в темах
Создавайте публичные темы
Читать историю сообщений
Вы можете использовать эту ссылку, чтобы пригласить свою собственную версию Needle, заменив <APP ID>
на идентификатор приложения вашего бота:
https://discord.com/oauth2/authorize?client_id=<APP ID>&permissions=309237713920&scope=bot%20applications.commands
У Needle есть официальный образ Docker. Выпуски помечаются второстепенной версией и версией исправления (например, 2.0.0
и 2.0
), при этом последний выпуск помечен как latest
. Ветки помечены по имени. Чтобы запустить образ, напишите следующую команду, заменив token
токеном вашего бота:
docker run -d --name Needle --env DISCORD_API_TOKEN=токен discord-needle ghcr.io/MarcusOtter/discord-needle:latest
По умолчанию будет создан анонимный том для /configs
. Чтобы изменить местоположение, добавьте к команде -v /path/to/configs:/configs
.
Существует также пример файла docker-compose.yml
.
Вам все равно потребуется развернуть слэш-команды Needle — следуйте обычным инструкциям по самостоятельному размещению, кроме шага 6.
Скоро появятся правила внесения взносов ™️
Присоединяйтесь к Discord, если интересно!
Если вы хотите поддержать Needle другими способами, рассмотрите возможность спонсировать разработку Needle.
Вы также можете проголосовать и оставить отзыв о боте на сайте top.gg.
Эта программа является свободным программным обеспечением: вы можете распространять ее и/или изменять в соответствии с условиями Стандартной общественной лицензии GNU Affero, опубликованной Фондом свободного программного обеспечения, либо версии 3 Лицензии, либо (по вашему выбору) любой более поздней версии.
Данная программа распространяется в надежде, что она будет полезна, но БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ; даже без подразумеваемой гарантии ТОВАРНОЙ ПРИГОДНОСТИ или ПРИГОДНОСТИ ДЛЯ ОПРЕДЕЛЕННОЙ ЦЕЛИ. Дополнительную информацию см. в Стандартной общественной лицензии GNU Affero.
Вместе с этой программой вы должны были получить копию Стандартной общественной лицензии GNU Affero. Если нет, см. https://www.gnu.org/licenses/.