Skip to content

Docs + Fixes + Minor Edits #6

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 24 commits into from
Jan 3, 2023
Merged

Docs + Fixes + Minor Edits #6

merged 24 commits into from
Jan 3, 2023

Conversation

ithinkandicode
Copy link
Collaborator

@ithinkandicode ithinkandicode commented Jan 3, 2023 •
edited
Loading

Mostly improves docs, as well as:

  • Removes the requirement to use --enable-mods
  • Skips files in res://mods that aren't either ZIP or PCK files
  • Adds support to mod_log and dev_log to pass a mod name, which prefixes the log string, eg "ModLoader: ..."
  • Fixes a few issues (eg. crashing if a dependency is missing)

Breaking Changes

The funs mod_log and dev_log now accept the mod name as the 2nd arg (with it being used to prefix log message), with pretty being moved to the 3rg arg. The commits for this are ddc2538 and 66780bf.

@ithinkandicode
Trim trailing whitespace
5a34bfa 
Done automatically by VS Code
@ithinkandicode
Remove requirement for command line to enable
e2e799c
@ithinkandicode
Fix game install directory string when running via the editor
325f8f0
@ithinkandicode
update func mod_log to accept a mod name as the 2nd arg, to prefix logs
ddc2538
@ithinkandicode
update func dev_log to accept a mod name as the 2nd arg, to prefix logs
66780bf
@ithinkandicode
update instances of mod_log to use new 2nd arg for name prefix
35ff7e6
@ithinkandicode
add double-line spacing between funcs
e07a207
@ithinkandicode
move stray var _savedObjects up to other vars position
66c074f
@ithinkandicode
add docs comment for each main var
d4f6d6f
@ithinkandicode
add main heading comments, and update old heading comments to use a c…
f05ca4c 
…leaner format
@ithinkandicode
add comment docs for func installScriptExtension
0e6d023
@ithinkandicode
add comment docs for func addTranslationFromResource
e1578f2
@ithinkandicode
docs: expand readme to include basic setup info, links to Delta-V, an…
0b25b04 
…d list of helper funcs
@ithinkandicode
readme - general additions
b7fe5bd
@ithinkandicode
installScriptExtension - ensure child script file exists
30783f5
@ithinkandicode
fix code error in mod_log usage of mod_name
67f6bd2
@ithinkandicode
add missing space in a mod_log
b46623b
@ithinkandicode
ignore files that aren't ZIP or PCK
5334582
@ithinkandicode
before _check_dependencies: Ignore mods that aren't loadable
d7992d9
@ithinkandicode
dev_log: Add an option to enable them without the CLI option
c5f35ad
@ithinkandicode
check_dependencies: Fix crash if a dependency is missing
cf3a5b4 
Just needed to move a bit of code up slightly
@ithinkandicode ithinkandicode changed the title Docs + Edits Docs + Fixes + Minor Edits Jan 3, 2023
KANAjetzt
KANAjetzt reviewed Jan 3, 2023
View reviewed changes
KANAjetzt
KANAjetzt reviewed Jan 3, 2023
View reviewed changes
KANAjetzt
KANAjetzt reviewed Jan 3, 2023
View reviewed changes
Copy link
Member

@KANAjetzt KANAjetzt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the work you put in here 😊

I added 2 small comments - let me know what you think.

@ithinkandicode
Copy link
Collaborator Author

Cheers KANA, I've resolved one of them and replied to the other

@KANAjetzt KANAjetzt merged commit d505d9c into GodotModding:main Jan 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KANAjetzt KANAjetzt KANAjetzt left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ithinkandicode @KANAjetzt