-
Notifications
You must be signed in to change notification settings - Fork 2
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
FEATURE: Custom Scripts Arguments Overhaul #101
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OcelotWalrus
added
documentation
Improvements or additions to documentation
enhancement
New feature or request
labels
Apr 30, 2024
Hey @lumbar527! Would you mind giving this PR a review, thanks! (it's mostly documentation) |
Merged
lumbar527
approved these changes
May 1, 2024
Thanks for your review! Co-authored-by: lumbar527 <125756761+lumbar527@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
FEATURE
Summary
For starters, this PR is a part of a new wiki page guide, the Custom Scripting Guide which's an in-depth guide about custom scripting in Bane Of Wargs. This wiki page first introduces what a custom script and where they can be ran from the game data files, with an example of a custom script, then an explanation about arguments, and finally a detailed database about every functions of the game engine, for future content creators.
The PR first adds a set of new arguments you can choose from, whose goal is to be able to run any game engine function from a script; but it also adds a new feature, that allow data files to specify created arguments, with its custom value:
Usage examples
For example, let's say we wanna create a custom script that downloads the
source/main.py
file of this github repository. In the past, we'd make a specific script just to download that specific. So if later I'd want to download another file, another different script would be required. But now, you can just create a script, that passes an argument that can be "custom-made", so any file can be download:The download_fsspec.py file:
Many other examples could be use to show the application of this new feature.
Testing Done
Everything tested.
Testing Method
You can try making your own custom script with the new wiki page guide.
Performance Impact
N/A
Check-List