Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 2.52 KB

README.md

File metadata and controls

71 lines (43 loc) · 2.52 KB

Obsidity Plugin

Description

Obsidian.md + Unity = Obsidity!

A tiny plugin that docks right in UnityEditor that allows you to take (Obsidian.md style markdown) notes easily and quickly.


Installation

  1. copy the repo-url (https://github.com/OikoumE/Obsidity.git)
  2. open unity package manager
  3. click "add from github"
  4. paste URL
image

The 'Obsidity Welcome' window should appear. (you can always find it by going to 'Window>Obsidity>Obsidity Intro')

When you initialize a Vault, the Intro window will close, and the editor window will appear in its place.

imageimage

After initializing you can access the Obsidity Editor via 'Window>Obsidity>Obsidity Editor'.

If you want to use Obsidian.md to read the notes, simply open Obsidian, in the bottom left corner you have the "Vault Manager", click it and select "Open folder as vault", navigate to '/Assets/Obsidity/'.

image image

you should see a <.obsidian> folder present, accept and Obsidian.md should automatically open a new window.

image

Usage

Currently the plugin requires all fields to be filled to save a file. You can hit Shift+Enter to save, if enabled and the large input field has focus.

When saving with Obsidity, new files are saved to: 'Assets/Obsidity//ObsidityNotes'. If you pair Obsidian.mb to the vault, new notes created with Obsidian is saved to ObsidianNotes. (the Obsidian save path can be changed via '/Assets/Obsidity//.obsidian/app.json' or via Obsidian settings)


Support

cant promise anything but you can try opening an issue here in the repo


Liscence

OpenSauce


Changelog:

26/11/24:

  • added export_unitypackage.yml workflow
  • changed from exporting unitypackage to importing github repo workflow 01/12/24:
  • added (multiple) settings and a few minor changes