Skip to content

Latest commit

 

History

History
60 lines (48 loc) · 2.61 KB

README.md

File metadata and controls

60 lines (48 loc) · 2.61 KB

Emotecraft

a.k.a. EmoteX

Download

When downloading the mod, please only use official downloads as others may be infected.
Official project (only download the mod from here):

Development


how to build

git clone https://github.com/KosmX/emotes.git
cd emotes
./gradlew build

You can use collectArtifacts task to copy the mod files into an artifacts directory.

./gradlew collectArtifact
cd artifacts

Using in your mod/modpack

Fabric depends on bendy-lib, optionally Mod Menu and FabricMC mods: Fabric-loader, Fabric-API, Minecraft.

Forge version has no dependencies (except Forge and Minecraft)
bendy-lib is compiled into the forge version

Emotes proxy

Emotecraft is doing the emote synchronization using a server-side mod.
In some cases it's just impossible (like when playing on a community server)

This is where proxy API comes in as it can redirect communication when dedicated server-side mod isn't available.
If the server has Emotecraft (in any form) it will use that instead of using proxies.

To implement a proxy-mod, see emotes-proxy-template.
Emotecraft will invoke the proxy instance when trying to send a message,
and you can invoke Emotecraft's receiver when you received a message.

Modules:

emotesAPI: common library used by Emotecraft, has no dependencies, published as emotesAPI
you can find it in my private maven server: https://maven.kosmx.dev
executor: the interface to be implemented to the modloader+MC version
emotesMain: Main client-side logic
emotesServer: Server-side logic

archCommon: common (both Fabric and Forge) Minecraft dependent stuff. using architectury loom
fabric: latest fabric implementation
forge: latest Forge implementation

If you have any questions about the mod, you can find me on Discord