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

Update docs for latest release (5.0.1) #126

Closed
6 tasks done
ithinkandicode opened this issue Feb 24, 2023 · 12 comments
Closed
6 tasks done

Update docs for latest release (5.0.1) #126

ithinkandicode opened this issue Feb 24, 2023 · 12 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ithinkandicode
Copy link
Collaborator

ithinkandicode commented Feb 24, 2023

It looks like there's a lot of new stuff in the latest release that's not documented.

https://github.com/GodotModding/godot-mod-loader/releases/tag/v5.0.1

I haven't worked on these features so I think they might need to be added by the person who worked on them

*Edit by @KANAjetzt
Added @
*Edit2 by @KANAjetzt
Added PRs

@ithinkandicode ithinkandicode added the documentation Improvements or additions to documentation label Feb 24, 2023
@ithinkandicode
Copy link
Collaborator Author

If there's docs that are needed for something you guys have added but aren't 100% confident with writing docs I'm happy to edit and expand on any initial content you write :)

@ithinkandicode
Copy link
Collaborator Author

ithinkandicode commented Feb 27, 2023

Also, it might be a good idea to add docs for contributing to ModLoader. In particular, how to add new classes to the auto install script (eg PR #127).

@KANAjetzt
Copy link
Member

v5.0.0 is missing on - Breaking-Changes

@ithinkandicode
Copy link
Collaborator Author

@KANAjetzt Do you know what the breaking changes were?

@KANAjetzt
Copy link
Member

I think the validation implemented by #71 ?

@KANAjetzt
Copy link
Member

Just checked - from Discord:

Darkly77 — 16/02/2023 09:38
What about #91? It's the dependency validation. If a mod on 4.1 has an invalid dependency, it will work, but now the mod won't load

@ithinkandicode
Copy link
Collaborator Author

Thanks @KANAjetzt , I've updated the Breaking Changes page on the wiki.

For the auto install docs, @Qubus0 started writing some for PR #33, and I added them to the wiki for safe keeping here.

@KANAjetzt
Copy link
Member

KANAjetzt commented Mar 23, 2023

I added a new page, Mod Loader Setup. Feel free to move things around.

https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Loader-Setup

@KANAjetzt
Copy link
Member

I added the Overwriting Game Resources page
https://github.com/GodotModding/godot-mod-loader/wiki/Overwriting-Game-Resources

@KANAjetzt
Copy link
Member

I don't think we need specific docs fot the overrides.cfg?

@Qubus0
Copy link
Collaborator

Qubus0 commented Mar 23, 2023

no, it can just be part of the setup. since the flags there are already mentioned, we can just add maybe one additional sentence to use that if the pck embedded or optionally if they don't want to modify the exe and don't use mods that change autoloads

@Qubus0
Copy link
Collaborator

Qubus0 commented Mar 30, 2023

didn't realize there was still something left by me. updated it, I think we're good for 5.x

@Qubus0 Qubus0 closed this as completed Mar 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants