]> git.deb.at Git - rhonda/impostor.git/commitdiff
Update plugin documentation
authorAeonLucid <aeonlucid@outlook.com>
Sun, 25 Oct 2020 06:11:35 +0000 (07:11 +0100)
committerAeonLucid <aeonlucid@outlook.com>
Sun, 25 Oct 2020 06:11:35 +0000 (07:11 +0100)
README.md
docs/Writing-a-plugin.md

index 79bb38590ccb05ffa35fce2770186a8a0a736b8a..4396c5003ce80c90fb93fd239f3fd4a84d32022c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,8 +14,6 @@ We support steam, itch, android and iOS. The latest version supported is `2020.9
 
 There are no special features at this moment, the goal is aiming to be as close as possible to the real server, for now. In a later stage, making modifications to game logic by modifying `GameData` packets can be looked at.
 
-
-
 ## Features
 
 - All Among Us features are implemented. It is a full replacement for the official server.
index 5e521712a2482c28c1ff70b7131ad89f5dc8fffa..35d17d7f7b46e3bb1afb20b7b38e485eff887216 100644 (file)
@@ -13,6 +13,9 @@ Impostor has support for plugins. This document will help you to setup a develop
 - [7. Extra](#7-extra)
   - [Event listeners](#event-listeners)
   - [Dependency injection](#dependency-injection)
+  - [Server configuration](#server-configuration)
+  - [Using other libraries](#using-other-libraries)
+  - [Impostor versions](#impostor-versions)
 - [8. Missing/invalid data or want more functions?](#8-missinginvalid-data-or-want-more-functions)
 
 ## 1. Install .NET Core SDK
@@ -257,6 +260,14 @@ Constantly copying the plugin dll to your server directory can be pretty annoyin
 
 Sometimes you need to use libraries that the original Impostor server does not provide. The dll files of these libraries must be placed in the `libraries` folder next to the server executable. You could also provide them by modifying the `PluginLoader.Libraries` option in the `config.json`, similarly to the `PluginLoader.Paths` option.
 
+### Impostor versions
+
+It is important to use the correct versions when working with `Impostor.Api` prereleases and the `Impostor` dev builds to reduce the chances of mismatching assemblies. 
+
+**Example** 
+
+The prerelease `Impostor.Api` package `1.2.0-ci.54` belongs to build `54` on AppVeyor, which can be found here https://ci.appveyor.com/project/Impostor/Impostor/build/54. Notice the `54` on the end of the url.
+
 ## 8. Missing/invalid data or want more functions?
 
 The `Impostor.Api` is currently in beta. There are a lot of things still missing and we would like to hear from you what you need to develop a plugin.