Using aka.singlesimple.md

Using aka.singlesimple

aka.singlesimple introduces a much simpler config interface than aka.config. It stores one enum per config.

The config is loosely synced by having a timestamp in the memory and updating the value from file every second. For the sync to fail, the user would have to use value in script A, change the value from script B, and then immediately use the value in script A, all within a second, which is possible but unlikely.

To use the aka.singlesimple, you can call make_config at the start of your script:

ss = require("aka.singlesimple")
config = ss.make_config("aka.actor", { "Style", "Actor", "Effect" }, "Actor")

ss = require "aka.singlesimple"
config = ss.make_config "aka.actor", { "Style", "Actor", "Effect" }, "Actor"

• The first parameter to make_config specifies the config name. In this example, we use the name aka.actor and the config will be stored at ?config/aka.actor.json. ?config is linked to configDir specified in DependencyControl's config.
• The second parameter is a table listing all the possible values.
• The third parameter is the default value and the fallback value for the enum. It must be one of the values specified in the second parameter.

After that, you can use Config.value to get the value:

aegisub.debug.out(tostring(config:value()))

aegisub.debug.out tostring config\value!

When you need to change the value, you can call Config.setValue:

config:setValue("Effect")

config\setValue "Effect"

Note that Config.setValue may fail if the value given is not presented in the list of possible values, in which case aka.singlesimple will print a message to aegisub.debug.out and aegisub.cancel. If you want to handle the error yourself, you can call Config.setValue2, which will return a Result table from aka.outcome.