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

Support .meta.json #123

Closed
LPGhatguy opened this issue Feb 5, 2019 · 6 comments · Fixed by #183 or #189
Closed

Support .meta.json #123

LPGhatguy opened this issue Feb 5, 2019 · 6 comments · Fixed by #183 or #189
Labels
scope: cli Relevant to the Rojo CLI type: enhancement Feature or improvement that should potentially happen

Comments

@LPGhatguy
Copy link
Member

This is an alternative to init.model.json support (#114) and opens up a lot of neat features like allowing scripts to be disabled (#34) and giving us a place to stick metadata about uploaded assets (#41).

It'll look like a pared-down version of .model.json files, supporting just properties, and maybe asset-specific metadata:

{
    "properties": {
        "Disabled": {
            "Type": "Bool",
            "Value": true
        }
    },
    "uploadedAssetId": "12342124"
}
@LPGhatguy LPGhatguy added the type: enhancement Feature or improvement that should potentially happen label Feb 5, 2019
This was referenced Feb 5, 2019
@LPGhatguy LPGhatguy added this to the 0.5.0 blockers milestone Feb 5, 2019
@LPGhatguy LPGhatguy added the scope: cli Relevant to the Rojo CLI label Feb 8, 2019
@jerrin-foster
Copy link

Any ETA yet? Really looking forward to this.

@LPGhatguy
Copy link
Member Author

Shouldn't be hard to build out! I'm planning on getting to this within the next week or two.

@LPGhatguy
Copy link
Member Author

I don't think this is quite done -- we still should consider having non-init .meta.json files for attaching metadata to existing instances.

This is a little trickier! For example, to attach metadata to foo.server.lua, do you name your meta file foo.meta.json? foo.server.lua.meta.json? What happens if there's also a foo.lua?

@osyrisrblx
Copy link

foo.server.meta.json?

@jerrin-foster
Copy link

As @osyrisrblx says, using an implied file ext would be better, but I'd suggest just keeping it as strict & simple as possible. Very few people will have a case wherein they have 2 different objects with the same name in the same location, so using the base name of the file should suffice.

(e.g. foo.meta.json should work for foo.lua, foo.server.lua, etc.)

@Kampfkarren
Copy link
Member

As I said on Discord, implied filenames are the easiest, with an optional attribute in the meta.json file to specify what file you're talking about.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: cli Relevant to the Rojo CLI type: enhancement Feature or improvement that should potentially happen
Projects
None yet
4 participants