Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/gakuto1112/butterflywings

The avatar for Figura, the skin mod for Minecraft, which adds butterfly wings and feelers.
https://github.com/gakuto1112/butterflywings

figura lua minecraft minecraft-skin

Last synced: 2 months ago
JSON representation

The avatar for Figura, the skin mod for Minecraft, which adds butterfly wings and feelers.

Awesome Lists containing this project

README 

        
Language: 　**English**　|　[日本語](./README_jp.md)



# ButterflyWings



This is the avatar for [Figura](https://modrinth.com/mod/figura), the skin mod for [Minecraft](https://www.minecraft.net/en-us), which adds butterfly wings and feelers.



Target Figura version: [0.1.5](https://modrinth.com/mod/figura/version/0.1.5b+1.21.4)



![Main](./README_images/main.jpg)



## Features

**Notes**

- The skin of this avatar will be your one (The skin appears in the attached screenshots is not included with the avatar).

- Hereafter, the color of the wings will be presented as default.



---



- Has butterfly wings and feelers.



  ![Butterfly wings](./README_images/butterfly_wings.jpg)



  - The are usually closed, but will be opened when flapping or snaking.



    ![Open wings](./README_images/open_wings.jpg)



- The color and opacity of the wings can be changed as you like.

  - You can change 4 regions of color in the wings.

  - Also has the color import/export feature and the feature which stores up to 6 color sets.



  ![Wing colors](./README_images/wing_colors.jpg)



- The wings flap when staying in the air.

  - "Staying in the air" means doing the following actions:

    - Creative flying

    - Elytra flying

    - Having a slow falling effect

  - Unique animations will be played when moving or stopping in creative flight.

  - Particles will emit from the wings when the flapping.

    - Their color will be same as the color of the wings.

    - Can be changes their display duration in the action wheel.

    - They look good in the dark because they glow (look better with the shaders).

  - The flapping sound will be played small when flapping.



  ![Flapping](./README_images/flap.gif)



- The feelers will sway with the player's movements.



  ![Feelers](./README_images/feelers.gif)



- The wings will glow in the dark.

  - This feature can be disabled in the action wheel.

  - This isn't the feature to make the wings light sources.



  ![Glow wings](./README_images/glow_wings.jpg)



- The wings will be tattered as the player's health decreases.

  - Their flying abilities won't be weak even if their wings are tattered.



  ![Tattered wings](./README_images/tattered_wings.jpg)



- Sleeps on your back not to interfere the wings and the bed.



  ![Sleeping pose](./README_images/sleeping_pose.jpg)



## The action wheel

Figura provides the action wheel with which players can play some actions (emotes, animations, configs, and etc.). It will be shown when holding the action wheel key (default is B key). This avatar also has some actions.



### Page1

![The action wheel 1](./README_images/action_wheel_1.jpg)



#### Action 1-1~1-4. Change wing colors

Specifies the color with the color picker and changes wing colors. The wing areas where can be changed are followings:



1. Wing base gradient top

2. Wing base gradient bottom

3. Edge

4. Pattern



![Color picker](./README_images/color_picker.jpg)



##### Color picker action 1. Current color

Displays current color.



##### Color picker action 2~4. Change hue, saturation, and brightness

Changes hue, saturation, and brightness by scrolling on each actions. You can scroll faster by holding the sprint key (default is L-Ctrl).



##### Color picker action 5. Copy/Paste

Left-click to copy the current color. Then, right-click to paste the copied color. The copied color will be erased after unloading the avatar.



##### Color picker action 6. Reset color

Resets the color to default.



##### Color picker action 7. Close color picker

Left-click to apply the selected color and close the color picker. Right-click to close the color without applying it.



#### Action 1-5. Change wing opacity

Changes the wing opacity by scrolling on the action. You can scroll faster by holding the sprint key (default is L-Ctrl).



#### Action 1-6. Toggle wing glow

Toggles whether the wings glow or not.



#### Action 1-7. Change particle durations

Changes durations of the particle which are emitted while flapping the wings by scrolling on the action. The options are followings:



| name | duration (seconds) |

| - | - |

| none | 0 |

| short | 1.5 |

| normal | 3 |

| long | 6 |

| very long | 12 |



### Page 2

![The action wheel 2](./README_images/action_wheel_2.jpg)



#### Action 2-1. The color palette

Saves/Loads color sets (called palettes).



![The color palette](./README_images/color_palette.jpg)



##### Color palette action 1. Current palette

Showing current palette. Left-click to copy current palette to the clipboard. You can save it as a text file. Right-click to apply the color palette from the clipboard.



##### Color palette action 2~7. Palettes

Saves up to 6 palettes. The default palette is saved in each slots if the slot is empty. Left-click to load and apply the palette. Right-click to save current palette.



##### Color palette action 8. Close the color palette

Closes the color palette.



#### Action 2-2. Check for avatar updates

Left click to check for avatar updates. You can try to check updates again even if the check fails. In addition to manually checking for updates from here, the script will automatically check for updates once a day.



> [!IMPORTANT]

> To check for avatar updates, you must turn on "Allow Networking" and add `api.github.com` to the Network Filter from Figura settings!



> [!CAUTION]

> It is DANGEROUS to use a network filter other than "Whitelist" when activating Figura's Networking Feature. Although this avatar uses secure links, there is no guarantee that links used by other players' avatars are secure. I'm not responsible for any damages caused by using this feature.



> [!WARNING]

> If you repeatedly check for updates in a short period of time, GitHub will impose a temporary restriction and avatar scripts will not be able to check for updates for a while.



Right click to copy the latest avatar download link to your clipboard. Please access the download page from your browser.Please note that if you have not checked for updates once or have not checked for updates for a long period of time, you will not get the correct link.



## Avatar version display

From v1.1.0, when the action wheel is open, the version of avatar currently in use and whether it has been updated are displayed in the upper left corner of the screen.



![avatar version display](./README_images/version_information.jpg)



Updates are automatically checked once a day, but can also be done manually via the [action wheel](#action-2-2-check-for-avatar-updates).



A notification will be sent when a new avatar version is available. You can get the download link for the latest version from the [action wheel](#action-2-2-check-for-avatar-updates), which you can access from your browser.



> [!IMPORTANT]

> To check for avatar updates, you must turn on "Allow Networking" and add `api.github.com` to the Network Filter from Figura settings!



> [!CAUTION]

> It is DANGEROUS to use a network filter other than "Whitelist" when activating Figura's Networking Feature. Although this avatar uses secure links, there is no guarantee that links used by other players' avatars are secure. I'm not responsible for any damages caused by using this feature.



> [!WARNING]

> If you repeatedly check for updates in a short period of time, GitHub will impose a temporary restriction and avatar scripts will not be able to check for updates for a while.



## How to use

Figura is available in [Forge](https://files.minecraftforge.net/net/minecraftforge/forge/), [Fabric](https://fabricmc.net/) and [NeoForge](https://neoforged.net/).



1. Install the mod loader which you want to use and make the mods available.

2. Install [Figura](https://modrinth.com/mod/figura). Note the mod dependencies.

3. Go to the [release page](https://github.com/Gakuto1112/ButterflyWings/releases).

   - You can also go there from the right side of [the repository's home page](https://github.com/Gakuto1112/ButterflyWings).

4. Download the avatar of your choice that attached to "Assets" section of the release notes.

5. Unzip the zipped file and take the avatar data inside this.

6. Put avatar files at `/figura/avatars/`.

   - The directory will automatically generated after launching the game with Figura installed. You can also create it manually if it doesn't exist.

7. Open the Figura menu (Δ mark) from the game menu.

8. Select the avatar from the avatar list at the left of the Figura menu.

9. Sets your permission if you need.

10. Other Figura players can see your avatar after uploading your avatar to the Figura server.

    - **If your Minecraft is Pirated (cracked, unlicensed, free), you cannot upload your avatar.** This is a Figura specification and I cannot help you with this.



## Notes

- I'm not responsible for any damages caused by using this avatar.

- This avatar is designed for work with no resource pack and no other mods are installed. An unexpected issue may occurs when you use it with any resource packs and mods (texture and armor inconsistencies, etc.). However, I may not support you in these cases.

- Please [report an issue](https://github.com/Gakuto1112/ButterflyWings/issues) if you find it.

- Please contact me via [Discussions](https://github.com/Gakuto1112/ButterflyWings/discussions) or [Discord](https://discord.com/) if you want to do for my avatars. My Discord name is "vinny_san" and display name is "ばにーさん". My display name in [Figura Discord server](https://discord.gg/figuramc) is "BunnySan/ばにーさん".