WolfQueen's Origins

What is Figura

Figura is a Minecraft Mod dedicated to reworking the Minecraft skin system, allowing users to change their player model, animate it, and manage it through Lua scripts all without ever needing a server-sided mod. 

Figura Discord

For the best help in getting animations/scripting working I highly recommend joining the Figura discord: https://discord.gg/ekHGHcH8Af

Frequently Asked Questions

Where can I find avatars to download and use?

To find full avatars, go to  #丨avatar-showcase in the Discord server and select the ( download available) tag.

Creating an Empty Avatar

First, launch the game. This will put the mods into effect and create the folders necessary to mess with Figura. Navigate to the server folders and open the new figura folder. Inside, there should be an avatars folder. Open this and create a new folder with any name.

Before continuing, please make sure that your file extensions are turned on. File extensions tell what format a file is in the form of suffixes following the template of for example, picture.png

Go into this folder and create a new text file. Rename it to avatar.json and make sure that there is no .txt file extension. This file can be completely empty but can contain metadata for name, author, mark colour, and version.

Name and authors will show up in the Figura menu, colour will change the colour of your mark.

Now, check your Figura menu by entering a world or server, pausing the game, and clicking the Figura icon next to the "Open to LAN" button as shown above

Now you should be able to find your avatar in the avatar picker.

Adding a Model

Now that you've created an empty Figura avatar, you may be wondering "what do I do with this?" The first step is adding your own custom model, whether it's an addition to the vanilla model or a whole new one.

Installing Blockbench

Figura uses the Blockbench program for creating models for your avatar. To get Blockbench, go to their downloads at https://www.blockbench.net/downloads or use their web version at https://web.blockbench.net/

Starting your Model

Now that you have Blockbench, create a new model using the Minecraft Skin option. Select your skin type ("Steve" or "Alex"), make sure that "Pose" is turned off, and press the "Confirm" button. You will be dropped into a 3D modeling screen with a default player model.

At first glance, you will not be able to edit the model of the Minecraft Skin. This is because the Minecraft Skin template does not allow model editing by itself. To edit the model of a Minecraft Skin, you must click File > Convert Project. A small window will appear with a dropdown that should default to "Generic Model". If it does not, please select it using the context menu. Press "Confirm" and your Skin will be converted to a Generic Model. From here, you can edit the model.

If you do not know how to use Blockbench, there is a tutorial on how to use it on ArtsByKev's YouTube channel at https://www.youtube.com/playlist?list=PLvULVkjBtg2SezfUA8kHcPUGpxIS26uJR. I recommend it if you're just starting out and want to learn the basics in an hour.

Now that you have your model, save it in the same folder as your avatar.json. Check back in-game and see if you now have the model applied to yourself.

If you see that your vanilla skin is phasing in and out with your avatar, do not worry. This is because the vanilla model was never disabled. Please check this FAQ page for more information.

The Basics of Scripting

The last great thing every avatar should have is a script. Figura uses the Lua programming language to script things that should happen in your avatar, ranging from animations to nameplate modification to a wheel that makes player-controlled function calling much easier.

Installing Visual Studio Code

To program in Lua, you must have any plain text editor, but I recommend something like Visual Studio Code. To get Visual Studio Code (or as it will be referred to, VSC), go to their downloads page at https://code.visualstudio.com/Download. VSC, unlike the Visual Studio made for .NET programming, is monetarily free and is based on open source technologies. If you do not want to or cannot install VSC, you can access it online at https://vscode.dev/.

Getting Extensions

The reason I recommend VSC for Figura scripting is because there is already a Figura extension for it. Once you're in the editor, look for the icon with four squares, one disconnected, on the left toolbar. This will open the Extensions panel, where you can manage your installed extensions and get new ones from the marketplace. Click the search bar and type "Figura" into it. You'll see one labeled "Figura" by none other than Manuel_ (although named Manuel-Underscore here). Click the Install button to install the extension.

The Wardrobe

The wardrobe is where Figura users will select which avatar they want to be seen as, manage the avatar on the backend, and edit settings concerning their avatar.

Red - Open avatars folder

This button only has one function, and it is to open the .minecraft/figura/avatars folder using your default file browser. 

Orange - Avatar Selection

Shows a list of all selectable avatars and allows you to select an avatar from the list. Doing so will not automatically upload it to the backend.

Folders and the avatars inside are also shown in the listing, allowing for sorting your avatars into groups. 

Yellow - Preview

Shows the currently selected or uploaded avatar. You can rotate the camera by left clicking and pan the camera by right clicking. You can also full screen the preview with the expand button. Middle clicking resets the pan and rotation of the preview. 

Green - Status

Shows indicators for avatar size, texture, script, and backend. Hovering over these indicators will give you more information. 

Teal - Backend Buttons

Allows users to upload, reload, and delete their avatars from the backend.

 The Upload Avatar button uploads your avatar to the backend for everyone to see.

    The Reload Avatar button reloads your avatar from the backend version.

    The Delete Avatar button removes your avatar from the backend. 

Blue - Avatar-Specific Buttons

The Help Page button opens the official Figura wiki at https://github.com/Kingdom-Of-The-Moon/FiguraRewriteRewrite/wiki/.

The Sounds button allows you to view and play the custom sounds attached with the avatar.

The Upload Avatar button allows you to view and rebind the keybinds set by the avatar's scripts.

Purple - Avatar Information

Displays information about the avatar, including...

•     Avatar Name: The folder containing the avatar's name or the name tag in the avatar.json.
•     Author: The creator(s) of the avatar as specified within the author/authors tag in the avatar.json.
•     Size: The storage used to make the avatar.
•     Complexity: The amount of faces used to make the model. Each cube is 6 complexity. 

Pink - Figura Version

Displays the Figura and Minecraft version the client is running. 

Trust Menu

Quick Access

The trust menu is where the limits on each avatar is set.

Red - Filter Options

Filters the player list below.

    Show/Hide Non-Figura Players

    Show/Hide Offline Players

Orange - Player List

From this, you can pick any player online (or offline) and move them up or down the trust list.

Yellow - Avatar Preview

Shows the currently selected player's avatar or a question mark if an offline player or group is selected. Middle clicking resets the pan and rotation of the preview.

Green - Trust Slider

Selects the trust level for the selected player. In later versions of 0.1.0, you can also move players by holding a click on their left-side card.

Teal - Reload All Avatars

Clears the cache of all avatars and gets all avatars from the backend again.

Blue - Manage Permissions

Allows the player to edit the specific limits on each player or group. See below for more information.

Permission Menu

• Init Instructions  is how many lines of code can be executed when an entity or skull is loaded.
• World Tick Instructions  is how many lines of code can be executed on a world tick.
• Tick Instructions  is how many lines of code can be executed on an entity tick.
• World Render Instructions  is how many lines of code can be executed on a world render (each frame the world is rendered).
• Render Instructions is how many lines of code can be executed on an entity render (each frame the entity is rendered).
• Max Complexity is how many faces can be displayed.
• Max Particles is how many particles can be played each second.
• Max Sounds is how many particles can be played each second.
• Avatar Sounds Volume controls how loud sounds scripted into the avatar can be.
• Animation Complexity is how many animation channels can be loaded at once. Not played, loaded.
• Max Texture Size is how large textures generated with the Texture API can be.
• Vanilla Model Change allows avatars to modify the vanilla model.
• Nameplate Change allows scripts to alter the nameplates of players.
• Render Offscreen allows avatars to render offscreen.
• Custom Sounds allows avatars to play sounds not provided by the game.
• Custom Player Heads allows avatars to replace the in-game player head with their own custom model.

Reccomend Checking these videos out.

https://www.youtube.com/playlist?list=PLNz7v2g2SFA8lOQUDS4z4-gIDLi_dWAhl