Skip to content

Commit

Permalink
mention fabric support in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
derklaro committed Jan 29, 2025
1 parent 9cda364 commit fc7444f
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
## Features

- **Bukkit & Forks** (including Folia) supported via **ProtocolLib** or **PacketEvents**
- **Minestom** supported
- Full **Minestom** & **Fabric** support (latest version only)
- **Skin** (Static and Dynamic loading)
- **Attributes** (Status, Pose, Skin Layers)
- **Equipment** (Main & Off Hand, Armor)
Expand All @@ -36,6 +36,7 @@ All modules are available in [maven central](https://central.sonatype.com/search
| npc-lib-common | Abstract implementation of the api module. This module should be used when a new platform implementation is made. |
| npc-lib-bukkit | Platform specific implementation for Bukkit. This module implements the complete API (and common) to support Bukkit (and forks). |
| npc-lib-minestom | Platform specific implementation for Minestom. This module implements the complete API (and common) to support Minestom (and forks). |
| npc-lib-fabric | Platform specific implementation for Fabric. This module implements the complete API (and common) to support Fabric and must be installed as a mod on the server. |
| npc-lib-labymod | This module contains helper methods for accessing LabyMod NPC features (such as emotes and stickers). See the [LabyMod documentation](https://dev.labymod.net/) for more information. |

### How to include a module
Expand Down Expand Up @@ -101,6 +102,12 @@ BukkitPlatform.bukkitNpcPlatformBuilder()
MinestomPlatform.minestomNpcPlatformBuilder()
```

### On Fabric

```java
FabricPlatform.fabricNpcPlatformBuilder()
```

## Configuring the Platform

In all further examples bukkit will be used as a reference, but the api is the same on all other platforms:
Expand Down

0 comments on commit fc7444f

Please sign in to comment.