Getting Started

Get the Among Us experience in your Minecraft server — follow the steps below to get up and running quickly.

Prerequisites

• A running Paper (or compatible) Minecraft server
• Server operator / file system access

---

Installation

1. Download the plugin.

   Choose your preferred method:

   Download (Recommended)

   1. Open the Releases page on GitHub.

   2. Expand Assets on the latest release.

   3. There are now 3 .jar files:

      lite (Recommended)

      The lite version is the recommended option for most users.

      On first startup, it will download all required dependencies automatically. This means the initial startup may take approximately 1–3 minutes.

      An internet connection is required only for the first launch.

      standalone

      All dependencies are bundled directly into the plugin.

      This results in a larger file size, but no additional downloads are required at startup.

      thin

      Does not work

      This version does not work. It is only intended for special cases and should not be used in normal setups.

      The plugin will log a warning and throw an exception on startup.

   Build from Source

   Clone the repository and build the plugin using Gradle:

   git clone https://github.com/Fantamomo/among-us-in-minecraft
   cd among-us-in-minecraft

   This plugin depends on packages hosted on GitHub Packages, which requires authentication — even for read access.

   Create or edit your ~/gradle.properties file and add your GitHub credentials:

   gpr.user=YOUR_GITHUB_USERNAME
   gpr.key=YOUR_GITHUB_TOKEN

   Creating a token

   1. Open GitHub Tokens
   2. Click Generate new token
   3. Select read:packages.
   4. Click Generate token.
   5. Place it in ~/gradle.properties

   Then build the plugin:

   ./gradlew shadowJar

   The compiled .jar will be located in build/libs/.

   Note

   The authentication requirement for GitHub Packages is a known inconvenience. We hope to migrate the dependencies to a public registry in the future to simplify this process.

2. Add the plugin to your server.

   Move the downloaded .jar file into your server’s plugins/ directory:

   • Directoryplugins/

     • AmongUs-x.x-SNAPSHOT-x.jar the downloaded .jar file
     • …
   • …

3. Start your server.

   If your server is already running, stop it first, then start it again.

   Caution

   This plugin does not support /reload. Always perform a full restart — both on first install and after every update.

4. Verify the installation.

   Once the server is running, check your console for a line like:

   [AmongUs] Enabling AmongUs vX.X-SNAPSHOT

   If you see it, you’re all set! Next, adjust your config.yml to your liking or jump straight into creating your first area or download the pre-built-area.