Umbrella

Umbrella is a collection of EmmyLua typings for Project Zomboid's API. This includes:

• Candle: The exposed Java API typings.
• PZLuaStubs: The Lua API typings.
• PZEventStubs: The Events API typings.

Advantages

• Types are exposed to IntelliSense through EmmyLua, showing what goes where and what's returned.
• No time spent decompiling the game and running tools to get typings. (They are provided already)
• Built using PZ-Rosetta, using Project Zomboid's JavaDocs to make the typings friendlier. (Parameter names, Documentation notes, etc.)

Caveats

• Each EmmyLua environment behaves differences. (vscode plugin, IntelliJ IDEA, etc.) This could cause issues.
• Forks of EmmyLua behave differently. This can cause issues depending on use.

Setup

1. Vscode installed.
2. Lua Language Server extension installed.

Addon Manager (VSCode only)

1. Create new project.
2. Press Ctrl-Shift-P and search for Lua: Open Addon Manager in the context menu that opens.
3. Search for Umbrella, and click enable.

Manual Installation

1. Create new project.
2. Download the correct version of Umbrella (PZ versions used) from Releases page.
3. Copy the downloaded folder into your project somewhere.

Install from Repository

1. Create new project.
2. Clone the repository into a sub-folder.
3. cd [your folder]
4. git submodule update --init --remote

Installing Umbrella Globally

If you want to install Umbrella globally, Add a path to Umbrella via this extension setting:

If you want to use Umbrella with IntelliJ IDEA, you need to use a build from before 2023 as modern EmmyLua doesn't currently support indexing. You can download older builds of IntelliJ here.

Support

Discord Server

https://discord.gg/u3vWvcPX8f

If you like what I do and helped your community a lot, feel free to buy me a coffee! https://ko-fi.com/jabdoesthings

https://www.paypal.com/paypalme/JabJabJab