pyral/GD-VirtualFileAccess
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
pyral 2024-12-03 13:20:05 -05:00
parent 77f9b4f86a
commit 260ce2fadb
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -10,6 +10,12 @@ Crop and Claw 2 is being written with moddability and engine-agnosticism in mind
For example, the runtime loads the base game package it expects, then mods, then allows for listening to a mods directory outside of zip archives. To do all this, we need to be able to load various file formats (png, ogg, specialized non-Godot formats, etc) into the engine and convert them to usable assets. This is obnoxious because loading and searching for files is different depending on if you are loading from directories or zip archives, and you have to manually cascade through zips and directories to find override assets. What's worse is more complications are added when new sources of file data could be encountered, such as streaming assets directly from a server. In order to reduce the pains, these scripts help build a dynamic virtual file loader. For example, the runtime loads the base game package it expects, then mods, then allows for listening to a mods directory outside of zip archives. To do all this, we need to be able to load various file formats (png, ogg, specialized non-Godot formats, etc) into the engine and convert them to usable assets. This is obnoxious because loading and searching for files is different depending on if you are loading from directories or zip archives, and you have to manually cascade through zips and directories to find override assets. What's worse is more complications are added when new sources of file data could be encountered, such as streaming assets directly from a server. In order to reduce the pains, these scripts help build a dynamic virtual file loader.
Currently supported loaders:
- FileAccess - for direct file/directory operations
- ZIPReader - to read one or many zip files at a time
- ZIPWriter - to write to a target zip file.
- VFileAccess - Yes, you can recursively use multiple VFileAccess instances to check for files using different methods.
## This thing's confusing. ## This thing's confusing.
No. I just hacked the code together quickly. Suppose you want to a folder or two... No. I just hacked the code together quickly. Suppose you want to a folder or two...