README file from
GithubXyl's Starmap
This is a star system map plugin for Obsidian (https://github.com/Archivist-3/Xyl-s-Obsidian-Starmap).
This plugin uses YAML format to create interactive star maps inside notes, linking notes between maps, planets, moons and other celestial bodies.
To check the expected YAML format, press CTRL + P / CMD + P and look for "Insert Starmap Template". This will insert a pre-formatted YAML into your note, which will render the starmap whenever outside the code block, or in reading mode! (CTRL/CMD + E) There is also an un-commented version, which has a single instance of every object, and no comments.
Installation
If installing directly from the Repo, go into releases, and fetch both main.js and manifest.json. Throw those bad boys into your plugin folder inside .obsidian/plugins/{Xyl's Starmap}
Features:
- Fully customisable colours. You may change the colour of every object in the maps.
- Planets with custom sizes
- With Moons custom sizes
- And Rings custom sizes, thickness, and 3D rotation.
- Asteroid Belts
- Objects inside the asteroid belts
- Labels for every object
- Percent-based positioning, so that planet's stay at the same relative point of maps, regardless of width or height.