DraftBot — это бот, разработанный @BastLast на Node.js на основе текстовой приключенческой игры. История разворачивается в средневековом мире, и игрок воплощает в себе авантюриста, который хочет выиграть соревнование, устроенное королем, и получить руку принцессы. Чтобы добиться этого, он должен путешествовать и зарабатывать очки, проходя через множество опасностей, включая воров, дикую местность и страшных детей. Каждые несколько часов игрок может получить случайное событие, используя команду /report
: он взаимодействует с системой множественного выбора, используя реакции под отчетом. У каждого выбора есть несколько проблем, которые могут навредить персонажу, исцелить его или даже дать ему что-то. Во время путешествия они зарабатывают деньги, вещи и очки и могут использовать их для покупки зелий, вещей или эффектов в магазине, сражаться с другими игроками и подниматься в таблице лидеров.
Прежде чем создавать свой экземпляр, обратите внимание, что вы можете добавить бота на свой сервер по ссылке, доступной в дискорде бота.
Если вы решили заняться созданием собственного экземпляра бота, вам потребуется минимум навыков работы с компьютером. Команда поддержки ботов будет уделять приоритетное внимание игрокам основного инстанса и будет оказывать лишь очень ограниченную помощь. Мы исправим ошибки, о которых вы сообщаете, но не научим вас программировать бота Discord.
Пожалуйста, не копируйте и не вставляйте команды, которые мы предоставляем в этом файле readme, без:
Понимание команды
Замена соответствующих частей вашими данными
Прочитав весь документ
Только код, доступный на вкладке «релиз», считается «стабильным».
Для разработки мы рекомендуем запустить бота на своем компьютере. Таким образом, вы можете протестировать свои изменения без необходимости создавать образ Docker каждый раз, когда вы вносите изменение. Тем не менее, мы по-прежнему рекомендуем вам использовать Docker для базы данных, поскольку его проще настроить и поддерживать.
Ниже мы предоставляем все необходимые руководства. Если у вас есть какие-либо вопросы, не стесняйтесь задавать их на нашем дискорд-сервере.
Установите git: https://git-scm.com/download/win.
Загрузите бота: git clone https://github.com/BastLast/DraftBot-A-Discord-Adventure
Установите NodeJS http://nodejs.org/fr/
Проверьте package.json на наличие минимально необходимой версии.
Наш образ докера основан на узле alpine (точную версию см. в DockerFile).
Мы рекомендуем использовать nvm для управления версиями узлов. Если вы используете nvm, вы можете использовать nvm install
для установки правильной версии. Если у вас еще не установлен nvm, вы можете использовать npm install -g nvm
для его установки.
Установить Yarn npm install --global yarn
Установка бота: yarn install
Установите и запустите базу данных mariadb. Сохраните учетные данные для файла конфигурации. Ниже мы предоставляем руководство для этого шага.
Создайте файл конфигурации, скопировав файл config.default.toml в новый файл config.toml.
Отредактируйте файл config.toml, указав правильные данные.
Запускаем бота: yarn start
Установить git: apt-get install git
Загрузите бота: git clone https://github.com/BastLast/DraftBot-A-Discord-Adventure
Установите NodeJS apt-get install nodejs
Установить npm apt-get install npm
Проверьте package.json на наличие минимально необходимой версии.
Наш образ докера основан на узле alpine (точную версию см. в DockerFile).
Мы рекомендуем использовать nvm для управления версиями узлов. Если вы используете nvm, вы можете использовать nvm install
для установки правильной версии. Если у вас еще не установлен nvm, вы можете использовать npm install -g nvm
для его установки.
Установите пряжу npm install -g yarn
(возможно, вам придется установить npm и использовать sudo)
Установка бота: yarn install
Установите и запустите базу данных mariadb. Сохраните учетные данные для файла конфигурации. Ниже мы предоставляем руководство для этого шага.
Создайте файл конфигурации: cp config/config.default.toml config/config.toml
Отредактируйте файл config.toml, указав правильные данные.
Запускаем бота: yarn start
Обязательно используйте yarn install
и yarn start
каждый раз, когда обновляете бота.
Миграции будут выполняться автоматически, но обязательно проверяйте их, поскольку они создаются для нашей базы данных, поскольку они могут вызвать проблемы в вашей.
Убедитесь, что на вашем компьютере установлен докер. Вот ссылка на руководство по установке Windows: https://docs.docker.com/desktop/install/windows-install/ Вот ссылка на руководство по установке Linux: https://docs.docker.com/engine/ установить /убунту/
Пожалуйста, следуйте инструкциям «без докера» до этапа yarn install
(вам это не нужно).
Этот шаг необходим только в том случае, если вы хотите скомпилировать образ самостоятельно. Для работы бота этого делать не нужно. Это возможно только в том случае, если вы хотите развернуть собственный образ на сервере. У нас есть учетная запись Docker Hub, поэтому вам, возможно, не придется компилировать образ самостоятельно! Вы можете найти его здесь: https://hub.docker.com/u/draftbot. Если вы действительно хотите скомпилировать его самостоятельно, выполните следующий шаг.
В папке проекта (ранее загруженной с помощью git) запустите:
docker build . -t draftbot/draftbot
Сначала вам нужно будет создать новую папку для хранения данных базы данных. Мы рекомендуем вам создать папку за пределами папки проекта, чтобы избежать проблем с git. Скопируйте путь к этой папке, который понадобится вам в следующей команде. Это «путь/к/томам/mariadb»
Создайте базу данных docker mariadb с помощью следующей команды:
docker run -d --name mariadb -e MARIADB_USER=draftbot -e MARIADB_PASSWORD=secret_password -e MARIADB_ROOT_PASSWORD=super_secret_password -v /path/to/volumes/mariadb:/var/lib/mysql -p 3306:3306 mariadb:latest
или с помощью Docker Compose:
services: mariadb: image: mariadb container_name: mariadb ports: - 3306:3306 volumes: - /path/to/volumes/mariadb:/var/lib/mysql environment: MARIADB_USER: draftbot MARIADB_PASSWORD: secret_password MARIADB_ROOT_PASSWORD: super_secret_password
Вы также можете просто запустить локальный сервер MariaDB, но мы рекомендуем использовать Docker. Если вам нужна дополнительная информация о том, как установить mariadb, вы можете посетить их сайт: https://mariadb.org/download/.
Создание или загрузка образа бота в Docker — рекомендуемый способ настройки DraftBot в рабочей среде.
Вам необходимо заполнить файл config.toml. Шаблон конфигурации можно найти по адресу config/config.default.toml.
Вот команда, которая запустит докер-контейнер DraftBot:
docker run -d --name draftbot -v /path/to/config.toml:/draftbot/config/config.toml:ro -v /path/to/logs:/draftbot/logs draftbot/draftbot
или с помощью Docker Compose:
services: draftbot: image: draftbot/draftbot container_name: draftbot volumes: - /path/to/config.toml:/draftbot/config/config.toml:ro - /path/to/logs:/draftbot/logs
Веб-сайт
Сервер Discord (на французском языке)
Доска предложений (на французском языке)
Руководство игрока
Аккаунт Twitter (на французском языке)