1 Commits

Author SHA1 Message Date
tkrmagid
e3c25fc845 v0.4.17: music_quiz datapack handshake (server + per-player presence)
Some checks failed
build / build (push) Has been cancelled
Implements docs/mc_video_player_mod_integration.md.

Server (MusicQuizPresence):
- every server tick: #server mq_video_mod = 1
- on MqHelloPayload receive: <player> mq_video_mod = 1
- both silently skip if objective absent (datapack not yet loaded)

Client (MusicQuizClient):
- send MqHelloPayload(1) on JOIN
- resend every 100 client ticks (~5 s) — mandatory because the datapack's
  mq:players/login resets per-player score to 0 at spawn-dialog passage

Payload: video_player:mq_hello, single VAR_INT body (version=1).
2026-05-16 22:40:40 +09:00
7 changed files with 171 additions and 1 deletions

View File

@@ -5,7 +5,7 @@ org.gradle.configuration-cache=false
# Mod # Mod
mod_id=video_player mod_id=video_player
mod_version=0.4.16 mod_version=0.4.17
maven_group=com.ejclaw.videoplayer maven_group=com.ejclaw.videoplayer
archives_base_name=video_player archives_base_name=video_player

View File

@@ -1,6 +1,7 @@
package com.ejclaw.videoplayer; package com.ejclaw.videoplayer;
import com.ejclaw.videoplayer.block.VideoAnchorBlockEntity; import com.ejclaw.videoplayer.block.VideoAnchorBlockEntity;
import com.ejclaw.videoplayer.client.MusicQuizClient;
import com.ejclaw.videoplayer.client.net.ClientNetworking; import com.ejclaw.videoplayer.client.net.ClientNetworking;
import com.ejclaw.videoplayer.client.playback.VideoPlayback; import com.ejclaw.videoplayer.client.playback.VideoPlayback;
import com.ejclaw.videoplayer.client.render.VideoAnchorRenderer; import com.ejclaw.videoplayer.client.render.VideoAnchorRenderer;
@@ -28,6 +29,7 @@ public class VideoPlayerClient implements ClientModInitializer {
@Override @Override
public void onInitializeClient() { public void onInitializeClient() {
ClientNetworking.register(); ClientNetworking.register();
MusicQuizClient.register();
BlockEntityRendererRegistry.register( BlockEntityRendererRegistry.register(
VideoPlayerBlockEntities.VIDEO_ANCHOR, VideoPlayerBlockEntities.VIDEO_ANCHOR,

View File

@@ -8,6 +8,7 @@ import com.ejclaw.videoplayer.command.VideoStickCommand;
import com.ejclaw.videoplayer.net.CachePolicyPayload; import com.ejclaw.videoplayer.net.CachePolicyPayload;
import com.ejclaw.videoplayer.net.PreloadPayload; import com.ejclaw.videoplayer.net.PreloadPayload;
import com.ejclaw.videoplayer.net.VideoPlayerNetwork; import com.ejclaw.videoplayer.net.VideoPlayerNetwork;
import com.ejclaw.videoplayer.server.MusicQuizPresence;
import com.ejclaw.videoplayer.registry.VideoPlayerBlockEntities; import com.ejclaw.videoplayer.registry.VideoPlayerBlockEntities;
import com.ejclaw.videoplayer.registry.VideoPlayerBlocks; import com.ejclaw.videoplayer.registry.VideoPlayerBlocks;
import com.ejclaw.videoplayer.registry.VideoPlayerItems; import com.ejclaw.videoplayer.registry.VideoPlayerItems;
@@ -30,6 +31,7 @@ public class VideoPlayerMod implements ModInitializer {
VideoPlayerNetwork.registerPayloadTypes(); VideoPlayerNetwork.registerPayloadTypes();
VideoPlayerNetwork.registerServerReceivers(); VideoPlayerNetwork.registerServerReceivers();
MusicQuizPresence.register();
VideoPlayerConfig.load(); VideoPlayerConfig.load();

View File

@@ -0,0 +1,56 @@
package com.ejclaw.videoplayer.client;
import com.ejclaw.videoplayer.net.MqHelloPayload;
import net.fabricmc.api.EnvType;
import net.fabricmc.api.Environment;
import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayConnectionEvents;
import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
/**
* Client side of the {@code music_quiz} datapack handshake
* ({@code docs/mc_video_player_mod_integration.md}). Sends one {@link MqHelloPayload}
* on JOIN, then repeats every 100 client ticks (~5 s at 20 tps).
*
* <p>The periodic resend is <em>mandatory</em>: the datapack's
* {@code mq:players/login} resets the per-player score to 0 the moment the player
* passes the spawn dialog. The single JOIN-time send can land before that reset,
* leaving the score at 0 and breaking the {@code mq:commands/start} guard. With a
* 5-second resend, the score is restored to 1 within at most one cycle.
*/
@Environment(EnvType.CLIENT)
public final class MusicQuizClient {
private MusicQuizClient() {}
/** ~5 s at 20 tps. Spec recommends ≤5 s; tighter is fine but unnecessary. */
private static final int RESEND_INTERVAL_TICKS = 100;
private static int tickCounter = 0;
public static void register() {
ClientPlayConnectionEvents.JOIN.register((handler, sender, client) ->
send());
ClientTickEvents.END_CLIENT_TICK.register(client -> {
// Gate on world presence — when the player isn't in-game, level is null and the
// counter resets so the next session starts fresh instead of firing immediately.
if (client.level == null) {
tickCounter = 0;
return;
}
tickCounter++;
if (tickCounter >= RESEND_INTERVAL_TICKS) {
tickCounter = 0;
send();
}
});
}
private static void send() {
// ClientPlayNetworking.send no-ops when the server hasn't registered the payload
// type (e.g. vanilla server or server without this mod) — safe to call blindly.
if (ClientPlayNetworking.canSend(MqHelloPayload.TYPE)) {
ClientPlayNetworking.send(new MqHelloPayload(MqHelloPayload.CURRENT_VERSION));
}
}
}

View File

@@ -0,0 +1,35 @@
package com.ejclaw.videoplayer.net;
import com.ejclaw.videoplayer.VideoPlayerMod;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.Identifier;
/**
* C2S — client-presence handshake for the {@code music_quiz} datapack
* ({@code docs/mc_video_player_mod_integration.md}). Each modded client sends one on JOIN
* and one every ~5 s thereafter. The server side flips the player's {@code mq_video_mod}
* scoreboard score to {@code 1}, which the datapack reads in its {@code mq:commands/start}
* guard.
*
* <p>Payload body is a single int (protocol version) so future schema bumps don't require
* a new packet id. v1 is the only version that exists today.
*/
public record MqHelloPayload(int version) implements CustomPacketPayload {
public static final int CURRENT_VERSION = 1;
public static final CustomPacketPayload.Type<MqHelloPayload> TYPE =
new CustomPacketPayload.Type<>(Identifier.fromNamespaceAndPath(VideoPlayerMod.MOD_ID, "mq_hello"));
public static final StreamCodec<RegistryFriendlyByteBuf, MqHelloPayload> CODEC = StreamCodec.composite(
ByteBufCodecs.VAR_INT, MqHelloPayload::version,
MqHelloPayload::new
);
@Override
public Type<? extends CustomPacketPayload> type() {
return TYPE;
}
}

View File

@@ -32,6 +32,7 @@ public final class VideoPlayerNetwork {
// C2S // C2S
PayloadTypeRegistry.serverboundPlay().register(SaveConfigPayload.TYPE, SaveConfigPayload.CODEC); PayloadTypeRegistry.serverboundPlay().register(SaveConfigPayload.TYPE, SaveConfigPayload.CODEC);
PayloadTypeRegistry.serverboundPlay().register(DeleteAnchorPayload.TYPE, DeleteAnchorPayload.CODEC); PayloadTypeRegistry.serverboundPlay().register(DeleteAnchorPayload.TYPE, DeleteAnchorPayload.CODEC);
PayloadTypeRegistry.serverboundPlay().register(MqHelloPayload.TYPE, MqHelloPayload.CODEC);
} }
public static void registerServerReceivers() { public static void registerServerReceivers() {

View File

@@ -0,0 +1,74 @@
package com.ejclaw.videoplayer.server;
import com.ejclaw.videoplayer.VideoPlayerMod;
import com.ejclaw.videoplayer.net.MqHelloPayload;
import net.fabricmc.fabric.api.event.lifecycle.v1.ServerTickEvents;
import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
import net.minecraft.server.MinecraftServer;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.scores.Objective;
import net.minecraft.world.scores.ScoreHolder;
import net.minecraft.world.scores.Scoreboard;
/**
* Implements the server side of the {@code music_quiz} datapack handshake described in
* {@code docs/mc_video_player_mod_integration.md}.
*
* <p>Two scoreboard writes against objective {@code mq_video_mod} (dummy):
* <ul>
* <li>Every server tick — {@code #server mq_video_mod = 1}. Proves the mod jar is on the
* server side. The datapack's {@code mq:commands/start} guard checks this first.</li>
* <li>Every received {@link MqHelloPayload} — {@code <player> mq_video_mod = 1}. Proves
* the sending player's client has the mod installed. Per-player flag is needed
* because rendering is client-side; the server can't tell from join state alone.</li>
* </ul>
*
* <p>The objective itself ({@code scoreboard objectives add mq_video_mod dummy}) is
* created by the datapack's {@code mq:load} function. If it isn't present yet (datapack
* not applied, or load hasn't run), the writes are silently skipped — when the datapack
* appears later, the next tick / next payload arrival populates it.
*/
public final class MusicQuizPresence {
private MusicQuizPresence() {}
/** Scoreboard objective name expected by the {@code music_quiz} datapack. */
private static final String OBJECTIVE = "mq_video_mod";
/** Fake holder used to mark "the server has the mod" (datapack reads {@code #server}). */
private static final String SERVER_HOLDER = "#server";
/** Call from {@code VideoPlayerMod.onInitialize} after payload types are registered. */
public static void register() {
// (a) per-tick server presence
ServerTickEvents.END_SERVER_TICK.register(MusicQuizPresence::onServerTick);
// (b) per-player client presence — flipped on every received Hello
ServerPlayNetworking.registerGlobalReceiver(MqHelloPayload.TYPE, (payload, context) -> {
ServerPlayer player = context.player();
MinecraftServer server = context.server();
// hop back onto the server thread before touching the scoreboard
server.execute(() -> markPlayerPresent(server, player));
});
}
private static void onServerTick(MinecraftServer server) {
Scoreboard sb = server.getScoreboard();
Objective obj = sb.getObjective(OBJECTIVE);
// Datapack not loaded yet — silently skip. The score holder doesn't exist until
// the objective does, and trying to write blind would just blow up.
if (obj == null) return;
sb.getOrCreatePlayerScore(ScoreHolder.forNameOnly(SERVER_HOLDER), obj).set(1);
}
private static void markPlayerPresent(MinecraftServer server, ServerPlayer player) {
Scoreboard sb = server.getScoreboard();
Objective obj = sb.getObjective(OBJECTIVE);
if (obj == null) {
VideoPlayerMod.LOG.debug("[{}] mq hello from {} but objective '{}' not present",
VideoPlayerMod.MOD_ID, player.getName().getString(), OBJECTIVE);
return;
}
// ServerPlayer itself implements ScoreHolder, so this matches selector @s on the
// datapack side without name-formatting quirks (uuid vs profile name).
sb.getOrCreatePlayerScore(player, obj).set(1);
}
}