fwolfe/zomboid-modding-guide

Guide to modding various aspects of Project Zomboid

zomboid-modding-guide's Issues

Translation section needs completion

The section covering translations is non-existent. This needs to cover the file structure, how to build proper translation support into mods, how to translate 3rd party mods, and use of the API's getText() function including string formatting positional
arguments.

3d modelling section needs completion

The guide is currently completely lacking in 3d modelling aspects such as importing for different object types (vehicles, weapons, clothes). Raw 3d modelling tutorials aren't really required, however application specific tutorials on exporting would be useful.
Problems like the blender version vs .x format issues should be listed and detailed.

Both build 40 and 41 methods could be outlined, its highly likely build 40 will continue to be in use for some time due to system requirement difference.

Since build 41 is still in beta at this point, any 41 info may end up becoming obsolete so this area could be considered low priority, but would be extremely useful for new modders.

Map modding section needs completion

Map creation techniques and tools need detailing, as well as tips, tricks, and gotchas by someone with a fair amount of expertise in this field. A actual tutorial for this would be nice as well. I suspect this will be very image heavy (screenshots).

Ideally the main body of the section should be in github style markdown. For separate tutorials markdown should be preferred however some flexibility should be considered for easier viewing offline.

Recommend modding communities

Since modding is generally a community effort (including this guide) it would be a good idea to provide links to existing modding communities. At the very least we should mention the IndieStone Discord server and its #modding channel.

Recommend IntelliJ IDEA

Under Required Tools (software) we are currently recommending Notepad++ as the preferred text editor, however as mentioned here in PR #4 we should be promoting the use of IDE over text editors such as Notepad++.

The best (or the smartest) Java IDE on the market is IntelliJ IDEA.

Document the hook system

Write information about how the hook system works:
https://github.com/FWolfe/Zomboid-Modding-Guide/blob/master/api/README.md#the-hook-system

API/README.md has a broken link

Line 211

./JavaClasses.md does not exist it would seem.

I'm looking through commits to see why it was removed.

Commit 8b73a72 shows that it's created but, somewhere along the line it's been dropped.

I'm guessing this was force pushed from a local clone and the JavaClasses.md got dropped then.

good references to read to know the API

Discussed in #14

^{Originally posted by SamiSul April 11, 2023}
In the guide I noticed the line:
Official documentation is outdated and sparse. The most effective way to find what's available to you is by reading the code.
Where can I find code to read? Thanks :)