GinkEngine

GinkEngine is a powerful modding tool designed for Puttler(by Bean Juice Studios). It simplifies the process of modding and lets you customize the game to your heart's content.

For updates, questions, or to chat with the community, join our Discord server.

Getting Started

To get started with GinkEngine, follow these simple steps:

1. Download the latest release.
2. Extract the archive to your preferred location.
3. Run GinkEngine.bat to launch the tool.
4. In the menu bar, click on Options and select Link Puttler.
5. Browse to the Puttler executable file (.exe) and link it. You should see a confirmation message saying that it was linked successfully.
6. Now, in the menu bar, go to Play > Play Modded. This will ensure that BepInEx is properly installed for modding.
7. Game files have been cloned into the DONT_SHARE/Game Files directory. These are the files you will be modifying for your mods. The linking process has already installed BepInEx to these files.
8. Want to start over? Simply re-link the game and GinkEngine will remove the modified files and reset the process.

Important Notes

• GinkEngine itself can be used and redistributed without restriction, as long as you follow the associated license.
• However, redistributing GinkEngine could be subject to restrictions depending on the licenses of Puttler or any included tools/libraries. Be sure to check the license files for each tool before redistributing.
• Do not share the contents of the DONT_SHARE folder, as it contains game files that could violate copyrights if distributed.

Included Tools & Libraries

GinkEngine relies on several powerful tools and libraries that are included within the release:

• WinPython (version winpython64-3.12.8.0slim.7z), which bundles development tools like Jupyter Lab, Spyder, VS Code, and Jupyter Notebook.

  • You can download it from WinPython GitHub Releases Page.

• AssetStudio (version AssetStudio.net6.v0.16.47), included under the MIT license. Developed by Perfare.

• AssetBundleExtractor (UABE) (version AssetsBundleExtractor_2.2stabled_64bit), included under the Attribution-NonCommercial-ShareAlike 3.0 Unported license. Developed by DerPopo/SeriousCache.

• UABEAvalonia (version 8th release), included under the MIT license. Developed by nesrak1.

• dnSpy (version dnSpy-net-win64), included under the GPLv3 license. Developed by 0xd4d.

• MelonLoader (version v0.7.0), included under the Apache License Version 2.0. Developed by LavaGang.

These tools are bundled with GinkEngine for ease of use. If any of the developers request the removal of their tools, we will respect their wishes and remove them.

Official Documentation

For a detailed breakdown of every button and feature in GinkEngine, visit our official documentation on the website:

GinkEngine Documentation

This site provides in-depth explanations of all tools, settings, and workflows, making it easier for both beginners and experienced modders to get started.

Want a quicker start? The sections below cover how to use the most basic GinkEngine features!

---

How to Build Mods

Building your own mods with GinkEngine is simple:

1. Navigate to the Build Mods tab.
2. Enter your mod's details into the name, author, and description fields.
3. Click Build Mod.
4. The tool will create a mod based on the modifications you’ve made in the DONT_SHARE/Game Files folder. Any changes to these game files will be part of your mod.

---

How to Export Mods

Once you've built your mod, you can export it for sharing or backup:

1. Click on Options in the menu, then select Export Mod.
2. Choose the mod you wish to export (it won't show up if the mod hasn't already been imported or built).
3. Provide a name for your mod.
4. GinkEngine will create a .zip file containing your mod, ready for distribution.

---

How to Import Mods

To import mods made by others or downloaded from the community:

1. Click on Options in the menu, then select Import Mod.
2. Select the downloaded .zip file containing the mod.
3. The mod will be imported and ready for installation to your linked Puttler installation.

---

How to Install Mods

Keep in mind that once a mod is installed, it cannot be uninstalled from the game via GinkEngine.

1. Navigate to the Install Mods tab (this requires you to either build your own mod or import someone else's first).
2. Click Refresh to update the list of imported mods.
3. Select the mod you want to install to Puttler and click the Install button.
4. Go to Play > Play Modded to launch your game with the mod applied.

---

How to Delete Imported Mods

If you want to remove a mod from GinkEngine (but not from your game, as installed mods can’t be uninstalled directly from the game):

1. Go to the Delete Mods tab.
2. Click Refresh to update the list of imported mods.
3. Select the mod you want to delete from both GinkEngine and your hard drive.
4. Click Delete Selected Mod to remove it from GinkEngine.
5. The mod will now be removed from your GinkEngine installation, but it will not be uninstalled from your game.

---