1
0
mirror of https://github.com/Suiranoil/SkinRestorer.git synced 2026-01-16 04:42:12 +00:00

Compare commits

...

11 Commits

12 changed files with 141 additions and 52 deletions

View File

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [2.0.3] - 2024-08-20
### Added
- Added `firstJoinSkinProvider` config option (see [wiki](https://github.com/Suiranoil/SkinRestorer/wiki/Config#firstjoinskinprovider))
### Fixed
- Fixed ability to set config values to `null`
## [2.0.2] - 2024-08-04 ## [2.0.2] - 2024-08-04
### Added ### Added
- Backported to minecraft 1.20-1.20.2 - Backported to minecraft 1.20-1.20.2

View File

@@ -1,5 +1,4 @@
### Added ### Added
- Backported to minecraft 1.20-1.20.2 - Added `firstJoinSkinProvider` config option (see [wiki](https://github.com/Suiranoil/SkinRestorer/wiki/Config#firstjoinskinprovider))
- [Forge] Added support for Forge ### Fixed
### Changed - Fixed ability to set config values to `null`
- Changed minimum java version to 17 for minecraft 1.20-1.20.4

View File

@@ -1,55 +1,100 @@
# SkinRestorer # SkinRestorer
![a](https://cf.way2muchnoise.eu/versions/skinrestorer.svg) <a href="https://www.curseforge.com/minecraft/mc-mods/skinrestorer"><img src="https://raw.githubusercontent.com/Suiranoil/badges/main/assets/minecraft/platform/curseforge/mini/badge.svg" alt="CurseForge" height="32"></a>
![Enviroment](https://img.shields.io/badge/enviroment-server-orangered) <a href="https://modrinth.com/mod/skinrestorer"><img src="https://raw.githubusercontent.com/Suiranoil/badges/main/assets/minecraft/platform/modrinth/mini/badge.svg" alt="Modrinth" height="32"></a>
[![CurseForge Downloads](https://cf.way2muchnoise.eu/skinrestorer.svg)](https://www.curseforge.com/minecraft/mc-mods/skinrestorer)
[![Modrinth Downloads](https://img.shields.io/modrinth/dt/skinrestorer?logo=modrinth&label=&suffix=%20&style=flat&color=242629&labelColor=5ca424&logoColor=1c1c1c)](https://modrinth.com/mod/skinrestorer)
SkinRestorer is a **server-side** only mod for Fabric that allows players to use and change skins on servers running in A server-side mod for managing and restoring player skins.
offline/insecure mode.
## Features ## Features
- **Set Skins from Mojang Account**: Fetch and apply skins using a valid Minecraft account name. - **Set skins from Mojang Account**: Fetch and apply skins using a valid Minecraft username.
- **Set Skins from URL**: Apply skins from any image URL, supporting both classic (Steve) and slim (Alex) skin models. - **Set skins from Ely.by**: Fetch and apply skins using a valid [Ely.by](https://ely.by/) username.
- **Set skins from URL**: Fetch and apply skins from any image URL, supporting both classic (Steve) and slim (Alex) skin models.
- **Automatic skin fetching**: Automatically fetch skin from Mojang/Ely.by when a player joins the server running in offline/insecure mode ([configurable](https://github.com/Suiranoil/SkinRestorer/wiki/Config)).
- **Singleplayer support**: Apply skins individually for each world.
- **Permissions API support**
## Command Usage Guide ## 📜 Command Usage Guide
### Set Mojang Skin ### Set Mojang skin
Fetch and apply skins using a valid Minecraft username.
``` ```
/skin set mojang <username> [<targets>] /skin set mojang <username> [<targets>]
``` ```
- **Parameters:** - **Parameters**
- `<username>`: Minecraft account name to fetch the skin from. - `<username>`: Minecraft username to fetch the skin from.
- `[<targets>]`: (Optional, server operators only) Player(s) to apply the skin to. - `[<targets>]`: (Optional, server operators only) Player(s) to apply the skin to.
### Set Web Skin ### Set Ely.by skin
Fetch and apply skins using a valid [Ely.by](https://ely.by/) username.
```
/skin set ely.by <username> [<targets>]
```
- **Parameters**
- `<username>`: Ely.by username to fetch the skin from.
- `[<targets>]`: (Optional, server operators only) Player(s) to apply the skin to.
### Set Web skin
Fetch and apply skins from any image URL, supporting both classic (Steve) and slim (Alex) skin models.
Uses [mineskin api](https://mineskin.org/) under the hood.
``` ```
/skin set web (classic|slim) "<url>" [<targets>] /skin set web (classic|slim) "<url>" [<targets>]
``` ```
- **Parameters:** - **Parameters**
- `(classic|slim)`: Type of the skin model (`classic` for Steve model, `slim` for Alex model). - `(classic|slim)`: Type of the skin model (`classic` for Steve model, `slim` for Alex model).
- `"<url>"`: URL pointing to the skin image file (ensure it follows Minecraft's skin size and format requirements). - `"<url>"`: URL pointing to the skin image file (ensure it follows Minecraft's skin size and format requirements).
- `[<targets>]`: (Optional, server operators only) Player(s) to apply the skin to. - `[<targets>]`: (Optional, server operators only) Player(s) to apply the skin to.
### Clear Skin ### Refresh skin
Refetch and reapply the currently applied skins.
```
/skin refresh [<targets>]
```
- **Parameters**
- `[<targets>]`: (Optional, server operators only) Player(s) to refresh the skin for.
### Clear skin
Remove the currently applied skins.
``` ```
/skin clear [<targets>] /skin clear [<targets>]
``` ```
- **Parameters:** - **Parameters**
- `[<targets>]`: (Optional, server operators only) Player(s) to clear the skin for. - `[<targets>]`: (Optional, server operators only) Player(s) to clear the skin for.
### Notes: ### Reset skin
Reset to the default skin or remove any custom skin.
If [automatic skin fetching](https://github.com/Suiranoil/SkinRestorer/wiki/Config#fetchskinonfirstjoin) is enabled, a new skin will be fetched when the player rejoins the server.
```
/skin reset [<targets>]
```
- **Parameters**
- `[<targets>]`: (Optional, server operators only) Player(s) to reset the skin for.
### Notes
- If `targets` is not specified, the command will apply to the player executing the command. - If `targets` is not specified, the command will apply to the player executing the command.
### Examples: ### Examples
``` ```
/skin set mojang Notch /skin set mojang Notch

View File

@@ -15,6 +15,8 @@ public final class Config {
private boolean fetchSkinOnFirstJoin = true; private boolean fetchSkinOnFirstJoin = true;
private FirstJoinSkinProvider firstJoinSkinProvider = FirstJoinSkinProvider.MOJANG;
private String proxy = ""; private String proxy = "";
private long requestTimeout = 10; private long requestTimeout = 10;
@@ -27,6 +29,10 @@ public final class Config {
return this.fetchSkinOnFirstJoin; return this.fetchSkinOnFirstJoin;
} }
public FirstJoinSkinProvider getFirstJoinSkinProvider() {
return this.firstJoinSkinProvider;
}
public String getProxy() { public String getProxy() {
return this.proxy; return this.proxy;
} }
@@ -48,8 +54,24 @@ public final class Config {
if (config == null) if (config == null)
config = new Config(); config = new Config();
config.verifyAndFix();
FileUtils.writeFile(path.resolve(Config.CONFIG_FILENAME), JsonUtils.toJson(config)); FileUtils.writeFile(path.resolve(Config.CONFIG_FILENAME), JsonUtils.toJson(config));
return config; return config;
} }
private void verifyAndFix() {
if (this.language == null || this.language.isEmpty())
this.language = "en_us";
if (this.firstJoinSkinProvider == null)
this.firstJoinSkinProvider = FirstJoinSkinProvider.MOJANG;
if (this.proxy == null)
this.proxy = "";
if (this.requestTimeout <= 0)
this.requestTimeout = 10;
}
} }

View File

@@ -0,0 +1,22 @@
package net.lionarius.skinrestorer.config;
import com.google.gson.annotations.SerializedName;
import net.lionarius.skinrestorer.skin.provider.ElyBySkinProvider;
import net.lionarius.skinrestorer.skin.provider.MojangSkinProvider;
public enum FirstJoinSkinProvider {
@SerializedName(value = "MOJANG", alternate = {"mojang"})
MOJANG(MojangSkinProvider.PROVIDER_NAME),
@SerializedName(value = "ELY.BY", alternate = {"ely.by", "ELY_BY", "ely_by"})
ELY_BY(ElyBySkinProvider.PROVIDER_NAME);
private final String name;
FirstJoinSkinProvider(String name) {
this.name = name;
}
public String getName() {
return this.name;
}
}

View File

@@ -3,7 +3,6 @@ package net.lionarius.skinrestorer.mixin;
import com.mojang.authlib.GameProfile; import com.mojang.authlib.GameProfile;
import net.lionarius.skinrestorer.SkinRestorer; import net.lionarius.skinrestorer.SkinRestorer;
import net.lionarius.skinrestorer.skin.SkinValue; import net.lionarius.skinrestorer.skin.SkinValue;
import net.lionarius.skinrestorer.skin.provider.MojangSkinProvider;
import net.lionarius.skinrestorer.skin.provider.SkinProviderContext; import net.lionarius.skinrestorer.skin.provider.SkinProviderContext;
import net.lionarius.skinrestorer.util.PlayerUtils; import net.lionarius.skinrestorer.util.PlayerUtils;
import net.lionarius.skinrestorer.util.Result; import net.lionarius.skinrestorer.util.Result;
@@ -48,7 +47,11 @@ public abstract class ServerLoginPacketListenerImplMixin {
if (originalSkin == null && SkinRestorer.getConfig().fetchSkinOnFirstJoin()) { if (originalSkin == null && SkinRestorer.getConfig().fetchSkinOnFirstJoin()) {
SkinRestorer.LOGGER.debug("Fetching {}'s skin", authenticatedProfile.getName()); SkinRestorer.LOGGER.debug("Fetching {}'s skin", authenticatedProfile.getName());
var context = new SkinProviderContext(MojangSkinProvider.PROVIDER_NAME, authenticatedProfile.getName(), null); var context = new SkinProviderContext(
SkinRestorer.getConfig().getFirstJoinSkinProvider().getName(),
authenticatedProfile.getName(),
null
);
var result = SkinRestorer.getProvider(context.name()).map( var result = SkinRestorer.getProvider(context.name()).map(
provider -> provider.getSkin(context.argument(), context.variant()) provider -> provider.getSkin(context.argument(), context.variant())
).orElse(Result.ofNullable(null)); ).orElse(Result.ofNullable(null));

View File

@@ -66,12 +66,7 @@ public final class PlayerUtils {
} }
if (!player.isDeadOrDying()) { if (!player.isDeadOrDying()) {
player.connection.send(new ClientboundBundlePacket( player.connection.send(new ClientboundRespawnPacket(player.createCommonSpawnInfo(serverLevel), ClientboundRespawnPacket.KEEP_ALL_DATA));
List.of(
new ClientboundRespawnPacket(player.createCommonSpawnInfo(serverLevel), ClientboundRespawnPacket.KEEP_ALL_DATA),
new ClientboundGameEventPacket(ClientboundGameEventPacket.LEVEL_CHUNKS_LOAD_START, 0)
)
));
player.connection.teleport(player.getX(), player.getY(), player.getZ(), player.getYRot(), player.getXRot()); player.connection.teleport(player.getX(), player.getY(), player.getZ(), player.getYRot(), player.getXRot());
player.connection.send(new ClientboundSetEntityMotionPacket(player)); player.connection.send(new ClientboundSetEntityMotionPacket(player));
var vehicle = player.getVehicle(); var vehicle = player.getVehicle();
@@ -85,13 +80,13 @@ public final class PlayerUtils {
playerList.sendPlayerPermissionLevel(player); playerList.sendPlayerPermissionLevel(player);
playerList.sendLevelInfo(player, serverLevel); playerList.sendLevelInfo(player, serverLevel);
playerList.sendAllPlayerInfo(player); playerList.sendAllPlayerInfo(player);
playerList.sendActivePlayerEffects(player); PlayerUtils.sendActivePlayerEffects(player);
} }
} }
public static void sendActivePlayerEffects(ServerPlayer player) { public static void sendActivePlayerEffects(ServerPlayer player) {
for (var effect : player.getActiveEffects()) { for (var effect : player.getActiveEffects()) {
player.connection.send(new ClientboundUpdateMobEffectPacket(player.getId(), effect, false)); player.connection.send(new ClientboundUpdateMobEffectPacket(player.getId(), effect));
} }
} }

View File

@@ -11,7 +11,7 @@ import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
public abstract class MinecraftServerMixin { public abstract class MinecraftServerMixin {
@Inject(method = "runServer", @Inject(method = "runServer",
at = @At(value = "INVOKE", target = "Lnet/minecraft/Util;getNanos()J", ordinal = 0)) at = @At(value = "INVOKE", target = "Lnet/minecraft/Util;getMillis()J", ordinal = 0))
private void onServerStarted(CallbackInfo ci) { private void onServerStarted(CallbackInfo ci) {
SkinRestorer.onServerStarted((MinecraftServer) (Object) this); SkinRestorer.onServerStarted((MinecraftServer) (Object) this);
} }

View File

@@ -20,8 +20,6 @@ minecraft {
copyIdeResources = true //Calls processResources when in dev copyIdeResources = true //Calls processResources when in dev
reobf = false // Forge 1.20.6+ uses official mappings at runtime, so we shouldn't reobf from official to SRG
// Automatically enable forge AccessTransformers if the file exists // Automatically enable forge AccessTransformers if the file exists
// This location is hardcoded in Forge and can not be changed. // This location is hardcoded in Forge and can not be changed.
// https://github.com/MinecraftForge/MinecraftForge/blob/be1698bb1554f9c8fa2f58e32b9ab70bc4385e60/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFile.java#L123 // https://github.com/MinecraftForge/MinecraftForge/blob/be1698bb1554f9c8fa2f58e32b9ab70bc4385e60/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFile.java#L123

View File

@@ -3,15 +3,15 @@
# Project # Project
group=net.lionarius.skinrestorer group=net.lionarius.skinrestorer
java_version=21 java_version=17
# Common # Common
minecraft_version=1.21 minecraft_version=1.20.2
minecraft_version_list=1.21 minecraft_version_list=1.20.2
minecraft_version_range=[1.21, 1.22) minecraft_version_range=1.20.2
mod_id=skinrestorer mod_id=skinrestorer
mod_name=SkinRestorer mod_name=SkinRestorer
mod_version=2.0.2 mod_version=2.0.3
mod_author=Lionarius mod_author=Lionarius
mod_homepage=https://www.curseforge.com/minecraft/mc-mods/skinrestorer mod_homepage=https://www.curseforge.com/minecraft/mc-mods/skinrestorer
mod_sources=https://github.com/Suiranoil/SkinRestorer mod_sources=https://github.com/Suiranoil/SkinRestorer
@@ -21,21 +21,21 @@ credits=
description=A server-side mod for managing skins. description=A server-side mod for managing skins.
# ParchmentMC mappings, see https://parchmentmc.org/docs/getting-started#choose-a-version for new versions # ParchmentMC mappings, see https://parchmentmc.org/docs/getting-started#choose-a-version for new versions
parchment_minecraft=1.21 parchment_minecraft=1.20.2
parchment_version=2024.07.28 parchment_version=2023.12.10
# Fabric, see https://fabricmc.net/develop/ for new versions # Fabric, see https://fabricmc.net/develop/ for new versions
fabric_loader_version=0.15.0 fabric_loader_version=0.15.0
# Forge, see https://files.minecraftforge.net/net/minecraftforge/forge/ for new versions # Forge, see https://files.minecraftforge.net/net/minecraftforge/forge/ for new versions
forge_version=51.0.0 forge_version=48.0.0
forge_loader_version_range=[51,) forge_loader_version_range=[48,)
# Forge sometimes skips minor minecraft versions (like 1.20.5) # Forge sometimes skips minor minecraft versions (like 1.20.5)
forge_minecraft_version=1.21 forge_minecraft_version=1.20.2
# NeoForge, see https://projects.neoforged.net/neoforged/neoforge for new versions # NeoForge, see https://projects.neoforged.net/neoforged/neoforge for new versions
neoforge_version=21.0.0-beta neoforge_version=20.2.3-beta
neoforge_loader_version_range=[4,) neoforge_loader_version_range=[1,)
# Publishing # Publishing
curseforge_id=443823 curseforge_id=443823

View File

@@ -3,7 +3,6 @@ package net.lionarius.skinrestorer.neoforge;
import net.lionarius.skinrestorer.SkinRestorer; import net.lionarius.skinrestorer.SkinRestorer;
import net.lionarius.skinrestorer.command.SkinCommand; import net.lionarius.skinrestorer.command.SkinCommand;
import net.neoforged.bus.api.SubscribeEvent; import net.neoforged.bus.api.SubscribeEvent;
import net.neoforged.fml.common.EventBusSubscriber;
import net.neoforged.fml.common.Mod; import net.neoforged.fml.common.Mod;
import net.neoforged.fml.loading.FMLPaths; import net.neoforged.fml.loading.FMLPaths;
import net.neoforged.neoforge.common.NeoForge; import net.neoforged.neoforge.common.NeoForge;
@@ -11,7 +10,7 @@ import net.neoforged.neoforge.event.RegisterCommandsEvent;
import net.neoforged.neoforge.event.server.ServerStartedEvent; import net.neoforged.neoforge.event.server.ServerStartedEvent;
@Mod(SkinRestorer.MOD_ID) @Mod(SkinRestorer.MOD_ID)
@EventBusSubscriber(modid = SkinRestorer.MOD_ID) @Mod.EventBusSubscriber(modid = SkinRestorer.MOD_ID)
public final class SkinRestorerNeoForge { public final class SkinRestorerNeoForge {
public SkinRestorerNeoForge() { public SkinRestorerNeoForge() {

View File

@@ -17,14 +17,14 @@ config = "${mod_id}.mixins.json"
[[dependencies.${mod_id}]] [[dependencies.${mod_id}]]
modId = "neoforge" modId = "neoforge"
type = "required" mandatory = true
versionRange = "[${neoforge_version},)" versionRange = "[${neoforge_version},)"
ordering = "NONE" ordering = "NONE"
side = "BOTH" side = "BOTH"
[[dependencies.${mod_id}]] [[dependencies.${mod_id}]]
modId = "minecraft" modId = "minecraft"
type = "required" mandatory = true
versionRange = "${minecraft_version_range}" versionRange = "${minecraft_version_range}"
ordering = "NONE" ordering = "NONE"
side = "BOTH" side = "BOTH"