Skip to content

Commit

Permalink
Update FancyNpcs docs
Browse files Browse the repository at this point in the history
  • Loading branch information
OliverSchlueter committed Jan 4, 2024
1 parent 8cbfb3d commit 71c5c45
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 4 deletions.
9 changes: 8 additions & 1 deletion Writerside/topics/FN-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,11 @@ Npc npc = FancyNpcsPlugin.get().getNpcManager().getNpc("myNpc");
npc.removeForAll();

FancyNpcsPlugin.get().getNpcManager().removeNpc(npc);
```
```

## Help about the API

<tip>
If you need help with the API, you can join our <a href="https://discord.gg/8QH2Z3Z">Discord</a> and ask in the #npcs-dev channel.
</tip>

62 changes: 61 additions & 1 deletion Writerside/topics/FN-Getting-started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,63 @@
# Getting started

TODO
## Installation

<procedure title="Download" type="choices">
<p>You can download FancyNpcs at the following places:</p>
<step><a href="https://modrinth.com/plugin/fancynpcs/versions">Modrinth</a></step>
<step><a href="https://hangar.papermc.io/Oliver/FancyNpcs/versions">Hangar</a></step>
<step><a href="https://github.com/FancyMcPlugins/FancyNpcs/releases">GitHub</a></step>
<step><a href="https://jenkins.fancyplugins.de/job/FancyNpcs/">Development Builds</a></step>
</procedure>

<procedure title="Plugins folder">
<p>Put the downloaded file into the plugins folder of your server.</p>
</procedure>

<warning>Be aware, that only Paper is supported, but the plugin should work on any of its forks (like <a href="https://github.com/PaperMC/Folia">Folia</a> or <a href="https://github.com/PurpurMC/Purpur">Purpur</a>). The plugin will not work on Spigot or Bukkit (we are working on a solution).</warning>

<procedure title="Restart server">
<p>Restart your server.</p>
<step>Run "/stop" in the server console.</step>
<step>Start the server again.</step>
</procedure>

<procedure title="Checking plugin">
<p>To make sure the plugin is loaded correctly, run the following command:</p>
<step>/fancynpcs version</step>
<step>It should output the version of the plugin.</step>
</procedure>

## Create your first NPC

<procedure title="Create NPC">
<p>Run the following commands to create your first NPC:</p>
<step>/npc create myNpc</step>
<step>A npc with the name "myNpc" should appear.</step>
</procedure>

<procedure title="Modify NPCs display name">
<p>Run the following command to modify the NPCs display name:</p>
<step>/npc displayName myNpc New display name!</step>
<step>The NPCs display name should now be "New display name".</step>
</procedure>

<procedure title="Move the NPC to you">
<p>Run the following command to move the NPC to you:</p>
<step>/npc moveHere myNpc</step>
<step>The NPC should now be at your location.</step>
</procedure>

<procedure title="Move the NPC to a specific location">
<p>Run the following command to move the NPC to you:</p>
<step>/npc teleport myNpc 127 61 347</step>
<step>The NPC should now be at the coordinates x=127 y=61 z=347</step>
</procedure>

<procedure title="Modify NPCs skin">
<p>Run the following command to modify the NPCs skin:</p>
<step>/npc skin myNpc Notch</step>
<step>The NPCs skin should now be Notch's skin.</step>
</procedure>

<tip title="More commands.">You can find more commands in the <a href="FN-Commands.md">commands page</a>.</tip>
2 changes: 1 addition & 1 deletion Writerside/topics/FancyNpcs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ It is highly recommended to use Paper or a fork of it - Folia is also supported.
[Go to the commands](FN-Commands.md)<br/>
[Go to the api](FH-API.md)

# Features
## 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.
Expand Down
4 changes: 3 additions & 1 deletion Writerside/topics/Welcome.topic
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@

<primary>
<title>FancyNpcs</title>
<a href="FN-Getting-started.md" summary="How to get started with FancyNpcs">Getting started</a>
<a href="FN-Getting-started.md"
summary="How to install FancyNpcs on your server + how to create your first basic NPC">Getting
started</a>
<a href="FN-Commands.md" summary="Documentation for all commands of FancyNpcs">Commands</a>
<a href="FN-API.md" summary="Documentation about the developer API">API</a>
</primary>
Expand Down

0 comments on commit 71c5c45

Please sign in to comment.