Skip to content

ConstantDust/Figura

 
 

Repository files navigation

NOTE: This readme file will be replaced soon.

Figura

A fully clientside Minecraft Java mod that allows you to customize your player model!

image

Utilizing the full potential of Blockbench, including:

image

image

But not only that, Figura also have a whole optional Lua API to make your own scripts!

image

But hold on, thats too good, what if someone is invisible, or very small?

image

*Figura do not take responsability of cheaty Avatars, all Avatars are responsibility of their creators

We also have some extras, like:

image

Meet us on Discord for more info and help :)

Links

Social:

discord

Download:

modrinth curseforge

Donate:

kofi

FAQ

• My avatars don't appear in the Figura list, even though they're in the correct folder?

Check if your avatar has a file called "avatar.json" (don't forget to check file extensions)

This file can be completely empty, it just needs to be present for Figura to recognise it as an avatar

• How do I hide the vanilla model?

At the top of your script, put:

• To hide literally everything (player, armor, elytra, held items):

vanilla_model.ALL:setVisible(false)

• To hide only the player:

vanilla_model.PLAYER:setVisible(false)

• To hide only armor:

vanilla_model.ARMOR:setVisible(false)

• To hide other, or specific parts, you can check the in-game docs

• How do I play a Blockbench Animation?

Simply put this code in your script:

animations.modelName.animationName:play()

Where:

"animations" is the global table which contains all animations

"modelName" is the name of the model you are accessing the animation from

"animationName" is, as the name says, the animation name

• What are Pings and how do I use them?

Pings are Lua functions that are executed for everyone running your avatar's script

Pings are sent from the host player, and can be used to sync things like keypresses or action wheel actions

To create a ping:

function pings.myPing(arg1, arg2)
  -- code to run once the ping is called
end

And to execute the ping, it's as shrimple as calling a lua function:

pings.myPing("Hello", "World")

Note that pings are limited in their content and size, and are rate-limited

• How can I add an emissive texture?

Name the texture the same as the non-emissive counterpart, then add _e to the end

And don't forget to set the places you don't want to glow to transparent black (#00000000), to also ensure compatibility with shader mods

• My emissives doesn't glow, nor have bloom with Iris shaders?

Since some shaders doesnt support emissives, a compatibility setting (default on) will change the render type of emissive textures to render them at it were fullbright, however that can lead to some unintended results

You can force your avatar to use the correct emissive render type by using the render type EYES on your model

• Where can I find avatars to download?

For now you can find avatars in the showcase channel in the official Discord server

• My Minecraft is cracked (non-premium/non-original), why can't I use Figura?

Figura uses your account's UUID and your Mojang authentication as a way to prove you own that account, avoiding unwanted / malicious uploads

Non-premium Minecraft accounts don't authenticate with Mojang, and as such can neither upload nor download Figura avatars

Community Resources

  • Want to learn / get into Lua scripting? check out this Lua quickstart made by Manuel

  • If you are tired of having to be in-game to look in the wiki, applejuice hosts the wiki as a website

  • Are you new to Figura and are looking for a video tutorial about how everything works? You should probably watch Chloe's Figura tutorial series on YouTube

  • Do you wish there was a wiki for the rewrite? Slyme has an unofficial wiki covering most of Figura's basics

  • If you want a more in-depth wiki, with the GitHub style, Katt made one here

  • Do you use VSCode and wish Figura's documentation autocompleted in the editor? GrandpaScout saves the day with their VSDocs

About

the figura mod but less restricted

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 100.0%