Packaging your addon for release.

When you have finished developing your addon, you may wish to release it to the public. Here are some tips on how to do that.

Notice

When the Mod Updater is finished, the way you have to package your addon may change.
This page will be updated when that happens.

Packaging your addon

When releasing your addon on GitHub, or sharing it to friends, you should package it as a .zip file in the following structure:

MyAddon.zip
├── addons
│   └── myaddon.dll
└── Languages
    └── MyAddon
        └── lang_English.yaml

This allows users to simply extract the contents of the zip into their Among Us installation folder, without any extra work.

“My addon doesn’t include a Languages folder, what do I do?”

Your addon will only include a languages folder if you make use of the VentFramework Localizer. Don’t worry if you don’t have one, it’s not required to have one.

If you want to make use of the Localizer, you can check out the VentFramework documentation on how to do so here.

What if I don’t want to bundle a language file?

If your addon has roles, you can make it so that the role’s default name and description are hardcoded into your role’s file, then it will be automatically generated on launch.

Here is an example.

[Localized(nameof(Journalist))]
public static class Translations
{
    [Localized("RoleName")] public static string RoleName = "Journalist";
    [Localized("Blurb")] public static string RoleBlurb = "WRITE THAT DOWN!!!";
    [Localized("Description")] public static string RoleDescription = "The Journalist is a Crewmate which has the ability to write Journal entries which will be revealed to all upon their death.";
}

Upon launching the game, it will be automatically placed into the Language File for your addon.

Journalist:
    RoleName: Journalist
    Blurb: WRITE THAT DOWN!!!.
    Description: The Journalist is a Crewmate which has the ability to write Journal entries which will be revealed to all upon their death.
``