Installation

Periodix-Planner can be installed through several methods. Choose the one that works best for you.

New to Periodix-Planner? Watch the video walkthrough to see all features in action.

📦 Method 1: Community Plugins (Recommended)

Once approved, Periodix-Planner will be available in the Obsidian Community Plugins directory:

1. Open Settings → Community plugins
2. Click Browse to open the community plugins browser
3. Search for "Periodix-Planner"
4. Click Install
5. Click Enable to activate the plugin

🔧 Method 2: BRAT (Beta Testing)

For early access to new features and beta versions:

1. Install the BRAT plugin if you haven't already
2. Open Settings → BRAT
3. Click Add Beta Plugin
4. Enter the repository URL: Real1tyy/Periodix-Planner
5. Click Add Plugin
6. The plugin will appear in your Community Plugins list
7. Enable it from there

📥 Method 3: Manual Installation

For manual installation from GitHub releases:

1. Download the latest main.js, manifest.json, and styles.css from the Releases page
2. Navigate to your vault's .obsidian/plugins/ folder
3. Create a new folder named periodix-planner
4. Copy the downloaded files into this folder
5. Reload Obsidian or restart the app
6. Enable the plugin in Settings → Community plugins

✅ Verification

After installation, verify everything is working:

1. Open Settings → Community plugins
2. Confirm Periodix-Planner is listed and enabled
3. You should see a Periodix-Planner settings tab in the main Settings page
4. Try the command "Generate all periods for today" from the command palette

🔄 Updating

Community Plugins

Updates will be available automatically through the Community Plugins interface. Simply click Update when a new version is available.

BRAT

BRAT will automatically check for updates. You can manually check by:

1. Opening Settings → BRAT
2. Clicking Check for updates
3. Updating if a new version is available

Manual Installation

Download the latest release files and replace the existing files in your plugin folder.

Troubleshooting

If you encounter issues during installation:

• Plugin not appearing: Make sure you've restarted Obsidian after installation
• Settings tab missing: Check that the plugin is enabled in Community Plugins
• Errors in console: Check the Developer Console (Ctrl/Cmd + Shift + I) for error messages

For more help, see the Troubleshooting Guide or open an issue on GitHub.

---

Next Step: Once installed, check out the Quick Start Guide to configure and start using Periodix-Planner!