Skip to content

Support FRAPI on NeoForge #3818

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Su5eD wants to merge 1 commit into
base: 26.1.2/stable
Choose a base branch
from
Open

Support FRAPI on NeoForge #3818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions common/src/main/java/net/caffeinemc/mods/sodium/client/services/FRAPIProvider.java
View file
Open in desktop

This file was deleted.

14 changes: 14 additions & 0 deletions common/src/main/java/net/caffeinemc/mods/sodium/client/services/FRAPIRegistrar.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package net.caffeinemc.mods.sodium.client.services;

public interface FRAPIRegistrar {
FRAPIRegistrar INSTANCE = Services.loadConditionalOr(FRAPIRegistrarProvider.class, () -> () -> {}); // Returns a no-op implementation if the platform does not support FRAPI

static FRAPIRegistrar getInstance() {
return INSTANCE;
}

/**
* Registers the FRAPI provider. This should only be called once, and should be called during mod initialization.
*/
void register();
}
4 changes: 4 additions & 0 deletions common/src/main/java/net/caffeinemc/mods/sodium/client/services/FRAPIRegistrarProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
package net.caffeinemc.mods.sodium.client.services;

public interface FRAPIRegistrarProvider extends ServiceProvider<FRAPIRegistrar> {
}
2 changes: 1 addition & 1 deletion common/src/main/java/net/caffeinemc/mods/sodium/client/services/PlatformModelEmitter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import java.util.function.Predicate;

public interface PlatformModelEmitter {
PlatformModelEmitter INSTANCE = Services.loadOr(PlatformModelEmitter.class, DefaultModelEmitter::new);
PlatformModelEmitter INSTANCE = Services.loadConditionalOr(PlatformModelEmitterProvider.class, DefaultModelEmitter::new);

static PlatformModelEmitter getInstance() {
return INSTANCE;
Expand Down
4 changes: 4 additions & 0 deletions ...rc/main/java/net/caffeinemc/mods/sodium/client/services/PlatformModelEmitterProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
package net.caffeinemc.mods.sodium.client.services;

public interface PlatformModelEmitterProvider extends ServiceProvider<PlatformModelEmitter> {
}
7 changes: 7 additions & 0 deletions common/src/main/java/net/caffeinemc/mods/sodium/client/services/ServiceProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package net.caffeinemc.mods.sodium.client.services;

public interface ServiceProvider<T> {
boolean isEnabled();

T get();
}
11 changes: 11 additions & 0 deletions common/src/main/java/net/caffeinemc/mods/sodium/client/services/Services.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,15 @@ public static <T> T loadOr(Class<T> clazz, Supplier<T> supplier) {
LOGGER.debug("Loaded {} for service {}", loadedService, clazz);
return loadedService;
}

public static <T extends ServiceProvider<U>, U> U loadConditionalOr(Class<T> clazz, Supplier<U> supplier) {
final U loadedService = ServiceLoader.load(clazz).stream()
.map(ServiceLoader.Provider::get)
.filter(ServiceProvider::isEnabled)
.map(ServiceProvider::get)
.findFirst()
.orElseGet(supplier);
LOGGER.debug("Loaded {} for service {}", loadedService, clazz);
return loadedService;
}
}
4 changes: 2 additions & 2 deletions fabric/src/main/java/net/caffeinemc/mods/sodium/fabric/SodiumFabricMod.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import net.caffeinemc.mods.sodium.client.SodiumClientMod;
import net.caffeinemc.mods.sodium.client.config.ConfigManager;
import net.caffeinemc.mods.sodium.client.services.FRAPIProvider;
import net.caffeinemc.mods.sodium.client.services.FRAPIRegistrar;
import net.caffeinemc.mods.sodium.client.util.FlawlessFrames;
import net.caffeinemc.mods.sodium.fabric.config.ConfigLoaderFabric;
import net.fabricmc.api.ClientModInitializer;
Expand All @@ -27,6 +27,6 @@ public void onInitializeClient() {
.getEntrypoints("frex_flawless_frames", Consumer.class)
.forEach(api -> api.accept(FlawlessFrames.getProvider()));

FRAPIProvider.getInstance().register();
FRAPIRegistrar.getInstance().register();
}
}
18 changes: 18 additions & 0 deletions frapi/src/main/java/net/caffeinemc/mods/sodium/client/render/frapi/FRAPIEmitterProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package net.caffeinemc.mods.sodium.client.render.frapi;

import net.caffeinemc.mods.sodium.client.services.PlatformModelEmitter;
import net.caffeinemc.mods.sodium.client.services.PlatformModelEmitterProvider;
import net.caffeinemc.mods.sodium.client.services.PlatformRuntimeInformation;

public class FRAPIEmitterProvider implements PlatformModelEmitterProvider {
@Override
public boolean isEnabled() {
return PlatformRuntimeInformation.getInstance().isModInLoadingList("fabric-renderer-api-v1")
|| PlatformRuntimeInformation.getInstance().isModInLoadingList("fabric_renderer_api_v1");
Comment thread
douira marked this conversation as resolved.
}

@Override
public PlatformModelEmitter get() {
return new FRAPIEmitter();
}
}
5 changes: 2 additions & 3 deletions ...m/client/render/frapi/SodiumProvider.java → .../client/render/frapi/SodiumRegistrar.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
package net.caffeinemc.mods.sodium.client.render.frapi;

import net.caffeinemc.mods.sodium.client.services.FRAPIProvider;
import net.caffeinemc.mods.sodium.client.services.FRAPIRegistrar;
import net.fabricmc.fabric.api.client.renderer.v1.Renderer;

public class SodiumProvider implements FRAPIProvider {
@Override
public class SodiumRegistrar implements FRAPIRegistrar {
public void register() {
Renderer.register(SodiumRenderer.INSTANCE);
}
Expand Down
18 changes: 18 additions & 0 deletions ...src/main/java/net/caffeinemc/mods/sodium/client/render/frapi/SodiumRegistrarProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package net.caffeinemc.mods.sodium.client.render.frapi;

import net.caffeinemc.mods.sodium.client.services.FRAPIRegistrar;
import net.caffeinemc.mods.sodium.client.services.FRAPIRegistrarProvider;
import net.caffeinemc.mods.sodium.client.services.PlatformRuntimeInformation;

public class SodiumRegistrarProvider implements FRAPIRegistrarProvider {
@Override
public boolean isEnabled() {
return PlatformRuntimeInformation.getInstance().isModInLoadingList("fabric-renderer-api-v1")
|| PlatformRuntimeInformation.getInstance().isModInLoadingList("fabric_renderer_api_v1");
}

@Override
public FRAPIRegistrar get() {
return new SodiumRegistrar();
}
}
1 change: 0 additions & 1 deletion ...main/resources/META-INF/services/net.caffeinemc.mods.sodium.client.services.FRAPIProvider
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions ...urces/META-INF/services/net.caffeinemc.mods.sodium.client.services.FRAPIRegistrarProvider
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
net.caffeinemc.mods.sodium.client.render.frapi.SodiumRegistrarProvider
1 change: 0 additions & 1 deletion ...sources/META-INF/services/net.caffeinemc.mods.sodium.client.services.PlatformModelEmitter
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions ...META-INF/services/net.caffeinemc.mods.sodium.client.services.PlatformModelEmitterProvider
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
net.caffeinemc.mods.sodium.client.render.frapi.FRAPIEmitterProvider
16 changes: 16 additions & 0 deletions neoforge/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,25 @@ val configurationCommonServiceResources: Configuration = configurations.create("
isCanBeResolved = true
}

val configurationFrapiModJava: Configuration = configurations.create("frapiJava") {
isCanBeResolved = true
}
val configurationFrapiModResources: Configuration = configurations.create("frapiResources") {
isCanBeResolved = true
}

dependencies {
configurationCommonModJava(project(path = ":common", configuration = "commonMainJava"))
configurationCommonApiJava(project(path = ":common", configuration = "commonApiJava"))
configurationCommonServiceJava(project(path = ":common", configuration = "commonBootJava"))
if (BuildConfig.SUPPORT_FRAPI) configurationFrapiModJava(project(path = ":frapi", configuration = "frapiMainJava"))

configurationCommonApiSources(project(path = ":common", configuration = "commonApiSources"))

configurationCommonModResources(project(path = ":common", configuration = "commonMainResources"))
configurationCommonModResources(project(path = ":common", configuration = "commonApiResources"))
configurationCommonServiceResources(project(path = ":common", configuration = "commonBootResources"))
if (BuildConfig.SUPPORT_FRAPI) configurationFrapiModResources(project(path = ":frapi", configuration = "frapiMainResources"))

fun addEmbeddedFabricModule(dependency: String) {
dependencies.implementation(dependency)
Expand All @@ -72,6 +81,10 @@ val modJar = tasks.register<Jar>("modJar") {
from(configurationCommonModJava)
from(configurationCommonApiJava)
from(configurationCommonModResources)
if (BuildConfig.SUPPORT_FRAPI) {
from(configurationFrapiModJava)
from(configurationFrapiModResources)
}

from(sourceSets["mod"].output)

Expand Down Expand Up @@ -151,6 +164,9 @@ neoForge {
sourceSet(sourceSets["mod"])
sourceSet(project(":common").sourceSets["main"])
sourceSet(project(":common").sourceSets["api"])
if (BuildConfig.SUPPORT_FRAPI) {
sourceSet(project(":frapi").sourceSets["main"])
}
}

create("sodium-service") {
Expand Down
4 changes: 2 additions & 2 deletions neoforge/src/mod/java/net/caffeinemc/mods/sodium/neoforge/SodiumForgeMod.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package net.caffeinemc.mods.sodium.neoforge;

import net.caffeinemc.mods.sodium.client.gui.VideoSettingsScreen;
import net.caffeinemc.mods.sodium.client.services.FRAPIProvider;
import net.caffeinemc.mods.sodium.client.services.FRAPIRegistrar;
import net.caffeinemc.mods.sodium.client.util.FlawlessFrames;
import net.neoforged.api.distmarker.Dist;
import net.neoforged.bus.api.IEventBus;
Expand Down Expand Up @@ -36,6 +36,6 @@ public SodiumForgeMod(IEventBus bus, ModContainer modContainer) {
}
}

FRAPIProvider.getInstance().register();
FRAPIRegistrar.getInstance().register();
}
}
7 changes: 5 additions & 2 deletions neoforge/src/mod/resources/META-INF/neoforge.mods.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,20 @@ description = '''
Sodium is a powerful rendering engine for Minecraft which improves frame rates and reduces lag spikes.
'''

provides = ["indium"]

[modproperties.sodium]
"fabric-renderer-api-v1:contains_renderer" = true
"fabric:provides" = ["indium"]

[[mixins]]
config = "sodium-common.mixins.json"

[[mixins]]
config = "sodium-neoforge.mixins.json"

[[mixins]]
config = "sodium-frapi.mixins.json"
requiredMods = ["fabric_renderer_api_v1"]

[[dependencies.sodium]]
modId = "neoforge"
type = "required"
Expand Down