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.
- 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.)
- 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.
- Vscode installed.
- Lua Language Server extension installed.
- Create new project.
- Clone the repository into a folder.
cd [your folder]git submodule update --init --remote- Have fun!
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.
If you like what I do and helped your community a lot, feel free to buy me a coffee! https://ko-fi.com/jabdoesthings