Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gakuto1112/senkosan

"Senko-san (仙狐さん)" the avatar for Figura, the skin mod for Minecraft.
https://github.com/gakuto1112/senkosan

anime figura lua minecraft minecraft-skin senko senko-san

Last synced: 4 days ago
JSON representation

"Senko-san (仙狐さん)" the avatar for Figura, the skin mod for Minecraft.

Awesome Lists containing this project

README

        

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

# Information
![Senko head](./README_images/head_senko.png)
This is the branch for **Senko**.

![Shiro head](./README_images/head_shiro.png)
Click [here](https://github.com/Gakuto1112/SenkoSan/tree/Shiro) for the branch for **Shiro**.

![Suzu head](./README_images/head_suzu.png)
Click [here](https://github.com/Gakuto1112/SenkoSan/tree/Suzu) for the branch for **Suzu**.

![Sora head](./README_images/head_sora.png)
Click [here](https://github.com/Gakuto1112/SenkoSan/tree/Sora) for the branch for **Sora**.

---

# Senko-san (仙狐さん)

This is "Senko-san (仙狐さん)", the avatar for [Figura](https://modrinth.com/mod/figura), the skin mod for [Minecraft](https://www.minecraft.net/en-us), which is imitated the character who appears in the TV anime "Sewayaki Kitsune no Senko-san" series and the original manga series.

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

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

## Features
- Has ears and tail models.
- Her tail sways with the player's movement.

![Swaying tail](./README_images/swaying_tail.gif)

- You can jerk the ears with **X key** and wag the tail with **Z key**.

![Jerk ears](./README_images/jerk_ears.gif)

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

- Her ears droop and har facial expression changes depending on the player's health and satiety.

![HP and the avatar](./README_images/hp_avatar.jpg)

- Sometimes she blinks.

- Can play various animations with [the action wheel](#the-action-wheel).

![Broom sweeping](./README_images/action_bloom_cleaning.gif)

- Can sit down with [the action wheel](#action-2-1-sitting-down).
- Some animations can be played only when sitting down.

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

- Can change the facial expressions with the cursor keys (↑→↓←).

![Key emotes](./README_images/key_emotes.jpg)

- Changes vanilla swords to [Naginatas](https://en.wikipedia.org/wiki/Naginata) (from episode 77 of the manga).
- Holds the naginata when held in the main hand (not in the off hand).
- Takes a defensive stance with naginata when using a shield while holding a naginata.

![Naginata](./README_images/naginata.jpg)

- Sleeps like a fox at bedtime (from episode 2 of the anime).
- Takes another sleeping pose (?) when she has the darkness effect.

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

- She will sleep with you when she sleeps on a valid double bed.
- "A valid double bed" means that two (or more) beds are adjacent to each other and facing the same direction, and neither of these beds are in use.
- The skin of the dummy player will be your one.
- The bed in which the dummy player sleeps is actually not in use, so other players or villagers may sleep in the bed. She will change to the normal sleeping animation in this case.
- When you sleep in the first person with her...?

![Sleeping together](./README_images/sleeping_togheter.jpg)

- Can change the costume from about 20 different costumes. You can check [the costume catalog](./costume_catalog.md) to know what costumes are available.

![Outgoing costume](./README_images/costume_outgoing.jpg)

- Can take some poses for taking a picture.

![Photo poses](./README_images/photo_pose.jpg)

- Grooms her tail and relaxes in the [kotatsu](https://en.wikipedia.org/wiki/Kotatsu) when being left alone for a short while.

![Grooming tail](./README_images/action_tail_grooming.gif)

![Relaxing in kotatsu](./README_images/kotatsu.jpg)

- Can change your display name to her name.
- **Other players also need to install Figura and give enough permissions** to see your display name.

![Changing name](./README_images/name_change.jpg)

- Changes your head block to her figures (can changes in [the settings](#action-4-3-player-head-change)).
- [The figure on the top-left of the image](https://www.goodsmile.info/ja/product/9273/仙狐.html)
- [The figure on the top-center of the image](https://www.geestore.com/detail/id/00000093048)
- [The figure on the top-left of the image](https://www.amazon.co.jp/gp/product/B07XZ6754D)
- The figure on the bottom-right of the image was made based on an illustration from the back of volume 10 of the manga.
- [The figure on the bottom-right of the image](https://twitter.com/Kanda_omiyage/status/1627141001197531136?t=pWBnib7WuzlAD-uUdDcqIg&s=19)

![Player head](./README_images/player_heads.jpg)

- Gets wet when touching water/rain.
- Shakes her body and flicks water droplets off the body when getting out of water/rain (can disable in [the settings](#action-4-4-toggle-auto-body-shaking)).

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

- Her tail shrivels up when getting whe.

![Shriveled tail](./README_images/shriveled_tail.jpg)

- Takes an umbrella if it's raining.
- Won't get wet when taking it.
- Won't take it when holding an item in off hand or playing an animation (of course, she gets wet in the case).
- The umbrella open/close sound can disable in [the settings](#action-4-7-toggle-umbrella-openclose-sound).

![Umbrella](./README_images/umbrella.jpg)

- Appears foxfires (small fireballs) around her when she has the night vision effect.
- The number of foxfires is different depends on the character.
- They are extinguished when getting wet.
- Using a shader pack make them look more like foxfires thanks to its bloom effects.

![Foxfires](./README_images/foxfires.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)

- Refuses playing animations when she is frightened.

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

## 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 (the standing actions)

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

#### Action 1-1. Smile (uyan♪)
Plays the smile animation which is played at the end of other actions. Left-click to just smile, and right-click to play with the sound and particles.

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

#### Action 1-2. Body shaking
Plays the body shake animation which plays when getting out of water manually.

![Body shaking](./README_images/action_body_shaking.gif)

#### Action 1-3. Cleaning
Left-click to play broom sweeping, and right-click to play wipe cleaning. The broom sweeping animation has the rare version (The rare version is from episode 4 of the anime).

![Broom sweeping](./README_images/action_bloom_cleaning.gif)

![Wipe cleaning](./README_images/action_wipe_cleaning.gif)

#### Action 1-4. Hair cutting
She will trim your hair (from episode 9 of the anime, the skin will be your one). She also cut a little too...

![Hair cutting](./README_images/action_hair_cutting.gif)

#### Action 1-5. Fox jump
Dive into the snow like a fox (from episode 10 of the anime). Enough snow and space is needed to play this action.

![Fox jump](./README_images/action_fox_jump.gif)

#### Action 1-6. Tail grooming
Brushes her tail to increase the "flulity" (fluffy quality of the tail) (from episode 16.5 of the manga). This action can be played while standing of sitting.

![Tail grooming](./README_images/action_tail_grooming.gif)

#### Action 1-7. Kotatsu
Relaxes in the Kotatsu (from episode 10 of the anime). This action won't stop due to the passage of time.

![Relaxing in kotatsu](./README_images/kotatsu.jpg)

### Page 2 (the sitting actions)

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

#### Action 2-1. 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-2. Tail cuddling
You will cuddle her tail (from episode 1 of the anime, the skin will be your one). This action can be played while sitting. However, it can't be played when she wears outgoing costume or armors are visible.

![Tail cuddling](./README_images/action_tail_cuddling.gif)

#### Action 2-3. Ears cuddling
You will cuddle her ears (from episode 2 of the anime, the skin will be your one). This action can be played while sitting. However, it can't be played when she wears the costume which covers her ears.

![Ears cuddling](./README_images/action_ears_cuddling.gif)

#### Action 2-4. Ear pick
Cleans your ears on her kneecap (from episode 2 of the anime, the skin will be your one). This action can be played while sitting.

![Ear pick](./README_images/action_ear_pick.gif)

#### Action 2-5. Tea time
Takes a sip of [Hojicha](https://en.wikipedia.org/wiki/Hōjicha) (from episode 6 of the anime). This action can be played while sitting.

![Tea time](./README_images/tea_time.gif)

#### Action 2-6. Massage
Takes the stiffness out of your shoulders (from episode 6 of the anime, the skin will be your one). This action can be played while sitting.

![Massage](./README_images/massage.gif)

### Page 3 (the photo poses)

![Action wheel 3](./README_images/action_wheel_3.jpg)

Poses in 7 different poses. Can be used for photo shoots. Her umbrella will be used as a prop for pose 7.

![Photo pose](./README_images/photo_pose.jpg)

### Page 4 (avatar settings 1)

![Action wheel 4](./README_images/action_wheel_4.jpg)

#### Action 4-1. Change costume
Changes her [costume](./costume_catalog.md). Scroll to select the costume and closing the action wheel to confirm. Left-click to reset to current selection, and right-clock to reset to default during selection.

#### Action 4-2. Change display name
Changes the player's display name. Scroll to select the name and closing the action wheel to confirm. Left-click to reset to current selection, and right-clock to reset to default during selection. However, **Other players also need to install Figura and give enough permissions** to see your display name.

![Display name](./README_images/name_change.jpg)

The name option which can be set are as follows:

- <Player name>
- Senko
- 仙狐
- Senko_san
- 仙狐さん
- Sen
- 仙
- セン

#### Action 4-3. Change player head
Changes the model of the "player head". Scroll to select the model and closing the action wheel to confirm. Left-click to reset to current selection, and right-clock to reset to default during selection.

![Player head](./README_images/player_heads.jpg)

The model option which can be set are as follows:

- Default (the avatar's head model only)
- The figure([reference](https://www.goodsmile.info/ja/product/9273/仙狐.html))
- The maid figure([reference](https://www.geestore.com/detail/id/00000093048))
- The cheerleader figure([reference](https://www.amazon.co.jp/gp/product/B07XZ6754D))
- The fox hoodie figure was made based on an illustration from the back of volume 10 of the manga.
- The kimono figure([reference](https://twitter.com/Kanda_omiyage/status/1627141001197531136?t=pWBnib7WuzlAD-uUdDcqIg&s=19))

Your "player heads" which other players/mobs wear will be the default heads regardless of this settings.

You can get your "player head" by using the following command with cheat mode:
```
/give @p minecraft:player_head{SkullOwner: ""} 1
```

#### Action 4-4. Toggle auto body shaking
Toggles whether [she shakes her body](#action-1-2-shaking-body) or not when getting wet.

#### Action 4-5. Toggle armors visible
Toggles whether equipped armors are visible or not. Some [costumes](./costume_catalog.md) will be hidden not to interfere with the armors while equips them. This setting will only affects to vanilla armors.

#### Action 4-6. Toggle foxfires visible in first person
Toggles whether foxfires are visible or not in the first person. Turn this off if you are annoyed with them when looking up.

![Foxfires](./README_images/foxfires.gif)

#### Action 4-7. Toggle umbrella open/close sound
Toggles whether the umbrella open/closed sounds are played or not. Turn this off if you are annoyed with them.

### Page 5 (avatar settings 2)

![Action wheel 5](./README_images/action_wheel_5.jpg)

#### Action 5-1. Toggle always umbrella use
Toggles whether she always use umbrella when she can use it even if it isn't raining. Can be used for photo shoots.

![Umbrella](./README_images/umbrella.jpg)

#### Action 5-2. Toggle frequently shown messages
Toggles whether messages which are showed frequently show or not. This setting will not affects the action wheel messages. Turn this off if you are annoyed with them.

## 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/SenkoSan/releases).
- You can also go there from the right side of [the repository's home page](https://github.com/Gakuto1112/SenkoSan).
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.
- 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/SenkoSan/issues) if you find it.
- Please contact me via [Discussions](https://github.com/Gakuto1112/SenkoSan/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/ばにーさん".

## Links
- [Figura(Modrinth)](https://modrinth.com/mod/figura)
- [Figura(GitHub)](https://github.com/Moonlight-MC-Temp/Figura)
- [TVアニメ「世話やきキツネの仙狐さん」オフィシャルサイト](http://senkosan.com/)
- [Amazon.co.jp_ 世話やきキツネの仙狐さんを観る _ Prime Video](https://www.amazon.co.jp/gp/video/detail/B07QJG9NP7)
- [世話やきキツネの仙狐さん - Webで漫画が無料で読める!コミックNewtype](https://comic.webnewtype.com/contents/sewayaki/)

---

![Senko and Shiro 1](./README_images/senko_and_shiro_1.jpg)

![Senko and Shiro 2](./README_images/senko_and_shiro_2.jpg)

![Senko and Shiro 3](./README_images/senko_and_shiro_3.jpg)

![Senko and Shiro 4](./README_images/senko_and_shiro_4.jpg)

![Senko and Shiro 5](./README_images/senko_and_shiro_5.jpg)