Custom Portal API Reforged

Custom Portal API Reforged - это библиотечный мод для Forge (и NeoForge), портированный с версии для Fabric. Если вы когда-нибудь хотели добавить в Майнкрафт свои порталы, ведущие в кастомные измерения, но не хотели возиться с тоннами кода - этот мод для вас. Он берет на себя всю сложную работу, позволяя создавать порталы, которые работают точно как незер-порталы, но при этом полностью настраиваются.

Зачем это нужно

В ванильном Minecraft есть только два портала: в Незер и в Энд. Но если вы разрабатываете свой мод с новыми измерениями (вроде Twilight Forest, Aether или чего-то своего), вам нужен способ туда попасть. Без Custom Portal API Reforged пришлось бы писать кучу boilerplate-кода для обработки рамки, зажигания, телепортации и прочего. Этот мод делает всё за вас.

Как это работает

Мод предоставляет класс CustomPortalBuilder, через который вы настраиваете портал буквально в несколько строк кода. Всё делается в событии FMLCommonSetupEvent.

Вот пример простого портала, который ведет в Энд и зажигается правым кликом по рамке с Eye of Ender:

CustomPortalBuilder.beginPortal()  
        .frameBlock(Blocks.DIAMOND_BLOCK)  
        .lightWithItem(Items.ENDER_EYE)  
        .destDimID(new ResourceLocation("the_end"))  
        .tintColor(45,65,101)  
        .registerPortal();

А так выглядит регистрация незер-портала (на случай если вы захотите сделать свой вариант):

CustomPortalBuilder.beginPortal()  
        .frameBlock(Blocks.OBSIDIAN)  
        .destDimID(new ResourceLocation("the_nether"))  
        .tintColor(131, 66, 184)  
        .registerPortal();

Что можно настроить

CustomPortalBuilder содержит кучу методов для кастомизации. Вот самые полезные:

• lightWithWater/Item/Fluid - управляете тем, как зажигается портал. Можно сделать так, чтобы он активировался водой, определённым предметом или жидкостью.
• onlyLightInOverworld - портал будет работать только в обычном мире. Полезно, если вы не хотите, чтобы игроки ставили порталы в Незере или Энде.
• flatPortal - плоский портал, как в Энде или Twilight Forest. Не куб, а просто рамка.

Помимо этого можно менять цвет tinting (оттенок портала), блок рамки, блок самого портала и многое другое. Всё задокументировано прямо в классе.

Подключение к проекту

Чтобы использовать мод в своём проекте, добавьте репозиторий и зависимость в build.gradle:

repositories {
        maven {url 'https://maven.azuredoom.com/mods'}
}
dependencies {
//1.20.1
        implementation fg.deobf('net.kyrptonaught.customportalapi:customportalapi-reforged:MODVERSION')
//1.20.2+
implementation fg.deobf("net.kyrptonaught.customportalapi:cpapireforged-neo-1.20.2:MODVERSION")
}

Важно знать

• Мод основан на оригинальном Custom Portal API для Fabric и более старой портированной версии.
• Работает на Forge для Minecraft 1.20.1 и NeoForge для 1.20.2+.
• Если вы собираетесь делать свой мод с новыми измерениями - это must-have библиотека.
• На слабом железе проблем не замечено, мод лёгкий и не грузит игру.

Скачайте Custom Portal API Reforged и добавьте в свой проект - создание кастомных порталов перестанет быть головной болью.