Community Resources: Difference between revisions
m →Minecraft Servers: minor spelling mistake |
Remove the "heavily unfinished" notice, I've finished out the assets. |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Notice | {{Notice | ||
|content='''Some of the resources listed here are not officially endorsed by FiguraMC.'''<br> | |content='''Some of the resources listed here are not officially endorsed by FiguraMC.'''<br> | ||
| Line 8: | Line 4: | ||
}} | }} | ||
= Documentation = | = Documentation = | ||
=== | ===[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. | The '''Figura Wiki''' is an online wiki that aims to document Figura, its scripting language, modeling, etc. | ||
== Lua Documenation == | == 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. | '''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. | 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]=== | ||
'''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 = | = 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]. | '''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]. | ||
{{Collapsible | |||
|content=* [https://github.com/GrandpaScout/FiguraRewriteVSDocs/wiki Install Guide] | |||
|label=Additional Resources | |||
}} | |||
===[https://github.com/KitCat962/figura-format-bbplugin Katt's Figura Blockbench Extension]=== | |||
* [https://github.com/GrandpaScout/FiguraRewriteVSDocs/wiki Install Guide] | |||
=== | |||
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. | 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) = | ||
| Line 39: | Line 30: | ||
* Assets that link to the FiguraMC Discord will be marked with a 💬 icon. | * Assets that link to the FiguraMC Discord will be marked with a 💬 icon. | ||
}} | }} | ||
== Script Helpers == | |||
===[https://github.com/Manuel-3/figura-scripts/tree/main/src/runLater Run Later]=== | |||
'''Run Later''' is a script that allows users to run code after a set amount of time or after a condition is met, similar to a wait/sleep/halt instruction except it runs a function after the wait instead of the rest of the code. | |||
== Animation Helpers == | == Animation Helpers == | ||
=== | ===[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. | ||
=== | ===[https://github.com/JimmyHelp/JimmyAnims 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. | '''JimmyAnim''' (full name Jimmy's Animation Helper) is a library that plays specific Blockbench animations based on the player's current action. | ||
{{Collapsible | |||
|content=* [https://jimmyhelp.notion.site/JimmyAnims-79adfdca2fe04f9c9ede5e0bfd898b6a Documentation] | |||
* [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] | ||
|label=Additional Resources | |||
}} | |||
== World Interactions== | == 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]. | 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]. | ||
===[https://github.com/GrandpaScout/GSServerNet GSServerNet]=== | |||
'''GSServerNet''' allows Figura to communicate with the server/world the player is in using a companion datapack. | |||
==Visual Elements== | ==Visual Elements== | ||
=== | ===[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 | ||
{{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/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] | ||
|label=Additional Resources | |||
}} | |||
=== | ===[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. | '''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. | ||
{{Collapsible | |||
|content=* [https://discord.com/channels/1129805506354085959/1137506926742216835/1155212562980425818 How-To Guide] | |||
* [https://discord.com/channels/1129805506354085959/1137506926742216835/1262160359905562705 Example Avatars] | |||
|label=Additional Resources | |||
}} | |||
===[https://github.com/MitchOfTarcoola/MOARArmsAPI MOAR Arms API]=== | |||
'''MOAR Arms API''' is a library that makes making an avatar with multiple arms easier, allowing an avatar to appear to hold more than two items at once. | |||
===[https://github.com/lua-gods/figuraLibraries/tree/main/tail%20and%20ears Tail and Ears Physics]=== | |||
'''Tail and Ears Physics''' is a script that gives physics to a set of ears and multiple parts of a tail. | |||
{{Collapsible | |||
|content=* [https://github.com/lua-gods/figuraLibraries/blob/main/tail%20and%20ears/examples.lua Example Usage] | |||
|label=Additional Resources | |||
}} | |||
===[https://github.com/lua-gods/figuraLibraries/blob/main/plushie/plushie.lua Plushie]=== | |||
'''Plushie''' snaps a skull model (specified in the config) to the floor below it and scales the model based on the amount above it. | |||
= Community = | = Community = | ||
=== | ===[https://discord.figuramc.org 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. | 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 == | == Minecraft Servers == | ||
| Line 93: | Line 84: | ||
}} | }} | ||
=== Figura Plaza ⭐ === | === Figura Plaza ⭐ === | ||
'''IP: < | '''IP: <code style="user-select: all">plaza.figuramc.org</code>''' • '''Version: 1.16.5 - 1.21''' | ||
The '''Figura Plaza''' is an official lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events. The server does not have any survival gameplay, and disables PvP by default. The server also provides a selection of free temporary items to use when testing avatars. | The '''Figura Plaza''' is an official lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events. The server does not have any survival gameplay, and disables PvP by default. The server also provides a selection of free temporary items to use when testing avatars. | ||
=== Figura SMP ⭐🔒 === | === Figura SMP ⭐🔒 === | ||
'''IP: < | '''IP: <code style="user-select: all">vanilla.figuramc.org</code>''' • '''Version: 1.21''' | ||
The '''Figura SMP''' (also referred to as Vanilla SMP) is an official survial server that stays close to the base game, plus a few server-side mods for quality-of-life purposes. You are perfectly able to join this server without any mods, and even on a vanilla client. You can read the server rules in [https://discord.com/channels/1129805506354085959/1130186794873405510 #info] and get whitelisted by putting your name in [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist | The '''Figura SMP''' (also referred to as Vanilla SMP) is an official survial server that stays close to the base game, plus a few server-side mods for quality-of-life purposes. You are perfectly able to join this server without any mods, and even on a vanilla client. You can read the server rules in the [https://discord.figuramc.org FiguraMC Discord Server]'s [https://discord.com/channels/1129805506354085959/1130186794873405510 #info] channel and get whitelisted by putting your name in [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist]. | ||
==== Modded SMP ==== | ==== Modded SMP ==== | ||
'''IP: < | '''IP: <code style="user-select: none">[TBD]</code>''' • '''Version: 1.20.1-fabric''' • '''Modpack: <span style="user-select: none">[TBD]</span>''' | ||
The '''Modded SMP''' is a seasonal modpack server adjacent to Figura SMP, each season coming with its own theme. '''Currently offline.''' The next season is themed after a nuclear apocalypse and is set for release Soon™. | The '''Modded SMP''' is a seasonal modpack server adjacent to Figura SMP, each season coming with its own theme. '''Currently offline.''' The next season is themed after a nuclear apocalypse and is set for release Soon™. The ModdedSMP shares a whitelist with the VanillaSMP, meaning that [https://discord.com/channels/1129805506354085959/1130187119680311470 #whitelist] will whitelist you for both servers. | ||
=== | === 4p5.nz 🛡️ === | ||
'''IP: < | '''IP: <code style="user-select: all">4p5.nz</code>''' • '''Version: 1.20.1''' | ||
'''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. | ||
Latest revision as of 01:15, 6 October 2024
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.
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.
Script Helpers
Run Later
Run Later is a script that allows users to run code after a set amount of time or after a condition is met, similar to a wait/sleep/halt instruction except it runs a function after the wait instead of the rest of the code.
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.
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.
GSServerNet
GSServerNet allows Figura to communicate with the server/world the player is in using a companion datapack.
Visual Elements
Confetti
Confetti is a library that allows users to add custom particles, either sprite or modelpart, to their avatars
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.
MOAR Arms API
MOAR Arms API is a library that makes making an avatar with multiple arms easier, allowing an avatar to appear to hold more than two items at once.
Tail and Ears Physics
Tail and Ears Physics is a script that gives physics to a set of ears and multiple parts of a tail.
Plushie
Plushie snaps a skull model (specified in the config) to the floor below it and scales the model based on the amount above it.
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 ⭐
IP: plaza.figuramc.org • Version: 1.16.5 - 1.21
The Figura Plaza is an official lobby-like server where players can join, hang out with other Figura users, make avatars in company, play games, and occasionally attend events. The server does not have any survival gameplay, and disables PvP by default. The server also provides a selection of free temporary items to use when testing avatars.
Figura SMP ⭐🔒
IP: vanilla.figuramc.org • Version: 1.21
The Figura SMP (also referred to as Vanilla SMP) is an official survial server that stays close to the base game, plus a few server-side mods for quality-of-life purposes. You are perfectly able to join this server without any mods, and even on a vanilla client. You can read the server rules in the FiguraMC Discord Server's #info channel and get whitelisted by putting your name in #whitelist.
Modded SMP
IP: [TBD] • Version: 1.20.1-fabric • Modpack: [TBD]
The Modded SMP is a seasonal modpack server adjacent to Figura SMP, each season coming with its own theme. Currently offline. The next season is themed after a nuclear apocalypse and is set for release Soon™. The ModdedSMP shares a whitelist with the VanillaSMP, meaning that #whitelist will whitelist you for both servers.
4p5.nz 🛡️
IP: 4p5.nz • Version: 1.20.1
4p5.nz is an invite-only creative/operator server where players have free reign over the world around them.