Skip to content

(POTENTIALLY BREAKING CHANGE) Change Script Directory Layout for More Modular Approach #5

@mmvest

Description

@mmvest

I have noticed that the idea of making the user download a script, resources, modules, etc. and then having them place everything in the proper location may cause more problems than just allowing what I call a "modular" setup in the directory tree. What I am thinking of is the following:

scripts/
├── script_name01_dir/
│   ├── script_name01.lua
│   ├── modules/
│   ├── resources/
├── script_name02_dir/
│   ├── script_name02.lua
│   ├── modules/
│   ├── resources/
├── script_name03.lua  # Standalone script not in a subdirectory
├── global_modules/
│   ├── imgui/
│   │   ├── imgui.lua       #meta file for imgui bindings so you can use intellisense
│   ├── uiforge/
│   │   ├── uiforge.lua     #meta file for globals exposed by uiforge so you can use intellisense
├── global_resources/

Then this way, we keep backwards compatibility (hopefully) but still allow for modules to be shipped as zips or as a whole directory that requires nothing more than to paste it into the scripts directory and extract it if it is compressed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions