Skip to content

Commit

Permalink
[GitHub Actions] ドキュメントの自動生成
Browse files Browse the repository at this point in the history
対象のコミット: 5506ee3
  • Loading branch information
github-actions[bot] committed Nov 4, 2023
1 parent 5506ee3 commit 8972de4
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 76 deletions.
76 changes: 38 additions & 38 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ This is "Cat maid (猫メイド)", the avatar for [Figura](https://modrinth.com/

Target Figura versions: [0.1.1](https://modrinth.com/mod/figura/version/0.1.1+1.20.1-0f8b7a9)~

![Main image](./README_Images/main.jpg)
![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)
![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)
![Dropping tail](../README_Images/drop_tail.jpg)

- Sometimes meows.
- Opens mouth when meowing.
Expand All @@ -30,9 +30,9 @@ Target Figura versions: [0.1.1](https://modrinth.com/mod/figura/version/0.1.1+1.

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

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

![Wink](./README_Images/action_wink.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.
Expand All @@ -41,63 +41,63 @@ Target Figura versions: [0.1.1](https://modrinth.com/mod/figura/version/0.1.1+1.

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

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

- Pales when she is sick or eat something inedible.

![Pale](./README_Images/pale.gif)
![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)
![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)
![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)
![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)
![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)
![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)
![Touch bell](../README_Images/touch_bell.gif)

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

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

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

![Back from AFK](./README_Images/afk.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)
![Glowing eyes](../README_Images/glow_eyes.jpg)

- The hair flutters with the player's movement.

![Fluttering hair](./README_Images/flutter_hair.gif)
![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)
![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.
Expand All @@ -109,66 +109,66 @@ Figura provides the action wheel with which players can play some actions (emote

### Page 1

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

#### Action 1-1. Smile
Meows and smiles.

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

#### Action 1-2. Wink
Meows and winks.

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

#### Action 1-3. Shining eyes
Meows and shines her eyes.

![Shining eyes](./README_Images/action_shine_eyes.gif)
![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)
![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)
![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)
![Intimidate](../README_Images/action_intimidate.gif)

#### Action 1-7. Downhearted
Downhearted. Right-click to pale.

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

### Page 2

![Action wheel 2](./README_Images/action_wheel_2.jpg)
![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)
![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)
![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)
![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)
![Shaking body](../README_Images/action_body_shaking.gif)

#### Action 2-5. Toggle summer feature
Toggles summer feature.
Expand All @@ -179,12 +179,12 @@ 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)
![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)
![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.
Expand All @@ -204,7 +204,7 @@ Toggles whether [the avatar shakes its body](#action-2-4-body-shaking) or not wh
### Action 7. Toggle afk actions
Toggles if afk actions are played or not.

![Fall asleep](./README_Images/doze2.gif)
![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 [Quilt](https://quiltmc.org/).
Expand All @@ -227,7 +227,7 @@ In this section, I will explain structures of the textures. The skin texture are
### main.png
This is the main texture.

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

1. Vanilla skin
- Only supports the slim model.
Expand All @@ -245,7 +245,7 @@ This is the main texture.
### eyes.png
This texture is for the eyes.

![Eyes texture](./README_Images/texture_eyes.jpg)
![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.
Expand All @@ -270,7 +270,7 @@ This texture is for the eyes.
### mouths.png
This texture is for the mouth.

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

- The mouths are arranged in the following order from left to right.
- Closed mouth
Expand Down
Loading

0 comments on commit 8972de4

Please sign in to comment.