Add options api

[ego-lay-atman-bay]

One thing that I feel some addons benefit from are options. For example, a addon that whitelists extension urls.

return {
    // Metadata
    id: "example-mod", // the id of the mod
    name: "Example Mod", // human-readable name
    description: "A example mod for CrackleSDK.", // description
    version: "1.0", // version
    author: "Your Name", // author
    depends: [], // dependencies (mod ids, useful for libraries)
    doMenu: true, // whether to add a menu item
    
    options: {
      extensionUrls: [],
    },
    
    optionsDialog(dialogBody: Morph) {
      this.options.extensionUrls.push('https://ego-lay-atman-bay.github.io/snap-extensions/')
    },

    // Main function - gets ran when the mod is loaded
    main(api) {
      for (let url of this.options.extensionUrls) {
        SnapExtensions.urls.push(url)
      }
    },

    // Cleanup functions - get ran when the mod is "deleted"
    cleanupFuncs: [
      () => {
        SnapExtensions.urls = SnapExtensions.urls.filter(url => !this.options.extensionUrls.includes(url))
      }
    ],
}

options is the default options, and optionsDialog is the function used to build the options dialog. Since I know you probably don't want to have to deal with coming up with a system to handle every configuration, I think it would be best to have the addon developer build their own dialog. Now, I feel like this dialog should always have 3 buttons at the bottom, ok, apply, and cancel. The argument to the function should just be the dialog body morph that the dev can just build it like any morph.

I'm not entirely sure how the lifecycle will be. When the options are applied, should it run cleanup and then main again, or run main again but with some property somewhere set to indicate that the options were just changed.

As you might be able to tell, I'm pretty enthusiastic about this project. I have a couple userscripts that I would love to move over once crackle is stable. I'm also currently working on a couple other large projects, so right now I can only just give suggestions and pseudo-code.

[e016]

I think you might be able to get something like that with doMenu: true, but I think this could be helpful!

[ego-lay-atman-bay]

Oh, and by the way, I don't expect anyone to work on adding this yet, at least until after the rewrite is ready.

[codingisfun2831t]

at least until after the rewrite is ready.

I've decided not to rewrite it :-) I will add it after I safely merge d016's updates (GitHub.... It isnt a spam account..) and then fix up some docs. Hopefully Crackle will be usable soon, and gone are the days of userscripts! I could even add a better save format, similar to ampelectrecuted's idea, and so many other mods! I'm excited.. IF that day ever comes.

[codingisfun2831t]

So, I think it would be better if there is a auto generating dialog, and you could provide a custom function to create the morph that edits the option. There would be a "optionsFormat" list that would contain each item. Heres what it might look like:

[
  "Options", // text
  { name: "Number", type: "number", default: "42" }, // option
  { name: "String", type: "string", default: "Hello, world!" },
  null, // separator
  { name: "Custom": type: (val) => {
    // function that returns a morph, with contents as val, with a "get" function
  }, default: "whatever data that represents that"
]

Up to discussion!

[codingisfun2831t]

(sorry for closing it, I didnt mean to do that)