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

Propose: Allow custom scripts to be loaded from a JSON file. #99

Open
wants to merge 3 commits into
base: 0.8.0
Choose a base branch
from

Conversation

SaintWish
Copy link

I think it would more neat to load custom scripts from a JSON file instead of modifying customScripts.lua, similar to how via data files are loaded. It's also configurable from the config table and obeys the order from the JSON file.

Currently, the custom scripts are loaded OnServerPostInit, I couldn't think of a better place of where scripts should be loaded. This would also resolve this issue #80

I'm open to any suggestions.

Here's what the JSON file would look like.

[
  {"script1": "custom/script1"}, //This script would be loaded first since it's first in the list.
  {"script2": "custom/script2"},
  {"someScript": "custom/someScript/main"}
]

@davidcernat
Copy link
Member

Can you rename "scripts.json" into "customScripts.json" first?

@rickoff
Copy link
Contributor

rickoff commented Oct 11, 2022

in this case, what do we do with the OnServerInit and OnServerPostInit events in our personnalized files ? I use it regularly for creating things at startup

@SaintMercury
Copy link

Perhaps the loading should be done in OnServerInit instead? That way you still get the event emission?

Really there should only be one ServerStarted like event (having init and postinit seems odd when there's already validators/handlers), but if PostInit is the defacto standard, loading in init makes the most sense.

@@ -0,0 +1,3 @@
[

Choose a reason for hiding this comment

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

This file should be valid json, and just an array is not.

{
  "customScripts": []
}

would be more acceptable in case a different json reader is used

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

Successfully merging this pull request may close these issues.

4 participants