Tankard is a modding API for the game Tavern Keeper by Greenheart Games. This adds no functionality on its own, but enables other mods to interact with Tavern Keeper more easily.
NOTICE: Greenheart Games does not officially support modding Tavern Keeper or endorse Tankard, so you are modifying the game at your own risk. Tankard is in active development and Tavern Keeper is in Early Access. As such, functionality provided by Tankard may break without warning as the game and Tankard evolve. If you are a mod developer, please be prepared to update your mods as necessary when either Tankard or Tavern Keeper updates.
To get started with modding Tavern Keeper using Tankard, you will need to familiarize yourself with C#, the Unity engine, and the BepInEx modding framework.
To learn about writing code in C#, refer to the following resources:
To learn about using the Unity engine, refer to the following resources:
To learn about using the BepInEx modding framework, refer to the following resources:
After you are familiar with these resources, you can start exploring the Tankard API by reading the API Documentation and looking at example mods that use Tankard in the examples folder of this repository.
If you encounter any issues while developing with Tankard, please follow the steps below to troubleshoot:
- Check the Documentation: Review the API Documentation to ensure you are using the Tankard API correctly.
- Search for Existing Issues: Check the Issues section of this repository to see if your issue has already been reported or resolved.
- Update Tankard and Tavern Keeper: Ensure that you are using the latest versions of both Tankard and Tavern Keeper, as issues may have been fixed in newer releases.
- Ask for Help: If you are still experiencing issues, consider reaching out to the Tankard community for assistance. You can do this by opening a new issue on this repository.
If you would like to contribute to Tankard, please feel free to submit a pull request or open an issue on this repository. We welcome contributions of all kinds, including bug fixes, new features, and documentation improvements.
Before submitting a pull request, please ensure that your code adheres to the existing coding style and includes appropriate tests and documentation. We also recommend discussing major changes or new features in an issue before implementing them to ensure that they align with the goals of the project.
Thank you for using Tankard!