Community Resources: Difference between revisions
First Draft; please continue adding on! |
Adding more resources. If someone could make an inline icon template that would be amazing |
||
| Line 10: | Line 10: | ||
==='''[https://applejuiceyy.github.io/figs/ Figs]'''=== | ==='''[https://applejuiceyy.github.io/figs/ Figs]'''=== | ||
'''Figs''' is an online documentation browser for Figura, making using Figura's built-in documentation easier to use. | '''Figs''' is an online documentation browser for Figura, making using Figura's built-in documentation easier to use. | ||
==='''[https://wiki.figuramc.org Figura Wiki]''' (YOU ARE HERE) ⭐=== | |||
The '''Figura Wiki''' is an online wiki that aims to document Figura, its scripting language, modeling, etc. | |||
== Lua Documenation == | |||
==='''[https://manuel-3.github.io/lua-quickstart Lua Quickstart Guide]'''=== | |||
'''Manuel's Lua Quickstart Guide''' is a quick, online tutorial guiding users through the basics of Lua syntax. | |||
==='''[http://lua.org/manual/5.1 Lua 5.1 Manual]'''=== | |||
The '''Lua Manual''' is a long document describing the ins and outs of vanilla Lua. Although some of it will not apply to Figura Lua, it's still very useful for learning about the standard libraries. | |||
== Tutorials == | == Tutorials == | ||
==='''[https://www.youtube.com/playlist?list=PLNz7v2g2SFA8lOQUDS4z4-gIDLi_dWAhl Chloe's Video Tutorial Series]'''=== | ==='''[https://www.youtube.com/playlist?list=PLNz7v2g2SFA8lOQUDS4z4-gIDLi_dWAhl Chloe's Video Tutorial Series]'''=== | ||
'''Chloe's Tutorial Series''' is a video series on YouTube that acts as a way for new users to get used to the mod. The series covers everything from modeling and modifying <code>avatar.json</code> files to scripting. | '''Chloe's Tutorial Series''' is a video series on YouTube that acts as a way for new users to get used to the mod. The series covers everything from modeling and modifying <code>avatar.json</code> files to scripting. | ||
= Tools = | |||
==='''[https://github.com/GrandpaScout/FiguraRewriteVSDocs GS' Figura VSCode Documentation]'''=== | |||
'''GrandpaScout's Figura VSCode Documentation''' is an addon for Visual Studio Code (along with Code OSS and VSCodium) that adds Figura's documentation and snippets to [https://marketplace.visualstudio.com/items?itemName=sumneko.lua sumneko's Lua Language Server plugin]. | |||
<div class="mw-collapsible mw-collapsed"> | |||
<h4> | |||
Additional Resources | |||
<div class="mw-collapsible-toggle-placeholder"></div> | |||
</h4> | |||
<div class="mw-collapsible-content"> | |||
* [https://github.com/GrandpaScout/FiguraRewriteVSDocs/wiki Install Guide] | |||
</div> | |||
</div> | |||
==='''[https://github.com/KitCat962/figura-format-bbplugin Katt's Figura Blockbench Extension]'''=== | |||
The '''Figura Blockbench Extension''' adds a new model format to Blockbench, the Figura Model format. It extends the base Generic Model format by adding tools to make the avatar creation process easier, lifting restrictions to the Generic Model format that Figura supports, and removing features Figura doesn't. | |||
= Assets (Scripts, Libraries, APIs) = | = Assets (Scripts, Libraries, APIs) = | ||
== | {{Notice | ||
|content='''Some assets only exist within the [https://discord.figuramc.org FiguraMC Discord].'''<br> | |||
* Assets that link to the FiguraMC Discord will be marked with a 💬 icon. | |||
}} | |||
== Animation Helpers == | |||
==='''[https://github.com/GrandpaScout/GSAnimBlend GSAnimBlend]'''=== | ==='''[https://github.com/GrandpaScout/GSAnimBlend GSAnimBlend]'''=== | ||
'''GSAnimBlend''' is a script that automatically adds blends to the start and end of animations. | '''GSAnimBlend''' is a script that automatically adds blends to the start and end of animations. | ||
| Line 25: | Line 50: | ||
</h4> | </h4> | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
* [https://jimmyhelp.notion.site/JimmyAnims-79adfdca2fe04f9c9ede5e0bfd898b6a Documentation] | |||
* [https://github.com/JimmyHelp/JimmyAnims/blob/main/JimmyExample.lua Example Usage] | * [https://github.com/JimmyHelp/JimmyAnims/blob/main/JimmyExample.lua Example Usage] | ||
</div> | </div> | ||
</div> | </div> | ||
== World Interactions== | |||
==='''[https://discord.com/channels/1129805506354085959/1132467393050968214/1132467393050968214 Origins API]''' 💬=== | |||
Katt's '''Origins API''' is an API that uses the player's NBT data to get information about the player's [https://modrinth.com/mod/origins Origin]. | |||
==Visual Elements== | |||
==='''[https://github.com/Manuel-3/figura-scripts/tree/main/src/confetti Confetti]'''=== | ==='''[https://github.com/Manuel-3/figura-scripts/tree/main/src/confetti Confetti]'''=== | ||
'''Confetti''' is a library that allows users to add custom particles, either sprite or modelpart, to their avatars | '''Confetti''' is a library that allows users to add custom particles, either sprite or modelpart, to their avatars | ||
| Line 37: | Line 66: | ||
</h4> | </h4> | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/readme.md Documentation] | |||
* [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/example.zip Example Avatar] | * [https://github.com/Manuel-3/figura-scripts/blob/main/src/confetti/example.zip Example Avatar] | ||
</div> | |||
</div> | |||
==='''[https://discord.com/channels/1129805506354085959/1137506926742216835 KattArmor]''' 💬=== | |||
'''KattArmor''' (sometimes called Katt Armor API/Library) is a library that allows users to edit their avatar's armor, whether by adding pivots using a script or by using unique models and textures. | |||
<div class="mw-collapsible mw-collapsed"> | |||
<h4> | |||
Additional Resources | |||
<div class="mw-collapsible-toggle-placeholder"></div> | |||
</h4> | |||
<div class="mw-collapsible-content"> | |||
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1155212562980425818 How-To Guide] | |||
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1262160359905562705 Example Avatars] | |||
</div> | </div> | ||
</div> | </div> | ||
| Line 58: | Line 100: | ||
*ModdedSMP is a seasonal modpack server, each season coming with its own theme. | *ModdedSMP is a seasonal modpack server, each season coming with its own theme. | ||
Below is the Vanilla FiguraSMP address since the Modded SMP is currently between seasons | Below is the Vanilla FiguraSMP address since the Modded SMP is currently between seasons. | ||
vanilla.figuramc.org | vanilla.figuramc.org | ||
==='''4p5.nz''' 🛡️=== | ==='''4p5.nz''' 🛡️=== | ||
'''4p5.nz''' is an invite-only creative/operator server where players have free reign over the world around them. | '''4p5.nz''' is an invite-only creative/operator server where players have free reign over the world around them. | ||
4p5.nz | 4p5.nz | ||
Revision as of 19:30, 5 October 2024
This page is heavily unfinished.
Please wait before referring other people to this page. If you're able to, please contribute!
Some of the resources listed here are not officially endorsed by FiguraMC.
- Resources affiliated with FiguraMC will be marked as such with a ⭐ icon.
Documentation
Figs
Figs is an online documentation browser for Figura, making using Figura's built-in documentation easier to use.
Figura Wiki (YOU ARE HERE) ⭐
The Figura Wiki is an online wiki that aims to document Figura, its scripting language, modeling, etc.
Lua Documenation
Lua Quickstart Guide
Manuel's Lua Quickstart Guide is a quick, online tutorial guiding users through the basics of Lua syntax.
Lua 5.1 Manual
The Lua Manual is a long document describing the ins and outs of vanilla Lua. Although some of it will not apply to Figura Lua, it's still very useful for learning about the standard libraries.
Tutorials
Chloe's Video Tutorial Series
Chloe's Tutorial Series is a video series on YouTube that acts as a way for new users to get used to the mod. The series covers everything from modeling and modifying avatar.json files to scripting.
Tools
GS' Figura VSCode Documentation
GrandpaScout's Figura VSCode Documentation is an addon for Visual Studio Code (along with Code OSS and VSCodium) that adds Figura's documentation and snippets to sumneko's Lua Language Server plugin.
Additional Resources
Katt's Figura Blockbench Extension
The Figura Blockbench Extension adds a new model format to Blockbench, the Figura Model format. It extends the base Generic Model format by adding tools to make the avatar creation process easier, lifting restrictions to the Generic Model format that Figura supports, and removing features Figura doesn't.
Assets (Scripts, Libraries, APIs)
Some assets only exist within the FiguraMC Discord.
- Assets that link to the FiguraMC Discord will be marked with a 💬 icon.
Animation Helpers
GSAnimBlend
GSAnimBlend is a script that automatically adds blends to the start and end of animations.
Jimmy's Animation Handler
JimmyAnim (full name Jimmy's Animation Helper) is a library that plays specific Blockbench animations based on the player's current action.
Additional Resources
World Interactions
Origins API 💬
Katt's Origins API is an API that uses the player's NBT data to get information about the player's Origin.
Visual Elements
Confetti
Confetti is a library that allows users to add custom particles, either sprite or modelpart, to their avatars
Additional Resources
KattArmor 💬
KattArmor (sometimes called Katt Armor API/Library) is a library that allows users to edit their avatar's armor, whether by adding pivots using a script or by using unique models and textures.
Additional Resources
Community
FiguraMC Discord ⭐
The FiguraMC Discord Server is the central place for everything Figura, including help and support for the mod, avatar showcasing, and more. You'll also need to join this server to request whitelist to the FiguraSMP.
Minecraft Servers
Some servers listed below are whitelisted.
- Servers that have a public whitelist application process will be marked with a 🔒 icon.
- Servers that are invite-only will be marked with a 🛡️ icon.
Figura Plaza ⭐
Figura Plaza is a lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events.
plaza.figuramc.org
FiguraSMP ⭐🔒
The FiguraSMP is a set of two survival multiplayer servers—Vanilla and Modded—that are ran in affiliation with FiguraMC.
- Vanilla FiguraSMP is a server that stays close to the base game, only adding quality of life features for public servers.
- ModdedSMP is a seasonal modpack server, each season coming with its own theme.
Below is the Vanilla FiguraSMP address since the Modded SMP is currently between seasons.
vanilla.figuramc.org
4p5.nz 🛡️
4p5.nz is an invite-only creative/operator server where players have free reign over the world around them.
4p5.nz