Skip to content

Commit 0ecfbca

Browse files
fancynpcs: Add tutorial for custom models (#87)
1 parent f935bc5 commit 0ecfbca

2 files changed

Lines changed: 43 additions & 0 deletions

File tree

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Custom Models
3+
description: How to apply custom 3D models to npcs
4+
---
5+
6+
This tutorial shows you how to apply custom 3D models to npcs using BetterModel.
7+
8+
Requirements:
9+
- [FancyNpcs](https://modrinth.com/plugin/fancynpcs) (latest version)
10+
- [FancyNpcsModel](https://modrinth.com/plugin/fancynpcsmodel) (latest version)
11+
- [BetterModel 3.0.2-SNAPSHOT-491](https://modrinth.com/plugin/bettermodel) or newer
12+
13+
## Custom models
14+
15+
How to apply a custom model to a npc:
16+
17+
1. Install the required plugins
18+
2. Import models to BetterModel (see [BetterModel's documentation](https://github.com/toxicity188/BetterModel/wiki) for that)
19+
3. Make sure your npc is a player npc (`/npc type (npc) player`)
20+
4. Set the custom model: `/npc custom_model (npc) (model name)`
21+
5. Done! Your npc should now have the model you assigned to it
22+
23+
Setting the custom model to `@none` will remove the model.
24+
25+
Commands that won't work, when the npcs has a custom model:
26+
- `/npc displayname`
27+
- `/npc equipment`
28+
- `/npc glowing`
29+
- `/npc skin`
30+
- `/npc turn_to_player` (depends on model)
31+
32+
## Animations
33+
34+
This plugin also adds two new actions (for npcs with custom models only) to play animations.
35+
36+
Actions:
37+
- `play_animation_once`: plays the specified animation once
38+
- `play_animation_loop`: plays the specified animation in a loop
39+
40+
How to add the action: `/npc action (npc) (trigger) add play_animation_once (animation name)`
41+
42+
There is also a command to play an animation: `/npc play_animation (npc) (animation name) [--loop]`

content/docs/minecraft-plugins/fancynpcs/tutorials/meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"pages": [
66
"citizens-converter",
77
"action-system",
8+
"custom-models",
89
"multiple-lines",
910
"sitting-npcs",
1011
"mineskin-api-key",

0 commit comments

Comments
 (0)