Installation

Installation Guide

This guide covers all installation methods for the Atomic Plugin in JetBrains Rider.

📋 Requirements

System Requirements

• JetBrains Rider: Version 2024.1 or newer (up to 2025.1)
• Operating System: Windows, macOS, or Linux
• .NET SDK: 6.0 or higher
• Unity: 2020.3 LTS or newer (for Unity projects)

Prerequisites

• Atomic Framework installed in your project
• Active JetBrains Rider license or trial

🛍️ Installation from JetBrains Marketplace

Step-by-Step Instructions

1. Open JetBrains Rider

   • Launch your Rider IDE

2. Navigate to Plugin Settings

   • Windows/Linux: File → Settings → Plugins
   • macOS: Rider → Preferences → Plugins

3. Search for the Plugin

   • Click on the Marketplace tab
   • Type "Atomic" in the search box
   • Look for "Atomic - Code Generator for Atomic Framework"

4. Install the Plugin

   • Click the Install button
   • Accept any required permissions
   • Wait for the download to complete

5. Restart Rider

   • Click Restart IDE when prompted
   • Save any open work before restarting

📦 Manual Installation

Downloading the Plugin

1. Get the Latest Release

   • Visit Releases Page
   • Download the latest .zip file (e.g., ReSharperPlugin.AtomicPlugin-0.1.4.zip)
   • Note: Do NOT extract the ZIP file

2. Verify the Download

   • Check file integrity if checksums are provided
   • Ensure the file size matches the release notes

Installing from Disk

1. Open Plugin Settings

   • Windows/Linux: File → Settings → Plugins
   • macOS: Rider → Preferences → Plugins

2. Install from Disk

   • Click the gear icon ⚙️ next to Installed
   • Select Install Plugin from Disk...
   • Navigate to your downloaded .zip file
   • Select it and click OK

3. Restart Rider

   • Click Restart IDE when prompted
   • The plugin will be activated after restart

🔧 Building from Source

Prerequisites for Building

• Gradle: 7.6 or newer
• JDK: 17 or newer
• Git: For cloning the repository
• PowerShell (Windows) or Bash (macOS/Linux)

Build Instructions

1. Clone the Repository

   git clone https://github.com/Prylor/atomic-rider-plugin.git
   cd atomic-rider-plugin

2. Build the Plugin

   • Windows:

     .\buildPlugin.ps1

   • macOS/Linux:

     ./gradlew buildPlugin

3. Locate Built Plugin

   • Find the ZIP file in output/ directory
   • File will be named like ReSharperPlugin.AtomicPlugin-X.X.X.zip

4. Install Built Plugin

   • Follow the Manual Installation steps above
   • Use your locally built ZIP file

✅ Verifying Installation

Check Plugin Status

1. Open Plugin Settings

   • Go to File → Settings → Plugins
   • Click on Installed tab

2. Verify Plugin is Listed

   • Look for "Atomic" in the plugin list
   • Check that it shows as Enabled
   • Version should match what you installed

3. Test Plugin Features

   • Right-click in Project view
   • Check for New → Atomic File option
   • Open any .atomic file - syntax highlighting should work

Enable Plugin Features

If the plugin is installed but not working:

1. Check Plugin is Enabled

   • In Plugin settings, ensure checkbox is checked
   • Click Apply if you made changes

2. Verify File Associations

   • Go to File → Settings → Editor → File Types
   • Look for "Atomic File" in the list
   • Should be associated with *.atomic extension

3. Clear Caches (if issues persist)

   • File → Invalidate Caches...
   • Select Invalidate and Restart

🔄 Updating the Plugin

Automatic Updates

1. Enable Auto-Updates

   • Go to File → Settings → Plugins
   • Click gear icon ⚙️ → Manage Plugin Repositories...
   • Ensure JetBrains Marketplace is listed

2. Check for Updates

   • Rider will notify you when updates are available
   • Click Update when prompted

Manual Update

1. Check Current Version

   • Go to File → Settings → Plugins → Installed
   • Note your current Atomic plugin version

2. Download New Version

   • Visit Releases Page
   • Download the newer version

3. Update Process

   • Uninstall current version (optional but recommended)
   • Install new version following Manual Installation
   • Restart Rider

⚠️ Troubleshooting Installation

Common Issues

Plugin Not Visible After Installation

• Ensure you restarted Rider
• Check the plugin is enabled in settings
• Verify Rider version compatibility

"Incompatible Version" Error

• Check your Rider version (Help → About)
• Plugin requires Rider 2024.1 - 2025.1
• Update Rider or use compatible plugin version

Installation Fails

• Ensure you have write permissions
• Check disk space
• Try manual installation instead
• Disable antivirus temporarily during installation

Plugin Crashes Rider

• Start Rider in safe mode
• Disable the plugin
• Report issue with logs to GitHub Issues

Getting Help

• Check FAQ for common questions
• Review Troubleshooting Guide
• Report issues on GitHub
• Include Rider version, plugin version, and error logs

🚀 Next Steps

Once installed successfully:

1. Read Getting Started guide
2. Follow the Tutorial for your first project
3. Configure Plugin Settings
4. Create your first .atomic file

---

Need Help? Check our Troubleshooting guide or report an issue on GitHub.