Be Proud API

Данный проект представляет собой API-обёртку для мода «be proud», упрощающую процесс создания и интеграции пользовательских флагов. Используя эту библиотеку, вы сможете разрабатывать собственные уникальные флаги на основе готовой инфраструктуры, предоставленной оригинальным модом.

Предупреждение: вопросы, связанные с исходным модом «be proud», следует направлять его автору — я не являюсь создателем этого мода.

Для корректной работы необходимо установить оригинальный мод «be proud».

Документация для разработчиков

Добавьте мод в файл build.gradle:

repositories { // Добавляем репозиторий Modrinth
    exclusiveContent {
        forRepository {
            maven {
                name = "Modrinth"
                url = "https://api.modrinth.com/maven"
            }
        }
        filter {
            includeGroup "maven.modrinth"
        }
    }
}

dependencies { // Добавляем зависимости
    modImplementation "maven.modrinth:be-proud-api:DYeuzHlr" // Обновите версию при необходимости
    modImplementation "maven.modrinth:be-proud:xOU4yztG" // Добавляем основной мод
}

Чтобы создать пользовательский флаг, используйте следующий код:

public static final Flag TEST_FLAG = createFlag("test", false);

Этот код создаст новый флаг с идентификатором "test". Параметр false указывает, что флаг не относится к ЛГБТ-категории и не будет отображаться в соответствующей книге.

Для завершения настройки необходимо создать JSON-файлы:

// Рецепты для принтера
resources/data/beproud/recipes/printer/test/large.json
resources/data/beproud/recipes/printer/test/standard.json

resources/data/beproud/recipes/printer/test/small.json

Примеры рецептов можно найти в репозитории автора оригинального мода.

Текстуры флагов размещаются по следующим путям:

// Текстуры для флагов
resources/assets/beproud/textures/block/flag/test/large.json
resources/assets/beproud/textures/block/flag/test/standard.json
resources/assets/beproud/textures/block/flag/test/small.json

Примеры текстур также доступны в репозитории разработчика основного мода.