|
| 1 | +--- |
| 2 | +title: Frequently Asked Questions |
| 3 | +icon: MessageCircleQuestion |
| 4 | +description: Frequently Asked Questions about ServiceIO |
| 5 | +--- |
| 6 | + |
| 7 | +import { Accordion, Accordions } from "fumadocs-ui/components/accordion" |
| 8 | + |
| 9 | +<Accordions type="single"> |
| 10 | + <Accordion |
| 11 | + title="Why should I use ServiceIO?" |
| 12 | + id="why-serviceio" |
| 13 | + > |
| 14 | + ServiceIO not only provides the Vault and VaultUnlocked API, but also provides a lot of additional features.<br/> |
| 15 | + It is designed to be a drop-in replacement for Vault, but with more features and a nicer API. |
| 16 | + |
| 17 | + From a user perspective, ServiceIO offers the ability to convert between any given service providers.<br/> |
| 18 | + This, for example, allows you to switch out your Permissions, NPC or Holograms plugin effortlessly.<br/> |
| 19 | + Vault only offers this for Economy services, while ServiceIO offers this for all providers. |
| 20 | + |
| 21 | + In addition to the standard Vault interfaces, ServiceIO provides a common **NPC** and **Hologram API**,<br/> |
| 22 | + which allows developers to support multiple plugins without having to implement the same functionality multiple times. |
| 23 | + |
| 24 | + </Accordion> |
| 25 | + <Accordion |
| 26 | + title="How does ServiceIO work?" |
| 27 | + id="links" |
| 28 | + > |
| 29 | + ServiceIO provides both the Vault and VaultUnlocked API and creates a so called _Wrapper_ around those APIs. |
| 30 | + The wrapper _wraps_ our controller based API to a Vault interface, which is then used by other plugins. |
| 31 | + The same concept applies the other way around by wrapping the Vault interface to our controller based API. |
| 32 | + This allows users of the ServiceIO API to use the Vault API without having to implement it themselves, and again, the other way around. |
| 33 | + </Accordion> |
| 34 | + <Accordion |
| 35 | + title="Will ServiceIO ever support older Minecraft versions?" |
| 36 | + id="old-versions" |
| 37 | + > |
| 38 | + No, we do not aim to support any previous version of the game. |
| 39 | + </Accordion> |
| 40 | + <Accordion |
| 41 | + title="Which server software does ServiceIO support?" |
| 42 | + id="server-software" |
| 43 | + > |
| 44 | + The only officially supported server software are [Paper](https://papermc.io/software/paper) |
| 45 | + and [Folia](https://papermc.io/software/folia) |
| 46 | + although forks like [Purpur](https://purpurmc.org/) or [Pufferfish](https://pufferfish.host/downloads) |
| 47 | + most likely work as well. |
| 48 | + |
| 49 | + <Callout type="error" title="Note"> |
| 50 | + Support will not be provided for non-paper based server software or unknown, arbitrary forks. |
| 51 | + Non-paper based server software will probably never be supported. |
| 52 | + Hybrids that try to support both mods and plugins are completely unsupported and will most likely not work. |
| 53 | + </Callout> |
| 54 | + </Accordion> |
| 55 | + <Accordion |
| 56 | + title="Which version of ServiceIO should I choose?" |
| 57 | + id="version" |
| 58 | + > |
| 59 | + <Callout title="Important"> |
| 60 | + You will only get support for the latest version of ServiceIO. |
| 61 | + If you encounter any issues while running an older build, you will not receive any support. |
| 62 | + </Callout> |
| 63 | + |
| 64 | + If you are **not** running the **latest** version of Paper, visit [Modrinth](https://modrinth.com/project/MNPyHOe7/versions) |
| 65 | + and look for the latest version supporting your server version. |
| 66 | + |
| 67 | + _For any version not listed on Modrinth, see [#old-versions](#old-versions)._ |
| 68 | + |
| 69 | + </Accordion> |
| 70 | + <Accordion |
| 71 | + title="One of my plugins doesn't recognize ServiceIO as Vault?" |
| 72 | + id="plugin-not-recognized" |
| 73 | + > |
| 74 | + If one of your plugins doesn't recognize ServiceIO as a Vault provider, you can try to enable the **experimental** compatibility mode. |
| 75 | + <Callout type="warning" title="Warning"> |
| 76 | + This mode is experimental and may not work with all plugins and could in return also cause issues with other plugins. |
| 77 | + It is recommended to only use this mode as a last resort, and to report the incompatible plugin to us on [GitHub](https://github.com/TheNextLvl-net/service-io/issues/new?template=incompatible_plugin.yml). |
| 78 | + </Callout> |
| 79 | + |
| 80 | + To enable the compatibility mode, set the environment variable `COMPATIBILITY_MODE=true` |
| 81 | + |
| 82 | + </Accordion> |
| 83 | +</Accordions> |
0 commit comments