Modding templates for Zumbi Blocks 1 and Zumbi Blocks 2, powered by BepInEx.
These templates are designed to work out-of-the-box: that means you can click Build and the project will just work.
Some configuration will be needed for Zumbi Blocks 1.
- Batteries-included: already configured for modding
- Customizable with feature toggles
- Validates game and mod loader installation
- Automatically installs your plugins
- Copies assets to your mod folder
- Embeds resources if needed
- Zumbi Blocks 1 or Zumbi Blocks 2
- BepInEx 5
- .NET 6.0 SDK or newer
- .NET Framework 4.6.2 or newer
- .NET IDE of choice
Note
Using Visual Studio Community 2022?
The .NET Desktop Development workload includes .NET 8.0 SDK and .NET Framework 4.7.2.
This means you do not need to install .NET 6.0 SDK or .NET Framework 4.6.2.
This guide will help you get started with modding Zumbi Blocks in just a few minutes.
Installing BepInEx is incredibly easy and won't take much time.
Tip
For a more comprehensive guide on installing BepInEx, as well as several articles on using it, please refer to the official BepInEx documentation site.
First, open the folder where you extracted Zumbi Blocks 1. This will be named ZumbiBlocks for the 32-bit version, and ZumbiBlocks-64bit for the 64-bit version.
Next, extract the BepInEx ZIP file. This will result in three files and one folder: changelog.txt, doorstop_config.ini, winhttp.dll, and a BepInEx folder.
Drag everything into the game folder. The BepInEx folder should now be next to the ZumbiBlocks.exe file and the ZumbiBlocks_Data folder.
Run the game and wait a couple seconds. BepInEx has crashed.
This is because Zumbi Blocks 1 is on an old version of Unity, and requires a bit of configuration.
Open the BepInEx folder, and you'll see a config folder inside. This is where BepInEx and all mods store their config files.
Open the BepInEx.cfg file in Notepad and scroll all the way to the bottom. Replace the word Application with MonoBehaviour.
Save the file, then run the game again.
You're done! BepInEx is now installed. You may now close the game.
In your Steam client, right-click Zumbi Blocks 2, hover over Manage, then click on Browse local files.
This will open the game folder in Windows Explorer. If it didn't appear on screen, click on the Explorer icon in the taskbar or tab over to it.
Next, extract the BepInEx ZIP file. This will result in three files and one folder: changelog.txt, doorstop_config.ini, winhttp.dll, and a BepInEx folder.
Drag everything into the Zumbi Blocks 2 Open Alpha folder. The BepInEx folder should now be next to the MonoBleedingEdge and ZumbiBlocks2_Data folders.
Run the game--either from Steam or the ZumbiBlocks2.exe file--and wait for the game to load.
You're done! BepInEx is now installed. You may now close the game.
Much like BepInEx, installing the template is very simple.
First, clone the repository or download the source code from Releases. If downloaded, extract the ZIP file.
Be sure to move the folder somewhere safe where you know it won't be deleted or overwritten.
Next, open the folder. Inside, you'll see two scripts: install.sh and uninstall.sh. Run install.sh to add the template to your list of .NET templates, and uninstall.sh to remove it.
That's it! The template is now installed and ready to create projects.
Launch your .NET IDE of choice and open the list of available templates.
If using Visual Studio Community 2022, this is done by clicking on "Create a new project" on the right.
If the template isn't immediately visible, use the search bar to filter the results.
Visual Studio Community 2022 should automatically display the template at the top of the list after installing it, then will list it on the left, under "Recent project templates".
Select the template and start customizing it. Give it a name, select the framework you'd like to use (the default is fine), and list yourself as the author.
Create the project and you're done!
The template takes care of all references for you, so you can focus on what really matters, rather than mess with project configuration.
The template comes with some optional features you might find useful. They can be toggled on and off easily, and are separate from the main project, so you can share your code without worrying about it conflicting with someone else's settings.
Open the *.csproj.user file and customize the settings.
If modding Zumbi Blocks 1, this is where you set its install location.
If modding Zumbi Blocks 2 and your Steam library is not on the C: drive, this is where you can enter its custom installation location.
When done customizing your plugin base, click on Build in your IDE.
If the task is enabled, your plugin will automatically be installed. Open the game and test it out!
When ready to publish, don't forget to add a license! This is very important in the open source community.
If your plugin has assets, create a folder named assets and it'll automatically be copied over to your mod folder when building your project.
Likewise, if you have embedded resources, create a folder named resources and those will automatically be embedded when building.
If you ever get stuck or need assistance getting started, feel free to join the official Zumbi Blocks 2 Discord Server.
There's a modding channel where you can share and discuss everything related to mods.