Skip to content
This repository was archived by the owner on Feb 28, 2024. It is now read-only.

Document the other ways NML touches neos #54

Merged
merged 3 commits into from
Aug 14, 2022
Merged

Document the other ways NML touches neos #54

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4185247
Document the other ways NML touches neos
zkxs Aug 2, 2022
be2481e
interfaces
zkxs Aug 5, 2022
3c4e40d
no more touchy
zkxs Aug 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion doc/how_nml_works.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Going Into Detail: How NeosModLoader Interfaces with Neos

NeosModLoader only interfaces with Neos in two places: the hook and the compatibility hash.
NeosModLoader with Neos in two main places: the hook and the compatibility hash.
Copy link
Member

@XDelta XDelta Aug 2, 2022

Choose a reason for hiding this comment

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

Seems to be missing 'interfaces with'

Copy link
Collaborator Author

@zkxs zkxs Aug 5, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Fixed in be2481e


## The Hook

Expand Down Expand Up @@ -32,3 +32,8 @@ In order to make a client using NeosModLoader compatible with vanilla Neos the c
[components]: https://wiki.neos.com/Component
[logix]: https://wiki.neos.com/LogiX
[data model]: https://wiki.neos.com/Core_Concepts#Data_Model

## Other Minor Ways NeosModLoader Touches Neos
Copy link
Member

@XDelta XDelta Aug 2, 2022

Choose a reason for hiding this comment

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

Reads weird, may want to reuse 'Interfaces with' or list it as addition hooks.
Alternatively could refer to the main ones as 'Primary' and these as 'Secondary' hooks.
Primary as required to function
Secondary as QoL/additional features

Copy link
Collaborator Author

@zkxs zkxs Aug 5, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Fixed in 3c4e40d


- Hooking into the splash screen to show mod loading progress
- Hooking into Neos shutdown to trigger one last mod configuration save