Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Why is there no documentation? #4

Open
bondhemlig opened this issue May 7, 2024 · 3 comments
Open

Why is there no documentation? #4

bondhemlig opened this issue May 7, 2024 · 3 comments

Comments

@bondhemlig
Copy link

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
Copy link

Janoti1 commented May 7, 2024

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
Copy link

sclu1034 commented May 8, 2024

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
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants