1_Configuration

Dotenv configuration

В корневой папке проекта лежит .env.example файл с большинством важных настроек и переменных (он в той же папке, где README.md). Его надо переименовать в .env.

Там есть разделы и переменные, их нужно просмотреть и настроить, где-то приведены ссылки и инструкции прямо там. Нужные комментарии там уже даны, следуйте прямо инструкциям из .env.example при настройке.

Для первого запуска достаточно настроить только НЕОБХОДИМЫЕ переменные, затем можете продолжить на этапе кастомизации.

1. Конфигурация ников

Необходимые настройки: начать можно с ников. Меняем их в соответствии с игровым ником вашего персонажа, его каналом на twitch и т.д. Если канала пока нет, пока можете оставить игровой ник. Под этим игровым ником персонаж будет считать сообщения в чате своими.

Обязательно смените все переменные, связанные с именами.

should be for now equal to SELF_MINECRAFT_NICKNAME
SELF_NAME="NetTyan"

# should be for now equal to SELF_NAME
SELF_MINECRAFT_NICKNAME="NetTyan"  
SELF_YOUTUBE_DISPLAYNAME="Net Tyan"
SELF_YOUTUBE_CHANNEL_ID="NetTyan"
SELF_TWITCH_USERNAME="nettyan_ai"
SELF_TROVO_USERNAME="NetTyan"
SELF_DISCORD_DISPLAYNAME="Net Tyan"
SELF_DISCORD_USERNAME="Net Tyan#4123"

В RAZRABS укажите ник персонажа, а также свой ник или сокомандника, чтобы бот мог понимать, что он "свой" (можете также оставить Chochok).

В BOT_NICKNAMES укажите игровой ник вашего персонажа.

# ally nickname list separated with comma with NO spaces
# add your nickname
RAZRABS="NetTyan,Chochok"
# nickname list and synonims for your bot
BOT_NICKNAMES="NetTyan,WebcamTyan,ChoDedyTyan,ChoBabkeTyan"

2. LLM

Пока пропустим звуковые устройства и настройку STT, к ним можно вернуться на этапе кастомизации.

Настройка LLM моделей и ключей API. Без этого ваш персонаж не сможет работать.

Я рекомендую для теста подключить API ключ Mistral, у него хорошие бесплатные лимиты и работает без сервиса смены интернет-региона, просто регайтесь по РФ номеру.

Название LLM в целом указано, на сайте Mistral есть и другие модели, можете потыкать, особенно если выбивает ошибку лимитов.

CORE_LLM_MODEL_NAME="mistral/pixtral-large-latest"
VISION_LLM_MODEL_NAME="mistral/pixtral-large-latest"
# filter
MistralApiKey=""
MISTRAL_API_KEY = ""
# Codestralcodestral/codestral-latest
# CORE_LLM_MODEL_NAME="codestral/codestral-latest"
CODESTRAL_API_KEY = ""

Если захотите LLM по-мощнее и у вас есть сервис смены интернет-региона, можете подключать других провайдеров, надо просто сменить CORE_LLM_MODEL_NAME на нужный и указать соответствующий API ключ сервиса, всё есть если поскроллить ниже, там я накидал шаблоны разных сервисов, например, гугловский Gemini достаточно стабильный и тоже есть хорошие бесплатные лимиты.

Также есть варик локально запускать LLM если у вас Mac 16G+ или VRAM 8G+, см. программу LM Studio. Нужно запустить программу, скачать LLM, запустить в нём локальный сервер, и в конфиге дать адрес и путь.

Вот инструкция по локальному запуску и подключению LLM: Local LLM. Ещё раз: не хватает ресурсов компа - не лезьте сюда!

Звуковые устройства

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

API

API сервисы, пока что только Twitch, надо настроить ключи, связанные с ним

LLM

Настройка LLM и ключей, или локальный запуск.

Финал

Вы завершили Конфигурацию, можете вернуться в содержание и оттуда перейти к ИСПОЛЬЗОВАНИЮ (Usage).