A general module framework for the LVNACY Obsidian Apparatus. This module serves as a foundation and template for creating specialized modules within an Apparatus Obsidian Vault.
The Apparatus Module is designed to be installed in an Apparatus Obsidian Vault as a git submodule. Apparatus Vaults provide templated scaffolding and automated scripts for creating and managing specialized project modules. This repository serves as a blank slate to generate a scaffold.
The Apparatus philosophy is built around modular, compartmentalized project structures. As various module templates, scripts, and tools are completed, this README will be expanded with instructions for each type.
The Apparatus uses a compartmentalization model for managing different types of content and projects. This approach offers several key benefits:
Each module maintains its own independent git repository and version control history. This separation means you can track changes specific to each module without cluttering the main vault's history.
Because modules are self-contained units with their own version control, they can be easily shared, moved, or reused across different Apparatus vaults or even different Obsidian installations. A module that works in one vault will work in another without modification.
The compartmentalization model allows the Apparatus ecosystem to grow. Different module types—for story development, context libraries, image libraries, research databases, and more—can be added independently without affecting existing modules or the core vault structure.
To create a new project using available module templates:
Select "Use this template" to copy this repository as a new module. Then add your module to your Apparatus Obsidian Vault using git:
git submodule add https://github.com/lvnacy-notes/apparatus-story-module.git story-moduleThis module is designed to work within the broader Apparatus ecosystem. If installing in a vault that is not specifically an Apparatus Vault, ensure you have the Templater, Dataview, Folder Note, and Custom File Explorer Sort plugins installed and configured in your vault before using the scaffolding templates. You can copy over the necessary Apparatus templates, scripts, and plugins from the Apparatus Vault Template.
- Make sure this README is active in your editor in an Apparatus Vault
- Use the Templater command palette
- Select
Templater: Open insert template modal - Browse available module scaffolds based on your project type
- Select the scaffold for the module type you wish to generate
- Story Scaffolding (
story-scaffold): Generates a complete writing and revision structure for story development. Includes project specification, editorial workflow, and revision phase organization with dashboards to track scene progression through the editorial process. Leverages the Longform plugin.
Coming soon:
- Additional module templates and specialized scaffolding tools
- Enhanced plugin and script support
- Expanded documentation for each module type
Additional module types and templates will be added as they are developed.
In this repository? Absolutely fucking nothing. All of the tooling exists in the Apparatus Vault template. You can create a new blank repo to use as a module and install that, then run the commands. You need only a blank note in the module directory from which to run the scaffold commands. It's that easy.
This README will be expanded as additional module templates, scripts, and plugins are completed. The Apparatus is an evolving system designed to support multiple types of creative and informational projects.
For more information about the LVNACY Obsidian Apparatus architecture and philosophy, see the main apparatus documentation in your Apparatus Vault.