Aussiemon / Vermintide-2-Source-Code

Decompiled scripts from Warhammer: Vermintide 2.
80 stars 11 forks source link

Why is there no documentation? #4

Open bondhemlig opened 4 months ago

bondhemlig commented 4 months ago

The code has like no comments nor any explanations of how things works, is there a way to get that or is that just how it is?

Janoti1 commented 4 months ago

The code is just how it looks when debundled directly from the game. There are a few comments here and there but there are not a lot of them in the code.

Assuming that you are reading the code for the purpose of creating a mod for the game I would suggest reading the code of other mods and especially reading the documentation for the VMF (vermintide mod framework) which will allow you to easily adjust and modify the code of the game.

Feel free to join the modders discord if you have any specific questions here: https://discord.gg/XwST7fN

Read up on the VMF here: https://vmf-docs.verminti.de/#/initial-setup

Or read through the code of other open source mods of which many are listed in the VMF documentation and a many more here: https://steamcommunity.com/sharedfiles/filedetails/?id=2715578422

sclu1034 commented 4 months ago

LuaJIT bytecode (which is how the code is stored in the compiled game) doesn't carry comments. Fatshark does comment their code, as is evident by the fact that line numbers in stack traces rarely match the decompiled code, but they don't make it into the release build.

bondhemlig commented 4 months ago

Thanks, that clears it up for me, I will check out the vermintide mod framework, and also maybe read through the code of other open source mods.