From 45fcc03fbdc2a9927262d18600c0455550bbf39a Mon Sep 17 00:00:00 2001 From: AeonLucid Date: Sun, 25 Oct 2020 07:11:35 +0100 Subject: [PATCH] Update plugin documentation --- README.md | 2 -- docs/Writing-a-plugin.md | 11 +++++++++++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 79bb385..4396c50 100644 --- 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. diff --git a/docs/Writing-a-plugin.md b/docs/Writing-a-plugin.md index 5e52171..35d17d7 100644 --- a/docs/Writing-a-plugin.md +++ b/docs/Writing-a-plugin.md @@ -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. -- 2.39.5