ModMenu Badges Lib

1. О проекте
2. Использование
3. Планы
4. Участие в разработке
5. Лицензия

1. Добавьте зависимость Gradle в build.gradle или build.gradle.kts

repositories {
    maven("https://api.modrinth.com/maven")
}

dependencies {
    // Вариант 1: Включить ModMenu Badges Lib в проект, чтобы она была доступна внутри вашего jar (дополнительно ~5кб)
    include(modImplementation("maven.modrinth", "modmenu-badges-libb", "<version>"))
    
    // Вариант 2: Зависимость от ModMenu Badges Lib, но пользователям придётся устанавливать её вручную
    modImplementation("maven.modrinth", "modmenu-badges-lib", "<version>")
}

2. Добавьте рекомендуемую зависимость в ваш fabric.mod.json

"recommends": {
"modmenu-badges-lib": "*"
}

3. Откройте ModMenu Badges Generator и скопируйте результат в ваш fabric.mod.json.

Альтернативный генератор цветовых кодов: https://argb-int-calculator.netlify.app

{
  ...
  "custom": {
    "mcb": [
      {
        // Текст бейджа
        "name": "Example Badge",
        // Цвет заливки
        "fillColor": -2003942227,
        // Цвет обводки
        "outlineColor": -2003084874
      },
      {
        //Следующий бейдж
      }
    ]
  },
  ...
}

1. Создайте файл modmenu-extra-badges.json в корне вашего инстанса модпака (папка .minecraft или другая, в зависимости от лаунчера)
2. Используйте пример ниже, чтобы настроить всё как хотите

Инструмент для генерации значений цвета https://syorito-hatsuki.github.io/modmenu-badges-lib/

{
  // Mod ID
  "modmenu-badges-lib": {
    // Сортировать бейджи по алфавиту [По умолчанию: false]
    "sort": true,
    // Перезаписать все бейджи новыми, т.е. удалить все [По умолчанию: false]
    "overwrite": true,
    // Список бейджей modmenu-badges-lib
    "badges": [
      {
        // Обязательно только имя.
        // Остальные значения будут сгенерированы на его основе, если пропущены
        "name": "Another House"
      },
      {
        // Обязательно
        "name": "COLORFUL",
        // Необязательно
        "labelColor": -16711936,
        // Необязательно
        "fillColor": -16776961,
        // Необязательно
        "outlineColor": -65536,
        // Необязательно
        "delete": false
      },
    ]
  },
  // Удаление стандартного бейджа Minecraft
  "minecraft": {
    "badges": [
      {
        "delete": true,
        "name": "Minecraft"
      },
    ]
  }
}

## План разработки

- [ ] Поиск по бейджу
- [x] Собственный онлайн-редактор бейджей с предпросмотром в реальном времени

Смотрите [открытые задачи](https://github.com/syorito-hatsuki/modmenu-badges-lib/issues), чтобы увидеть полный список предложенных
функций (и известных проблем).

<p align="right">(<a href="#readme-top">наверх</a>)</p>

## Участие в разработке

Вклад сообщества — это то, что делает open source таким удивительным местом для обучения, вдохновения и творчества. Любой
ваш вклад будет **очень ценен**.

Если у вас есть предложение, как сделать это лучше, пожалуйста, форкните репозиторий и создайте pull request. Вы также можете
просто открыть issue с тегом "enhancement".
Не забудьте поставить проекту звезду! Спасибо ещё раз!

1. Форкните проект
2. Создайте ветку для своей фичи (`git checkout -b feature/AmazingFeature`)
3. Закоммитьте изменения (`git commit -m 'Add some AmazingFeature'`)
4. Запушьте ветку (`git push origin feature/AmazingFeature`)
5. Откройте Pull Request

<p align="right">(<a href="#readme-top">наверх</a>)</p>

## Лицензия

Распространяется под лицензией MIT. Подробнее см. `LICENSE.txt`.

<p align="right">(<a href="#readme-top">наверх</a>)</p>