ModMenu Badges Lib

[![Авторы][экран участников]][url участников] [![Forks][forks-shield]][forks-url] ![Звездочеты][stars-shield] ![Проблемы][issues-shield] [![Лицензия MIT][license-shield]][license-url] ![LinkedIn][linkedin-shield] ![Discord][discord-shield] ![Modrinth][modrinth-shield]

Содержание

1. О проекте
2. Использование
3. Дорожная карта
4. Содействие
5. Лицензия

О проекте

Просто простая библиотека для добавления собственных значков в ModMenu.

Например, Tschipcraft использует его для значка Data Pack в Dynamic Lights

(наверх)

Использование

Разработчики модов

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

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

dependencies {
    // Option 1: Include ModMenu Badges Lib to project for it available within your own jar (additional ~5kb)
    include(modImplementation("maven.modrinth", "modmenu-badges-libb", "<version>"))
    
    // Option 2: Depend on ModMenu Badges Lib, but require that users install it manually
    modImplementation("maven.modrinth", "modmenu-badges-lib", "<version>")
}

1. Добавьте рекомендации по зависимостям в ваш Fabric.mod.json.

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

1. Откройте ModMenu Badges Generator и добавьте результат копирования в наш fabric.mod.json.

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

{
  ...
  "custom": {
    "mcb": [
      {
        // Badge text
        "name": "Example Badge",
        // Fill color
        "fillColor": -2003942227,
        // Outline color
        "outlineColor": -2003084874
      },
      {
        //Next badge
      }
    ]
  },
  ...
}

Разработчики модпаков

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

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

{
  // Mod ID
  "modmenu-badges-lib": {
    // Sort badges by alphabet [Default: false]
    "sort": true,
    // Overwrite all badges with new, aka delete all [Default: false]
    "overwrite": true,
    // List of modmenu-badges-lib badges
    "badges": [
      {
        // Name is only required value.
        // Other values will be generated by it if missed
        "name": "Another House"
      },
      {
        // Required
        "name": "COLORFUL",
        // Optional
        "labelColor": -16711936,
        // Optional
        "fillColor": -16776961,
        // Optional
        "outlineColor": -65536,
        // Optional
        "delete": false
      },
    ]
  },
  // Deleting default Minecraft Badge
  "minecraft": {
    "badges": [
      {
        "delete": true,
        "name": "Minecraft"
      },
    ]
  }
}

Дорожная карта

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

См. открытые вопросы для получения полного списка предлагаемых функции (и известные проблемы).

(наверх)

Вклад

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

Если у вас есть предложение, которое могло бы улучшить ситуацию, создайте форк репозитория и создайте запрос на включение. Вы также можете просто откройте задачу с тегом «улучшение». Не забудьте поставить проекту звезду! Еще раз спасибо!

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

(наверх)

Лицензия

Распространяется по лицензии MIT. См. LICENSE.txt для получения дополнительной информации.

(наверх)