Vault Nickname, a plugin for Obsidian

Features:

• Set a custom vault display name without renaming its folder.
• Choose the order of Obsidian's app title:
  1. Vault name before the document; or,
  2. Document name before the vault
• A new context menu item on the vault switcher menu provides quick access to changing the vault's nickname.

Motive:

This plugin is intended to help disambiguate vaults that share the same folder name. This is common for users who adhere to a standard file structure between multiple projects. E.g., a "docs/" folder within each project.

With thanks to:

• @claremacrae for her generous github sponsorship and bug reporting! ❤️
• @t0b1hh for testing and reporting an issue affecting macOS.
• @jakeanq for testing and reporting an issue affecting Arch Linux.
• @rashad-malik for suggesting the nickname file be kept in the plugin's install directory.
• @dominique-unruh for reporting a regression on Linux.
• @dudareviv for adding support for reading UF8-BOM nickname config files.

Install guide:

1. Open Obsidian's Settings.
2. Choose Community plugins from the left side bar.
3. If Restricted Mode is enabled, tap Turn on community plugins to disable it. Otherwise, skip this step.
4. Tap Browse.
5. Type Vault Nickname in the search bar.
6. Tap the Vault Nickname plugin.
7. Tap Install.
8. Tap Enable.
9. Tap Options to enter your custom nickname.
10. Done!

[!IMPORTANT]
🚨 Vault Nickname must be installed in each vault where you wish to see other vault nicknames from.

This is required because plugins can only affect the user interface of vaults where they're installed. If a vault doesn't need a nickname itself, but needs to see other vaults' nicknames, you may still install the plugin and simply clear the nickname field for the already-correct vault.

Plugin settings:

Vault nickname

The name to display instead of the vault's folder name. When this is blank, the vault's display name will fallback to its default value (its folder name). The button next to this setting assigns the vault's parent folder's name as the nickname. The parent folder's name is treated as the default nickname when the plugin is installed.

Nickname in app title

Choose how the nickname is applied to the app's title. The default value is "File name first" which is consistent with Obsidian's default behavior except the vault's nickname will be used.

Backwards compatibility

When enabled, the plugin will save additional data to ensure backwards compatibility with other vaults using versions of this plugin earlier than 1.1.9.