scripts icon indicating copy to clipboard operation
scripts copied to clipboard

Add description field to script.json

Open ImperatorS79 opened this issue 6 years ago • 13 comments

This file should contains files describing the verbs, for example:

  • What is the purpose of the verb.
  • What are the requirements (wine version, driver, ...).
  • Possible conflicts (example : "this verb modifies d3d11 related dll, be careful with other verbs that do the same !").

Those informations should be displayed when someone wants to install a verb from the container tab for example.

ImperatorS79 avatar Jan 15 '19 16:01 ImperatorS79

The general idea was that verbs are first class citizens like any other app/plugin etc. Therefore it would be difficult (conceptionally) to add a different json for verbs. Is there anything which should be parsed/evaluated automatically? How would you want to use the information? If it's really only about displaying something, wouldn't a generic "note"/"description" field be enough?

plata avatar Jan 15 '19 16:01 plata

Yes, it's the same purpose as application.json -> when you click on it it displays the informations.

ImperatorS79 avatar Jan 15 '19 16:01 ImperatorS79

Then I would suggest simply a "description" field in script.json.

plata avatar Jan 15 '19 16:01 plata

Ok for me.

ImperatorS79 avatar Jan 15 '19 16:01 ImperatorS79

^^ Same time

plata avatar Jan 15 '19 16:01 plata

It should not only be for verbs but in general.

plata avatar Jan 15 '19 16:01 plata

I think we could even add a "conflict" field for listing conflicting verbs like winetricks does.

ImperatorS79 avatar Jan 15 '19 18:01 ImperatorS79

Possible but probably hard to maintain (imagine e.g. a script is renamed).

plata avatar Jan 16 '19 17:01 plata

If a script is renamed, you have to update every script calling it... So I do not think a script will be renamed.

ImperatorS79 avatar Jan 16 '19 17:01 ImperatorS79

Let's go for the description and then see what else we might need.

plata avatar Jan 16 '19 18:01 plata

How does this relate to #361? Do we need both (I don't think so). @madoar ?

plata avatar Mar 03 '19 10:03 plata

I think that #361 targets the same problem. I don't think we require both issues.

madoar avatar Mar 03 '19 15:03 madoar

Then I would prefer "description" over "note". So in my opinion we can close #361.

plata avatar Mar 03 '19 17:03 plata