Subscribe to download
Wookiee Tutorial: Party Animal

This is an example template for creating mods that revolve around manipulating the functions and fields of Lua tables (which is to say the sort of mods that do not add new models, animations, sounds, or maps to the game).

This mod demonstrates the basic directory structure for a workshop item featuring a single mod named Wookiee Tutorial: Party Animal and identified in an .ini file as WookieeTutorialPartyAnimal. A mod with this sort of format could be used to add unique game functionality, such as new context options, new UI panels, new shortcuts, new skills, new traits, and more.

This mod adds one example trait called Party Animal, with an accompanying icon and some basic functionality that is tied to having the trait. This Workshop Item is not meant to be used on servers; it is intended to help new modders learn better practices and some useful tricks for setting up a very basic mod of this sort.

This mod also demonstrates the use of a local module as a container for various fields and functions that achieve some sort of collective purpose.

The code is intended to be read by modders who download it. It has many comments that explain how various aspects of the mod work together. After subscribing, you will find this mod in the same Steam folder as your Zomboid installation:

Steam\steamapps\workshop\content\108600\2929985581


Simply launch your game, immediately enter the MODS menu, enable Wookiee Tutorial: Party Animal, and start a new single player game. Mods enabled in MODS will be added automatically.


Launch your game, click LOAD, MORE, Choose Mods, and enable Wookiee Tutorial: Party Animal.


Launch your game, click HOST, Manage Settings, Edit Selected Settings, Steam Workshop, and find Wookiee Tutorial: Party Animal in the small dropdown below the list of active items.


Mod Options is itself a mod, and, as such, you must subscribe to it and add it to your server via the Workshop Items tab.


If you want to see the entire directory structure for a workshop item, you'll need to visit my GitHub repository for this item, because simply subscribing will not show you the directory that Steam uses to populate the workshop page with text and a preview image.

My repository can be found here.[github.com]


Many better modders than me lurk in the #mod_discussion channel of the Project Zomboid Discord[discord.com] (and they are usually happy to help new people who get stuck). You are welcome to ask for advice in that channel whenever you get lost in the sauce! I may even be the one who replies, if I happen to be around. You are welcome to try pinging me directly, but I obviously cannot promise to be available.


Feel free to check out my other stuff on the workshop!

[ko-fi.com]

Workshop ID: 2929985581
Mod ID: WookieeTutorialPartyAnimal