Where are the docs & where are the config files?

[txtyash]

Where are the config files? Are they supposed to be under ~/.config? Is it even configurable? No docs?

[woelper]

Hi!

Where are the config files?

Linux $XDG_DATA_HOME or $HOME/.local/share /home/alice/.local/share
macOS $HOME/Library/Application Support /Users/Alice/Library/Application Support
Windows {FOLDERID_LocalAppData} C:\Users\Alice\AppData\Local

plus the filename .oculante.

from:
https://docs.rs/dirs/5.0.1/dirs/fn.data_local_dir.html

Is it even configurable?

Yes, through the UI, in settings. The format is JSON, so you can also edit the file directly.

No docs?

You can have a look here:

oculante/src/settings.rs

Lines 19 to 57 in 9e6eb81

	pub struct PersistentSettings {
	/// The UI accent color
	pub accent_color: [u8; 3],
	/// The BG color
	pub background_color: [u8; 3],
	/// Should we sync to monitor rate? This makes the app snappier, but also more resource intensive.
	pub vsync: bool,
	pub force_redraw: bool,
	/// Keyboard map to actions
	pub shortcuts: Shortcuts,
	/// Do not reset view when receiving a new image
	pub keep_view: bool,
	/// How many images to keep in cache
	pub max_cache: usize,
	pub show_scrub_bar: bool,
	pub wrap_folder: bool,
	/// Whether to keep the image edit stack
	pub keep_edits: bool,
	pub favourite_images: HashSet<PathBuf>,
	pub recent_images: Vec<PathBuf>,
	pub title_format: String,
	pub info_enabled: bool,
	pub edit_enabled: bool,
	// pos.x, pos.y, width, height
	pub window_geometry: ((u32, u32), (u32, u32)),
	pub last_open_directory: PathBuf,
	pub show_checker_background: bool,
	pub show_minimap: bool,
	pub show_frame: bool,
	pub current_channel: ColorChannel,
	/// How much to scale SVG images when rendering
	pub svg_scale: f32,
	pub zen_mode: bool,
	pub theme: ColorTheme,
	pub linear_mag_filter: bool,
	pub fit_image_on_window_resize: bool,
	pub zoom_multiplier: f32,
	pub borderless: bool,
	}

If you prefer to read the docs, you can clone the repo and run cargo doc --no-deps --open. You will then be able to see the PersistentSettings struct along with the documentation.

[Gigas002]

Just to add my 5 cents here, I personally think it'd be better to store configs using config_dir or config_local_dir. After all, .config is a right place for configs. MacOS and Windows users won't face any difference, of the above crate's values are used.

[woelper]

Great point, and I think you are right. I'll probably need tome migration strategy, but this seems good. Feel free to open an issue if you like!

[Hrxn]

@woelper

Windows {FOLDERID_LocalAppData} C:\Users\Alice\AppData\Local
plus the filename .oculante

Has this been changed recently?
It seems to be %LOCALAPPDATA%\oculante\config.json now, right?

The format is JSON, so you can also edit the file directly.

I just tried to do that, but somehow it behaves a bit unexpectedly..

oculante/src/settings.rs

Lines 46 to 47 in e468e6b

	// pos.x, pos.y, width, height
	pub window_geometry: ((u32, u32), (u32, u32)),

Don't really know rust, but u32 is surely 32-bit unsigned integer. I assume those values are in pixels?
Maybe because of serialization from JSON in rust?

[woelper]

Ah, that would explain it. Width and Height seem to work indeed, but I couldn't figure out how position works so far. Not really surprising if those values are not even read. So, what's happening in the end? Oculante app window randomly picking a position?

Oculante is doing it like most other applications and lets the OS/Window manager assign a position. I have thought long about saving the position, but issues like opening it on an external monitor, closing Oculante and disconnecting the monitor could lead to a position that is off screen. For that reason I decided to keep it simple.

I did not test yet if I can set the file to read-only and see if oculante would respect that.

Good question, I'd have to look at the code. I think opening would work, and there should never be a panic if it can't write. I think what would happen is that it tries to write, but won't succeed. Maybe I could add a "only save configuration manually" option in the future?

[Hrxn]

Oculante is doing it like most other applications and lets the OS/Window manager assign a position.

I see. But this behavior (n.b. have not tried v0.8.15 yet, but I don't think the commit log indicates any changes in that regard) where you can define a size but not a position leads to a specific problem, at least on Windows.
Simple steps to reproduce (delete config first):

1. First launch, app window appears upper-left-ish at somewhat small size.
2. Reposition a bit to the left, increase the width of the app window to the right screen border and close the window.
3. Launch oculante again, the window bar controls on the right are now off screen.

I have thought long about saving the position, but issues like opening it on an external monitor, closing Oculante and disconnecting the monitor could lead to a position that is off screen. For that reason I decided to keep it simple.

Simple is very good. But speaking a bit off-the-cuff here, if you have Windows with multiple monitors, there is still the "virtual" desktop and the 0, 0 position should always be anchored in the very top-left corner of the total displayed surface. This should always work, and prevent any off screen positioning, I think.
Of course, on macOS 0, 0 might be bottom-left instead of top-left, if I remember something correctly here, but I am not sure at all.

Good question, I'd have to look at the code. I think opening would work, and there should never be a panic if it can't write. I think what would happen is that it tries to write, but won't succeed. Maybe I could add a "only save configuration manually" option in the future?

Can't speak for everyone, but personally I would really appreciate such an option.

[Hrxn]

FWIW, after doing the STR above, and then opening config.json again I saw this:

  "window_geometry":[
    [
      4294967276,
      57
    ],
    [
      1869,
      645
    ]
  ],

I don't know what the first tuple is meant to represent, but that is what has been written into the config file by oculante.

[woelper]

Definitely good that I don't try to apply these values :) - That looks like a veeeery wide monitor or a bug, which is more likely...

[Hrxn]

😄
Just at-me here to hit me up whenever you want to test me something with Oculante on Windows™