Tanuki Atlyss
A plugin framework based on BepInEx that simplifies the creation of plugins for the game Atlyss. Supports localization, commands, and more.
About this mod Author’s original text
Tanuki.Atlyss
Tanuki.Atlyss is a plugin framework for.NET based on BepInEx for the game Atlyss.
It offers simple plugin localization, command support, patches, and more.
Features
Commands
Commands for each plugin are configured in JSON files.
BepInEx/config/{Plugin}/default.commands.json
Each command can have multiple names (aliases), the first of which will be the main name of the command.
All names must be in lowercase. If a command name is already in use, it will be automatically removed.
The active command file is automatically cleared and supplemented with commands that exist but have not yet been added.
Commands support arguments that are passed to them as an array of strings.
Example
/example 123 "argument with spaces" 456 'argument with other quotes'
The command will receive the following array:
["123", "argument with spaces", "456", "argument with other quotes"]
If there are no arguments, an empty array will be passed.
Basic bootstrap commands:
- /help [plugin names separated by spaces] - Display a list of plugin commands.
- /reload [plugin names separated by spaces] - Reload the specified plugins.
Translation
Plugin translation using json documents, support for different languages.
BepInEx/config/{Plugin}/default.translations.json - Default translation file.
BepInEx/config/{Plugin}/russian.translations.json - Russian translation file.
Commands are translated in a similar way. You can add or remove command aliases by editing the Names list of commands.
BepInEx/config/{Plugin}/default.commands.json - Default command file.
BepInEx/config/{Plugin}/russian.commands.json - Russian command file.
To change the language of all plugins, you need to replace it in the bootstrap configuration.
BepInEx/config/9c00d52e-10b8-413f-9ee4-bfde81762442.cfg
The specified language will be used in all plugins where it is available, otherwise the first one encountered will be used.
You should use the full names of languages and only lowercase letters. For example: russian, english, spanish.
Other
Patches, accessors, and extensions are located in Tanuki.Atlyss.Game project.
Examples of using this framework can be found in the Tanuki.ExamplePlugin project.
Getting Started
This framework.
Manual installation
- Install BepInEx. It's recommended to use the preconfigured package.
- Install the Tanuki.Atlyss files.
Anything else?
Contacts
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: