Extension Storing Settings

[alsomar]

I’m currently searching for the best way to store some settings for an extension, like show or hide the context menu (just an example).

I’ve read this topic, but it’s like six years old and maybe there’s some other ways to explore.

The Correct Way to Store Plugin Settings & Data

I’ve been struggling to find out where to store various data both user made/edited and set by a plugin. So far I’ve not been able to find one “blessed answer” from anyone. So I created a list and compiled the suggestions of various authors for where to store data/settings for plugins. Suggestions for Where to Store Data @tt_su recommends not saving anything in the Plugins folder, because those files are liable to be deleted unexpectedly when updating/installing plugins: @DanRathbun recommend…

Any advice?

[rwamoore]

This is a year later:

Extensions with data outside of sub-folder?

No. the substring "%AppData%" (case insensitive) is for use in Windows batch files and paths in the explorer bar. (Try pasting into the explorer address bar.) So it is platform specific. What I’m getting at is that it’s an environment variable which is accessed in Ruby via the hash-like ENV object. IS_WIN ||=( Sketchup.platform == :platform_win rescue RUBY_PLATFORM !~ /darwin/i ) if IS_WIN APPDATA_PATH ||= ENV["APPDATA"] # check for proper encoding! else # Mac APPDATA_PATH ||= "~/Library/…

[rtches]

What about this one?
write_default

You can read it with:
read_default

[slbaumgartner]

@rtches

What about this one?
write_default

You can read it with:
read_default

I’ve used those methods most of the time in my extensions. Just be aware that there are some data types they can’t capture or may distort. For example, I vaguely remember that an empty array will come back as nil? Test to make sure they handle what you need correctly. You may need to resort to something like JSON to assure correct storage and retrieval.

[DanRathbun]

@rtches

What about this one?
write_default

You can read it with:
read_default

These have another drawback (although I myself use them in some quick and dirty plugins.)

The drawback (besides what Steve mentioned) is that these settings are stored in the %LocalAppData% …"PrivatePreferences.json" file along with application interface metrics.

In recent versions on MS Windows using the Qt GUI framework, this JSON file is often corrupted and causes application crashes. The usual fix is to manually delete the whole file and then the user loses all settings for plugins and the application. A restart will regenerate the file back to “factory defaults” for the application settings, but all the specific plugin settings will need to be initialized by the individual extensions as if they were just installed.

---

So, it may be better for you to go with your own separate JSON files.

I’ve shown how to do this in multiple topics here. I’ll see if I can find some links …

[DanRathbun]

@alsomar

I’ve read this topic, but it’s like six years old and maybe there’s some other ways to explore.

What I said and posted in that topic at post 14 …

• The Correct Way to Store Plugin Settings & Data - #14 by DanRathbun

… is all still relevant. It is all basic computer file facts that will not change.

---

Still looking for my posts on saving Ruby Hash ↔ JSON file.

[DanRathbun]

@DanRathbun

Still looking for my posts on saving Ruby Hash ↔ JSON file.

Here are a few editions of JSON settings code I have posted in the past …

• SU2018 with MacOS - .plist File Access - #6 by DanRathbun

• Storing Plugin Data Revisited (Wall Presets) - #19 by DanRathbun

Such a set of methods could be part of your standard extension template file(s).

[alsomar]

@rtches

What about this one?
write_default

You can read it with:
read_default

Hi there @rtches. Thank you so much for this info, I’ll give it a try!

@slbaumgartner

I’ve used those methods most of the time in my extensions. Just be aware that there are some data types they can’t capture or may distort.

Good to know, thank you for the advice!

@DanRathbun

What I said and posted in that topic at post 14 …

• The Correct Way to Store Plugin Settings & Data - #14 by DanRathbun

… is all still relevant. It is all basic computer file facts that will not change.

Thank you, Dan. I’ve already seen some of the posts you’re sending (which I’m going to read again carefully), but I preferred to ask just in case there’s some info or new ways to do that (they’re a few years old by now).

Have a nice day!