https://github.com/gakuto1112/catmaid

"Cat Maid (猫メイド)" the avatar for Figura, the skin mod for Minecraft.
https://github.com/gakuto1112/catmaid

figura lua minecraft minecraft-skin

Last synced: about 2 months ago
JSON representation

"Cat Maid (猫メイド)" the avatar for Figura, the skin mod for Minecraft.

• Host: GitHub
• URL: https://github.com/gakuto1112/catmaid
• Owner: Gakuto1112
• License: mit
• Created: 2022-05-10T09:17:55.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-13T06:30:55.000Z (6 months ago)
• Last Synced: 2024-07-13T07:37:30.834Z (6 months ago)
• Topics: figura, lua, minecraft, minecraft-skin
• Language: Lua
• Homepage:
• Size: 12.9 MB
• Stars: 18
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: .github/README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

# CatMaid (猫メイド)

This is "Cat maid (猫メイド)", the avatar for [Figura](https://modrinth.com/mod/figura), the skin mod for [Minecraft](https://www.minecraft.net/en-us).

Target figura version: [0.1.4](https://modrinth.com/mod/figura/version/0.1.4+1.20.1)

(Some avatar functions don't work correctly in Minecraft 1.20.4 doe to [a bug in Figura](https://github.com/FiguraMC/Figura/issues/197). I recommend using in Minecraft 1.20.1.)

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

## Features

- Has cat ears, cat tail, and maid skirt.

  - The ears are sometimes animated.

  - The tail wags left and right (can be disabled in [avatar settings](#avatar-settings)).

	![Wag tail](./README_images/wag_tail.gif)

  - The tail stands or dropped depending on the player's health and saturation.

	![Dropping tail](./README_images/drop_tail.jpg)

- Sometimes meows.

  - Opens mouth when meowing.

  - Her meow changes when low health and saturation.

- Sometimes the ears move.

  - Which one moves is depend on the player's dominant hand.

- Sometimes blinks.

- Her expression will change when taking a damage, low health, or low saturation.

- Smiles or winks in [the action wheel](#the-action-wheel).

  ![Smile](./README_images/action_smile.gif)

  ![Wink](./README_images/action_wink.gif)

- Players bell sounds when walking and jumping (can be disabled in [avatar settings](#avatar-settings)).

  - The volume of bell sounds will be reduced to 1/5 when sneaking.

- Plays cat hurts sounds when taking a damage.

- The eyes shine when holding the favorite foods. Satisfies and meows when eating them.

  ![The favorite food](./README_images/favorite_food.gif)

- Pales when she is sick or eat something inedible.

  ![Pale](./README_images/pale.gif)

- Sleeps like a cat at bedtime.

  - The view at bedtime ws also changed to match the pose.

  - Purrs at bedtime.

	![Sleeping](./README_images/sleep.jpg)

- Holds a cake like a maid.

  - The design of the cake is occasionally changed.

  ![Hold a cake](./README_images/cake.jpg)

- Gets wet when touching water.

  - Can flick water droplets off the body by shaking the body.

  ![Getting wet](./README_images/wet.gif)

- Will be frightened and tremble when a [warden](https://minecraft.wiki/w/Warden) is nearby her (≒ has the darkness effect).

  ![Scared of warden](./README_images/scared_of_warden.jpg)

  - Holds the ball not to make sounds and refuses playing animations when she is frightened.

    ![Refusing animations](./README_images/refuse_animation.gif)

- Plays animations when being left alone for a short while (can be disabled in [avatar settings](#avatar-settings)).

  - Touches her bell every 30 seconds.

  ![Touch bell](./README_images/touch_bell.gif)

  - Falls asleep after 5 minutes have passed since she was left alone.

  ![Doze](./README_images/doze.gif)

  ![Fall asleep](./README_images/doze2.gif)

  ![Back from AFK](./README_images/afk.gif)

- Glows the eyes like a cat when the player has a night vision effect.

  - You cannot see the glowing eyes by yourself because of night vision specifications.

  - Use a shader pack if you really want to check them.

  ![Glowing eyes](./README_images/glow_eyes.jpg)

- The hair flutters with the player's movement.

  ![Fluttering hair](./README_images/flutter_hair.gif)

- Has various types of ears and tail textures based on vanilla cats. You can change them in [avatar settings](#avatar-settings).

  ![Various tails](./README_images/various_tails.jpg)

- Has a summer features! Changes her costume to swimsuit when enabled.

  - Changes a leather helmet to a summer hat.

  - Changes a turtle shell to a snorkel.

    - Raises the snorkel when out of water.

## 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.

### Page 1

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

#### Action 1-1. Smile

Meows and smiles.

![Smile](./README_images/action_smile.gif)

#### Action 1-2. Wink

Meows and winks.

![Wink](./README_images/action_wink.gif)

#### Action 1-3. Shining eyes

Meows and shines her eyes.

![Shining eyes](./README_images/action_shine_eyes.gif)

#### Action 1-4. Unequaled eyes

Meows and shows unequaled eyes with full of joy.

![Unequaled eyes](./README_images/action_unequal_eyes.gif)

#### Action 1-5. Surprised

Surprised and sweats. Right-click to pale.

![Surprised](./README_images/action_surprised.gif)

#### Action 1-6. Intimidate

Intimidates against enemies. The hairs on the tail stand on the end. Left-click to intimidate softly, Right-click to intimidate hard.

![Intimidate](./README_images/action_intimidate.gif)

#### Action 1-7. Downhearted

Downhearted. Right-click to pale.

![Downhearted](./README_images/action_downhearted.gif)

### Page 2

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

#### Action 2-1. Pat (head)

You will pat her head (The displayed arm will be your skin).

![Pats head](./README_images/action_pat_head.gif)

#### Action 2-2. Pat (tails)

You will pat her tail (The displayed arm will be your skin). This makes her angry because cats hate being touched their tails.

![Pats tail](./README_images/action_pat_tail.gif)

#### Action 2-3. Sitting down

Sits down there. She will stand up when playing this action again. She will also stand up when moving, jumping, or sneaking while setting down.

![Shitting down](./README_images/action_sit_down.jpg)

#### Action 2-4. Body shaking

Shakes her body. This action can flick water droplets off the body when getting out of water/rain.

![Shaking body](./README_images/action_body_shaking.gif)

#### Action 2-5. Toggle summer feature

Toggles summer feature.

#### Action 2-7. Open avatar settings

Opens [avatar settings](#avatar-settings).

## Avatar settings

You can open this avatar settings by clicking [action 2-7](#action-2-7-open-avatar-settings). You can close it by closing the action wheel once.

![Avatar settings](./README_images/avatar_settings.jpg)

### Action 1. Ears and tail type

Changes type of the ears and tail. Scroll to select the option and close the action wheel to confirm.

![Cat types](./README_images/various_tails.jpg)

### Action 2. Change volume of bell sounds

Changes the volume of bell sounds. Scroll to increase or decrease in 5% increments and close the action wheel to confirm.

### Action 3. Toggle cat's meow

Toggles whether periodic cat's meows are played or not.

### Action 4. Toggle tail wagging

Toggles if the avatar wags its tail or not.

### Action 5. Toggle armors visible

Toggles whether equipped armors are visible or not. The maid skirt will be hidden not to interfere with the armors while equips them. This setting will only affects to vanilla armors.

### Action 6. Toggle auto body shaking

Toggles whether [the avatar shakes its body](#action-2-4-body-shaking) or not when getting wet.

### Action 7. Toggle afk actions

Toggles if afk actions are played or not.

![Fall asleep](./README_images/doze2.gif)

## 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/CatMaid/releases).

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

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.

## Textures

In this section, I will explain structures of the textures. The skin texture are created based on the vanilla skin, so you can change the skin of the avatar by replacing the texture. Only those directly related to the vanilla skin are explained here.

### main.png

This is the main texture.

![Main texture](./README_images/texture_main.jpg)

1. Vanilla skin

   - Only supports the slim model.

   - The eyes (and mouth) should be drawn in [eyes.png](#eyespng) and [mouth.png](#mouthspng) separately.

2. The ribbon to be attached to the tail

   - It's the same as the ribbon to be attached to the bell.

3. Bell

4. Front hair

5. Back hair

6. The ribbon on the back

7. Maid skirt

8. Over layer of the maid skirt

9. Swim suit skin for summer feature

### eyes.png

This texture is for the eyes.

![Eyes texture](./README_images/texture_eyes.jpg)

- Textures of the eyes and mouth have doubled resolution compared to other textures.

- It is easier to understand if you divide this texture into 6x6 pixels.

- The parts are arranged in the following order from top to bottom.

  - Non-glowing areas of the right eye (eyebrows, etc.)

  - Glowing areas of the right eye

  - Non-glowing areas of the left eye (eyebrows, etc.)

  - Glowing areas of the left eye

- The eyes are arranged in the following order from left to right.

  - Normal eyes

  - Shining eyes

  - Surprised eyes

  - Surprised eyes while being weak (low health, saturation)

  - Intimidated eyes

  - Intimidated eyes while being weak (low health, saturation)

  - Downhearted eyes

  - Downhearted eyes while being weak (low health, saturation)

  - Weak (low health, saturation) eyes

  - Sleeping eyes

  - Closed eyes

### mouths.png

This texture is for the mouth.

![Mouth texture](./README_images/texture_mouth.jpg)

- The mouths are arranged in the following order from left to right.

  - Closed mouth

  - Opened mouth

  - Intimidated mouth

## 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.

- There may be a bug which occurs in multiplayer because my ([Gakuto1112](https://github.com/Gakuto1112)) multiplayer environment to verify the avatar is insufficient.

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

- Please contact me via [Discussions](https://github.com/Gakuto1112/CatMaid/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/ばにーさん".

## Credits

- Bell sound: Otojin "Bell sound 04" (音人「鈴の音04」) ( https://on-jin.com/sound/sei.php?bunr=ベル・鐘・鈴&kate=道具 )