Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/markusbordihn/bos-easy-npc

Create easily NPC for your world or for your mod.
https://github.com/markusbordihn/bos-easy-npc

Last synced: 20 days ago
JSON representation

Create easily NPC for your world or for your mod.

Host: GitHub
URL: https://github.com/markusbordihn/bos-easy-npc
Owner: MarkusBordihn
License: other
Created: 2023-01-02T15:34:36.000Z (almost 2 years ago)
Default Branch: 1.20.1
Last Pushed: 2024-10-24T22:54:32.000Z (22 days ago)
Last Synced: 2024-10-26T11:11:54.027Z (20 days ago)
Language: Java
Size: 5.76 MB
Stars: 19
Watchers: 4
Forks: 7
Open Issues: 91
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

        # 🗣 Easy NPC (1.20.1)

![Easy NPC Versions](http://cf.way2muchnoise.eu/versions/Minecraft_559312_all.svg)

[![Download on CurseForge](http://cf.way2muchnoise.eu/title/559312.svg)](https://www.curseforge.com/minecraft/mc-mods/easy-npc)

[![CurseForge Downloads](http://cf.way2muchnoise.eu/full_559312_downloads.svg)](https://www.curseforge.com/minecraft/mc-mods/easy-npc)

[![Download on Modrinth](https://img.shields.io/badge/dynamic/json?labelColor=black&color=grey&label=&query=title&url=https://api.modrinth.com/v2/project/CgGEe1h3&style=flat&logo=modrinth)](https://modrinth.com/mod/easy-npc)

[![Modrinth Downloads](https://img.shields.io/badge/dynamic/json?labelColor=black&color=grey&label=&suffix=%20downloads&query=downloads&url=https://api.modrinth.com/v2/project/CgGEe1h3&style=flat&logo=modrinth)](https://modrinth.com/mod/easy-npc)

[![Report an Issue](https://img.shields.io/badge/dynamic/json?label=Report%20an%20Issue%20%2F%20Bug%20%2F%20Crash%20%2F%20Feature%20Request&labelColor=black&color=grey&query=title&url=https://api.modrinth.com/v2/project/CgGEe1h3&style=flat&logo=github)][issues]

[![Open Issues](https://img.shields.io/github/issues/MarkusBordihn/BOs-Easy-NPC?style=flat&logo=Github&color=red)](https://github.com/MarkusBordihn/BOs-Easy-NPC/issues?q=is%3Aopen+%21label%3Aenhancement)

[![Closed Issues](https://img.shields.io/github/issues-closed/MarkusBordihn/BOs-Easy-NPC?style=flat&logo=Github)](https://github.com/MarkusBordihn/BOs-Easy-NPC/issues?q=is%3Aclosed)

[![Java CI with Gradle](https://github.com/MarkusBordihn/BOs-Easy-NPC/actions/workflows/gradle.yml/badge.svg?branch=1.20.1)](https://github.com/MarkusBordihn/BOs-Easy-NPC/actions/workflows/gradle.yml)

[![Run game tests on Fabric](https://github.com/MarkusBordihn/BOs-Easy-NPC/actions/workflows/game-test-fabric.yml/badge.svg?branch=1.20.1)](https://github.com/MarkusBordihn/BOs-Easy-NPC/actions/workflows/game-test-fabric.yml)

[![Run game tests on Forge](https://github.com/MarkusBordihn/BOs-Easy-NPC/actions/workflows/game-test-forge.yml/badge.svg?branch=1.20.1)](https://github.com/MarkusBordihn/BOs-Easy-NPC/actions/workflows/game-test-forge.yml)

[![Wiki](https://img.shields.io/badge/dynamic/json?label=Wiki&labelColor=black&color=grey&query=title&url=https://api.modrinth.com/v2/project/CgGEe1h3&style=flat&logo=github)][wiki]

[![Support me on Ko-fi](https://img.shields.io/badge/Support_me_on_Ko--fi-!?labelColor=black&style=flat&logo=ko-fi)][ko-fi]

Easy NPCs allows a simplified setup for custom NPCs with dialogs for mapmaker and other mods.

## ✨ Features

- Providing easy NPCs with basic dialogs and a easy setup.

- Easy Action configuration with debug option.

- Skin configuration with player name and URL support.

- Server and client friendly.

- No additional dependencies.

- API support / integration for other mods (WIP).

## 📦 Mod Integration

### [Armourer's Workshop][armourers_workshop]

Basic integration for [Armourer's Workshop][armourers_workshop] to use the skins from the library.

### [Epic Fight Mod][epic_fight_mod]

Basic integration for [Epic Fight Mod][epic_fight_mod] to use the animations and

models from the mod.

The integration is done over an external mod

called [Easy NPC Epic Fight Mod][easy_npc_epic_fight_mod].

### [Immersive Melodies][immersive-melodies]

Basic integration for [Immersive Melodies][immersive-melodies] to use the music instrument from the

mod.

## Usage

Just spawn a NPC with the corresponding spawn egg and click with your empty hand on the spawned NPC.

If you need to adjust the existing dialog, just click with your empty hand and crouching on the NPC.

## ⬆️ Upgrading

Please make sure to check the [upgrade guide][upgrade_guide] before upgrading/updating to a new

version.

## ℹ️ More Information

Please check the [wiki][wiki] for additional information.

## 🐛 Report Issues, Bugs, Crashes or Feature Requests

Please report issues and feature requests over the [issues link][issues]. I'm happy to help you.

## 🫶 Support me

If you enjoy using my creations, consider supporting my development! ☕️

Donations via [Patreon][patreon] and [Ko-fi][ko-fi] are immensely helpful, but not required (my mods

are free and open-source!).

Every bit helps me keep creating mods in my free time, covering software, services, and hardware

costs.

## ⚖️ License

The [MIT LICENSE](LICENSE.md) applies only to the code in this repository.

Images, models and other assets are explicitly excluded.

[ko-fi]: https://ko-fi.com/Kaworru

[wiki]: https://github.com/MarkusBordihn/BOs-Easy-NPC/wiki

[upgrade_guide]: https://github.com/MarkusBordihn/BOs-Easy-NPC/wiki/Upgrading

[armourers_workshop]: https://www.curseforge.com/minecraft/mc-mods/armourers-workshop

[epic_fight_mod]: https://www.curseforge.com/minecraft/mc-mods/epic-fight-mod

[easy_npc_epic_fight_mod]: https://www.curseforge.com/minecraft/mc-mods/easy-npc-epic-fight

[immersive-melodies]: https://www.curseforge.com/minecraft/mc-mods/immersive-melodies

[issues]: https://github.com/MarkusBordihn/BOs-Easy-NPC/issues