Skip to content

Commit

Permalink
Update README & add more example images
Browse files Browse the repository at this point in the history
  • Loading branch information
OliverSchlueter committed Nov 4, 2023
1 parent dc40050 commit 74ebac6
Show file tree
Hide file tree
Showing 9 changed files with 58 additions and 9 deletions.
49 changes: 40 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![](fancynpcs_title.png)

#
#

![Latest Version](https://img.shields.io/github/v/release/FancyMcPlugins/FancyNpcs?style=flat-square)
[![Generic badge](https://img.shields.io/badge/folia-supported-green.svg)](https://shields.io/)
Expand All @@ -21,16 +21,36 @@ _Using [paper](https://papermc.io/downloads) is highly recommended_
- https://hangar.papermc.io/Oliver/FancyNpcs
- https://modrinth.com/plugin/fancynpcs/
- https://github.com/FancyMcPlugins/FancyNpcs/releases
- https://www.spigotmc.org/resources/fancy-npcs-1-20.107306/
- https://www.spigotmc.org/resources/fancy-npcs.107306/

### Development builds

- https://fancyplugins.de/fancynpcs/download/
- [Build from source](Build%20from%20source)
- Build from source

## Documentation
## Features

With FancyNpcs you can create NPCs that look like real players. You can edit a bunch of properties like the display name
or skin.

All properties:

- display name
- skin (username or url)
- entity type (cow, pig, blaze etc.)
- equipment (e.g. holding something in the hand)
- glowing (in all colors)
- and many more properties that are entity specific

You can also define some actions that will be executed when a player interacts with the npc:

- message: sends a simple message to the player
- player command: forces the player to execute a command
- server command: executes a command in the console

Website (unfinished): https://fancyplugins.de/fancynpcs/docs/
Explore more features on the official website: https://fancyplugins.de/

## Documentation

### Plugin

Expand All @@ -42,16 +62,27 @@ Multiple lines: [multiple-lines.md](docs/misc/multiple-lines.md)<br>
Getting started: [getting-started.md](docs/api/getting-started.md)<br>
Events: [events.md](docs/api/events.md)<br>

## Build from source
### Build from source

1. Clone this repo and run `gradlew shadowJar`
2. The jar file will be in `build/libs/FancyNpcs-<version>.jar`

## Examples

![](exampleImages/example1.png)
The following images are by https://explorerseden.eu/
![](exampleImages/niceron2.png)

![](exampleImages/niceron1.png)

![](exampleImages/niceron3.png)

The following image is by Beacon's Quest
![](exampleImages/dave1.png)

The following images are by oliver (main dev of this plugin)
![](exampleImages/oliver1.png)

![](exampleImages/example3.png)
![](exampleImages/oliver2.png)

![](exampleImages/example2.png)
![](exampleImages/oliver3.png)

18 changes: 18 additions & 0 deletions exampleImages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Example images

The following images are by https://explorerseden.eu/
![](niceron2.png)

![](niceron1.png)

![](niceron3.png)

The following image is by Beacon's Quest
![](dave1.png)

The following images are by oliver (main dev of this plugin)
![](oliver1.png)

![](oliver2.png)

![](oliver3.png)
Binary file added exampleImages/dave1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added exampleImages/niceron1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added exampleImages/niceron2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added exampleImages/niceron3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit 74ebac6

Please sign in to comment.