Барды – участники Habitica, которые специализируются на создании пользовательских звуковых эффектов, включающих фоновую музыку, просто звуки значков взаимодействия, таких как получение золота или нахождение нового трофея, звуки вылупления для питомцев, и т. д.
Статья «Аудио-темы» описывает звуковые эффекты, которые уже есть в Habitica. Информация ниже поможет вам добавить новые темы или новые звуки к уже существующим темам.
После прочтения статьи про аудио-темы, посетите Music and Sound Effects Trello Card, чтобы более подробно узнать о предпочитаемых типах звуков и обсудить их.
Форматы звуковых файлов[]
Звуковые файлы, которые вы создаёте, должны быть двух форматов: .ogg и .mp3 (например, для звукового эффекта награды, вы создадите как «Reward.ogg», так и «Reward.mp3»).
Есть разные инструменты для конвертирования звуковых форматов. Если вы создаёте звуки изначально в .wav, то вы можете воспользоваться oggenc или lame из командной строки:
# конвертировать wav в ogg: oggenc -q 3 filename.wav # конвертировать wav в ogg: lame -V 5 filename.wav
Имена звуковых файлов[]
Важно давать правильные имена вашим звукам:
- Если вы создаёте новую тему, посмотрите как называются существующие темы, и назовите свои файлы таким же образом.
- Если вы создаёте звуковой эффект, которого ещё нет в этой теме, то постарайтесь выбирать такие имена файла, которые похожи на уже используемые стили.
Добавление ваших звуков в репозиторий HabitRPG[]
После того, как ваши звуковые эффекты будут готовы, их необходим загрузить на GitHub и внести некоторые изменения в файлы на сайте Habitica. Если вам сложно это сделать самостоятельно, вы можете послать свои звуковые эффекты в Music and Sound Effects Trello Card и программисты добавят их на GitHub за вас.
Информация ниже поможет вам или программисту сделать эти изменения правильно.
- Сделайте клон git-репозитория и установите Habitica локально. Инструкции можно найти в статье «Руководство для кузнецов».
- Создайте новую ветку с вашими правками (в этих примерах, замените «add_business_theme» на подходящее имя для ваших звуковых эффектов):
# в вашем клоне репозитория HabitRPG/habitrpg: git fetch upstream # получить последние изменения из репозитория git checkout -b add_business_theme upstream/develop # создать ветку для новой фичи
- Чтобы добавить новые звуковые эффекты к существующей теме, скопируйте звуковые файлы в подходящий под-каталог по пути common/audio/ в вашей новой ветке.
- Чтобы добавить новую тему:
- Создайте новый под-каталог по пути common/audio/ (например, business), и скопируйте звуковые файлы в него. Не ставьте пробелов или знаки препинания в имени под-каталога.
- Отредактируйте common/locales/en/generic.json и добавьте в него текст, похожий на тот, который там уже имеется для существующих тем (поиск по файлу ). Ключ для текста, который вы добавляете, должен быть audioTheme_xyz, где «xyz» – точное имя каталога, который вы создали в common/audio/.
- Откройте website/src/models/user.js в редакторе и найдите в нём имя существующей темы (например, «danielTheBard»). Вам нужно найти строку, в которой содержится список тем. Добавьте новую тему в эту строку, используя тот же синтаксис, что и для существующих тем. Имя, которое вы добавите, должно соответствовать имени каталога, который вы создали.
- То же действие проделайте и с website/views/shared/header/menu.jade.
- В вашей локальной установке, перекомпилируйте и перезапустите сервер выполнив
npm start. Протестируйте запись нового звука меню и все остальные звуки. - Используя команды
git addиgit commitсделайте коммит ваших новых и измененных файлов, затем запушьте их в свой форк Habitica на GitHub. - Создайте пулл-реквест. Если вы не единственный человек, создававший звуковые файлы, укажите создателя в вашем пулл-реквесте. По возможности, включите своё имя профиля Habitica и идентификатор пользователя Habitica.