README.md

The Ladysnake maven is moving!

As Jfrog is ending their free service for OSS projects, we have to move the maven repository before the 1st of July 2023. See below for the new maven instructions - you will have to update your buildscripts with the new URL before the cutoff date to avoid dependency resolution failures.

Impersonate

A library handling player impersonation. Can also be used as a standalone mod, through the /impersonate command.

Most features work serverside, so you can use this mod on a vanilla-compatible server. Clientside installation is however still recommended for a smoother experience.

Overview

Impersonate allows players to take on the name and appearance of other players. When impersonating someone, a player will:

• have the skin of the impersonated player
• have the nameplate of the impersonated player
• send every chat message as if they were the impersonated player
• appear as the impersonated players in online player lists
• sign books as if they were the impersonated player
• etc.

They will however not fool the impersonated player's pets, if any.

To avoid moderation chaos, server logs will always display the actual player's name, alongside their fake identity. Server operators will have ongoing impersonations revealed in the same way.

Commands

Impersonate adds the /impersonate command, allowing server operators and mapmakers to interact with the API through commands.

• /impersonate disguise
  • /impersonate disguise as <name> [<targets>] [<key>] : disguises one or more players
    • <name> : Name of the player to impersonate. Does not have to be online or even real.
    • [<targets>] (optional) : If specified, must be either a player's username or a target selector. If unspecified, defaults to the player using the command. When used in a command block, player is not optional.
    • [<key>] (optional) : If specified, must be a valid identifier serving as a key for the impersonation.
  • /impersonate disguise clear [<targets>] [<key>] : stops the impersonation of one or more players
    • [<targets>] (optional) : If specified, must be either a player's username or a target selector. If unspecified, defaults to the player using the command. When used in a command block, player is not optional.
    • [<key>] (optional) : If specified, must be a valid identifier that was previously used as a key to start an impersonation. If left unspecified, the command will clear every active impersonation.
  • /impersonate disguise query [<target>] [<key>] : queries the ongoing impersonation for a given player
    • [<target>] (optional) : If specified, must be either a player's username or a target selector. If unspecified, defaults to the player using the command. When used in a command block, player is not optional.
    • [<key>] (optional) : If specified, must be a valid identifier. In that case, the command will display the specific impersonation using that key, otherwise it will display the currently visible (most recent) impersonation.

Permissions

If you have LuckPerms installed, the above commands can be used by players with the impersonate.command.disguise permission. If you only grant impersonate.command.disguise.self, players will only be able to use the commands on themselves.

Gamerules

• impersonate:fakeCapes : Whether impersonators should get the cape and elytra of impersonated players. Defaults to false.
  • If Effective is installed, this option also controls whether a player's cosmetics are mimicked during impersonation
• impersonate:opRevealImpersonations : Whether ongoing impersonations should be revealed to online server operators. Defaults to true.
• impersonate:logRevealImpersonations : Whether ongoing impersonations should be revealed in the server logs. Defaults to true.

Adding Impersonate to your project

You can add the library by inserting the following in your build.gradle :

Note 1: since MC 1.17 builds, the Impersonate dependency must be lowercase. Note 2: since MC 1.20.1 builds (1.14.0), the maven group changed from io.github.ladysnake to org.ladysnake.
Note 3: since June 2023, the maven url changed from ladysnake.jfrog.io/artifactory/mods to maven.ladysnake.org/releases.

repositories {
	maven { 
        name = "Ladysnake Mods"
        url = "https://maven.ladysnake.org/releases"
        content {
            includeGroup 'io.github.ladysnake'
            includeGroup 'org.ladysnake'
            includeGroupByRegex 'dev\\.onyxstudios\\..*'
        }
    }
    maven {
        name = "Nexus Repository Manager"
        url = 'https://oss.sonatype.org/content/repositories/snapshots'
    }
}

dependencies {
    modImplementation "org.ladysnake:impersonate:${impersonate_version}"
    include "org.ladysnake:impersonate:${impersonate_version}"
    // Impersonate dependencies
    include "me.lucko:fabric-permissions-api:${fpa_version}"
    include "dev.onyxstudios.cardinal-components-api:cardinal-components-base:${cca_version}"
    include "dev.onyxstudios.cardinal-components-api:cardinal-components-entity:${cca_version}"
}

You can then add the library version to your gradle.propertiesfile:

# Impersonate
impersonate_version = 1.x.y
# Fabric Permissions API
fpa_version = 0.1-SNAPSHOT
# Cardinal Components
cca_version = 2.x.y

You can find the current version of Impersonate in the releases tab of the repository on Github, and the latest CCA version in the appropriate repository.

Using Impersonate

You can find examples in the Test Mod and in the Impersonate Command.

public static final Identifier IMPERSONATION_KEY = new Identifier("mymod", "impersonitem");

public boolean useOnEntity(ItemStack stack, PlayerEntity user, LivingEntity entity, Hand hand) {
    if (entity instanceof ServerPlayerEntity) {
        Impersonator.get(user).impersonate(IMPERSONATION_KEY, ((PlayerEntity) entity).getGameProfile());
    } else {
        Impersonator.get(user).stopImpersonation(IMPERSONATION_KEY);
    }
    return super.useOnEntity(stack, user, entity, hand);
}