Loading the documentation…

The Oda settings file

DataMind Oda keeps one settings file for each of its profiles on this computer, applied on top of the built-in defaults. This page covers what the file holds, how Oda applies and normalises it, how to edit it when support asks, and when an edit takes effect. For the settings you change in the app itself, start from Memory, skills and connectors.

What the file is

yaml
# DataMind Oda settings for this computer, applied on top of the built-in defaults.
# DataMind Oda keeps this file up to date; edit it only when DataMind support asks you to.
[]

How Oda applies the file

When you save a change in one of Oda's settings forms, Oda answers with that area's state as it stands after the change, with secret values hidden. If the area changed after the form read it, the save is refused and nothing is written: open the area again, check it, and apply the change again. Keys and sign-ins that settings use are kept as stored credentials, not in this file; how saves are refused and how credentials are stored and protected is on Settings and credentials.

Edit the file when support asks

  1. Open the file DataMind support points you to. Keep the two header lines and keep the body a list of changes.
  2. Make exactly the change support describes, with the names they give you.
  3. Save. Oda watches the file by its exact path and applies a valid change while it runs; a change saved while Oda is still starting waits until it is ready.
  4. If a change cannot be applied, Oda reports the problem, and the settings already in effect stay until you correct the file. Fix the file and save again, or restore the .before-update.bak copy beside it.

How Oda normalises the file

Oda normalises the file when it updates it:

Turning the file's changes off

Keep the header lines and replace the list below them with an empty one: []. The file stays valid and Oda starts normally, with nothing added on top of the built-in setup.

Warning

Never empty the file or leave only comments in it: a file with no list fails the next start. To turn off what the file adds, keep the header lines and write [].

When a change takes effect

Questions, answered

Is there one settings file or several?

One per profile. Each profile keeps its own file in its folder under the Oda home folder, and the ways Oda runs use their own profiles; Oda profiles and launchers covers them.

Do I ever need to open the settings file?

Only when DataMind support asks you to. Oda keeps the file up to date on its own, and the app's own pages are the place to change your setup.

Does the file replace Oda's built-in setup?

No. It carries only what is different on this computer and is applied on top of the built-in defaults; where it sets a value, its value wins over the default.

Why did the file change on its own?

Oda keeps it up to date. Changes you save in the app are recorded in the file, and when Oda updates it, an older header is replaced with the current one, Oda's own plugin names are brought to the @datamind/<name> form, and a row for one of your presets is adjusted so its instructions add to Oda's base behaviour. Comments and expressions outside those values stay as they are.

Will Oda keep the comments I add to the file?

Yes, for comments and expressions outside the values Oda replaces: they stay as they are when Oda updates the file, and when a change is saved from the app. Keep edits to what support describes.

What happens if I make a mistake in the file?

Oda does not ignore a broken file. A file it cannot read stops the next start, and Oda reports the problem; while Oda runs, a change it cannot apply is reported and the previous configuration stays. A row that names an unknown entry is skipped with the warning patch: entry "<name>" not found. Fix the file, or restore the .before-update.bak copy beside it.

How do I turn off what the file adds?

Keep the header lines and replace the list with an empty one: []. Do not empty the file or leave only comments; a file with no list fails to start.

Is the copy beside the file kept up to date?

No. The first rewrite leaves a copy of the file's earlier content beside it, with .before-update.bak added to its name, and later rewrites never overwrite that copy. Leave it in place.

Does editing the file need a restart?

Not while Oda runs with hot reload on: a valid edit is applied without a restart, once Oda is ready. With hot reload off, it is applied at the next start; nothing else about the file needs a restart.

What does it mean when Oda reports the file was left unchanged?

A rewrite could not be done safely, so the file was not touched and the settings already in effect stay. The report names the file and the reason: Profile settings file <path> was left unchanged: <error>. Correct the file and save again, or ask DataMind support.