# Karo Modum — Precision Instruments for Autodesk Revit > Precision-engineered add-ins for Autodesk Revit (BIM, architecture, structural & MEP engineering). Specializing in 1-click visibility diagnostics, local SQLite link change tracking, proactive model integrity enforcement, and parametric flashing detailing. Website: https://karomodum.com GitHub Documentation & Community: https://github.com/Rkb-locked/karo-revit-tools-docs Support: support@karomodum.com ## System Compatibility & Deployment - Supported Host: Autodesk Revit 2023, 2024, 2025, 2026, 2027 (64-bit). - Operating System: Windows 10, Windows 11 (x64). - Security Architecture: 100% on-premise execution inside Revit .NET API memory space. Zero cloud processing, zero model telemetry, air-gapped network support. - Deployment: Standard MSI installers with automated publisher certificate registration and silent deployment switches (`/quiet /qn /norestart`) for IT GPO, SCCM, and Microsoft Intune. - Trials: 14-day fully functional free trials available for direct download without registration. - Billing & Licensing: Managed securely via Lemon Squeezy (Merchant of Record). Transferable seats across workstations. ## Core Instruments ### 1. Karo.WhyHidden - Role: Instant Revit Visibility Diagnostics & 1-Click Fixes. - Problem Solved: In complex Revit projects, model elements frequently become invisible due to nested, overlapping view parameters. Manual troubleshooting takes 10–20 minutes across dozens of dialogs. WhyHidden diagnoses the exact cause in seconds. - 16 Automated Checks: 1. Direct hide (Hide in View -> Elements) 2. Category hidden in Visibility/Graphics (VG) 3. View filter overrides & Invisible Lines 4. View range clipping (Cut plane, Top, Bottom, View Depth) 5. Active Section Box boundary limits (3D views) 6. Phase & Phase Filter mismatch 7. Design Option assignment (non-primary option hidden) 8. Workset visibility overrides 9. Crop region boundaries 10. Annotation crop boundaries 11. Coarse/Medium/Fine detail level settings 12. Temporary Hide/Isolate sessions 13. View-specific 2D element placement 14. Graphic Overrides with invisible line weights 15. Linked RVT instance visibility 16. Controlling View Template locks - 1-Click Quick Fixes: Unhide element, reset invisible line overrides, restore temporary hide session directly from the diagnostic panel. - Pricing: $9 / month or $69 / year (individual license). - Direct Trial: https://download.karomodum.com/Karo.WhyHidden/Karo.WhyHidden-v1.2.11.msi - Technical Documentation: https://karomodum.com/docs/karo-whyhidden.txt - Comprehensive Web Troubleshooting Guide: https://karomodum.com/guides/revit-visibility-checklist ### 2. Karo.WhatsChanged - Role: Linked Model Change Auditing & Version Diffing. - Problem Solved: When architectural, structural, or MEP consultants reload revised Revit link models, critical geometry shifts and parameter modifications often go unnoticed, causing clashes during construction. WhatsChanged tracks every modification locally. - Core Capabilities: - 100% Local SQLite Diff Engine: Instant comparison without cloud uploading, project size limits, or model privacy exposure. - Geometry & Parameter Deltas: Pinpoints exact XYZ coordinate shifts, dimension deltas, type modifications, new additions, and deleted objects. - Visual Focus Dim: Isolates modified elements in active plan and 3D views while dimming unchanged context. - Automated 3D Section Box: Generates a tight 3D bounding box around modified structural nodes and MEP connections in one click. - Coordination Reports: Exports formatted Excel workbooks and meeting-ready PDF reports for subcontractor coordination meetings. - Pricing: $15 / month or $120 / year. - Direct Trial: https://download.karomodum.com/Karo.WhatsChanged/Karo.WhatsChanged-v1.11.9.msi - Technical Documentation: https://karomodum.com/docs/karo-whatschanged.txt ### 3. Karo.ModelGuard - Role: Real-Time BIM Error Prevention & Policy Enforcement for Teams. - Problem Solved: Prevents Revit model degradation, corruption, and sync bloat in multidisciplinary teams before harmful edits reach the central model. - Core Capabilities: - Intercepts High-Risk Actions: Blocks exploded AutoCAD DWG imports, unpinned grid and level deletions, unpinned RVT links, fake dimension overrides, in-place families, and unapproved external families. - Two Enforcement Modes: - StrictBlock: Hard intervention that cancels the destructive command immediately. - Justify: Requires the modeler to submit a mandatory text justification logged to the team record. - Shared Network Configuration: Distributes office BIM policies across local network shares (UNC) with automatic local cache fallback for offline/remote laptops. - Centralized Team Audit Log: Captures all policy violations and justified exceptions in a central SQLite audit trail for BIM Managers. - Pricing: $99 / month or $990 / year for a 5-seat team license (transferable seats). - Direct Trial: https://download.karomodum.com/Karo.ModelGuard/Karo.ModelGuard-v1.12.3.msi - Technical Documentation: https://karomodum.com/docs/karo-modelguard.txt ### 4. Karo.Segments - Role: Parametric Flashing, Trims, Parapet Copings & Facade Detailing. - Problem Solved: Eliminates repetitive 2D drafting for architectural sheet metal flashings, roof copings, sills, and facade reveals by snapping parametric 3D profiles directly to host geometry. - Core Capabilities: - Interactive Host Snapping: Snaps to planar faces and edges of walls, roofs, and slabs with live 3D ghost preview and corner miter detection. - Unified Profile Catalog: Manages profile marks, custom dimensions, RAL color finishes, unfolded girth widths, and lap joint offsets. - 4 View Presentation Modes: Instantly switches between Check (color-coded), Construction, Drafting (clean B&W vector lines), and Hidden styles. - Automated Fabrication Schedules: Produces native Revit schedules with embedded profile diagrams and exports formatted Excel cut lists with images. - Pricing: $19 / month or $149 / year. - Direct Trial: https://download.karomodum.com/Karo.Segments/Karo.Segments-v1.7.5.msi - Technical Documentation: https://karomodum.com/docs/karo-segments.txt ## Full Documentation & Specifications For complete technical specifications, see: - Full Aggregate LLM Document: https://karomodum.com/llms-full.txt - GitHub Documentation Repository: https://github.com/Rkb-locked/karo-revit-tools-docs --- # SECTION 1: DETAILED SPECIFICATION — KARO.WHYHIDDEN Why Hidden — Karo (Karo.WhyHidden) v1.2.11 Installation & Documentation ========================================= How to Use ---------- What it does Why Hidden — Karo instantly explains why a selected element is not visible on the current Revit view. Instead of manually checking Visibility/Graphics, filters, phases, crop regions, and many other settings, you get a clear list of possible causes — often with the exact filter name, category, or view template involved. Typical workflow 1. Select the element — on any view where you can pick it (Project Browser, another plan, a 3D view, etc.). 2. Switch to the view where the element should appear but does not. 3. On the Karo ribbon tab, click Why Hidden. 4. Review the results window: - Each reason is shown as a card with a short explanation and, where relevant, the specific setting name (filter, category, workset, template, etc.). - Multiple reasons can appear at once — Revit often hides an element for more than one reason. 5. Optional quick fixes — for some causes a Fix button is available: - Unhide — element was hidden via Hide in View → Elements - Reset invisible lines — element has an Invisible Lines graphics override - Reset temporary hide — a Temporary Hide/Isolate session is active on the view 6. Click Copy to paste the full analysis into an email, task, or report. 7. Switch language anytime with the EN / RU toggle in the footer (your choice is remembered). 8. Manage license anytime — hold Shift and click Why Hidden on the ribbon (or click the License button in the results window footer) to check remaining days, enter an activation key, or transfer your license. Supported view types Works on plans, sections, elevations, and 3D views. Does not work on schedules, sheets, panel schedules, or report views — switch to a graphical view first. Important - Select exactly one element. - Run the command on the view where the element is hidden, not visible. - If the element is actually visible, the plugin will tell you and ask you to confirm you are on the correct view. - To open the license window directly without running an analysis, hold Shift and click the ribbon button. What the plugin checks Cause | What it means -------------------------------|-------------------------------------------------- Direct hide | Hidden manually via Hide in View → Elements Category hidden | Category turned off in Visibility/Graphics (VG) View filter | A view filter hides the element or applies Invisible Lines View range | Element is outside the cut plane / top / bottom range Section box | Element is outside an active Section Box (3D views) Phase / phase filter | Element phase or the view's phase filter excludes it Design option | Element belongs to a non-primary design option Workset | Element's workset is hidden on this view Crop region | Element is outside the view crop boundary Annotation crop | Annotation lies outside the annotation crop Detail level | Element is not shown at the current detail level Temporary hide | Active Temporary Hide/Isolate session View-specific element | Detail item belongs to a different view (cannot appear here) Override graphics | Element overridden with Invisible Lines on this view Revit link | The link instance is hidden via VG settings View template (context) | A template controls VG, filters, and other settings on this view Installation ------------ Safe to install. Karo.WhyHidden is digitally signed by Karo BIM Solutions. Windows SmartScreen may show an "Unknown publisher" notice on first download until reputation builds — this is expected for specialized BIM software. The installer registers the publisher certificate automatically. Before you start - Close all running Revit sessions before installing or updating. - You need Windows administrator rights for installation (places add-in files in ProgramData and registers the publisher certificate once). - Make sure at least one supported Revit version (2023–2027) is installed. Step-by-step 1. Download Karo.WhyHidden-Setup.msi from your purchase confirmation or download page. 2. Double-click the downloaded .msi file. Windows Installer will launch and prompt for administrative permissions (UAC) to install per-machine. 3. If Windows SmartScreen shows "Windows protected your PC": - Click More info → Run anyway. 4. The installer automatically detects installed Revit versions (2023–2027), ensures Revit is closed, and seamlessly migrates any previous versions. - Full install — installs for all detected versions. - Custom selection — choose specific Revit years if needed. 5. Click Install and wait for completion. - The setup automatically registers the Karo publisher certificate in the Windows trust store for trusted future updates. 6. Start Revit. The Why Hidden button appears on the Karo ribbon tab. Silent & enterprise deployment For automated deployment across corporate networks or workstations, run via command line: msiexec /i "Karo.WhyHidden-Setup.msi" /qn Digital signature & security Karo.WhyHidden is digitally signed with a publisher certificate issued by Karo BIM Solutions. - Automated setup: The installer copies add-in files to C:\ProgramData\Autodesk\Revit\Addins\{year}\Karo.WhyHidden\ and registers KaroBimSolutionsPublic.cer into Trusted Root Certification Authorities and Trusted Publishers. - IT-managed environments: If Group Policy restricts automated certificate registration, system administrators can deploy KaroBimSolutionsPublic.cer across the domain via Group Policy. - Data privacy: The add-in runs entirely inside Revit via the standard Revit API. No model data is collected or transmitted over the network. License & device transfer - Activation in Revit: To activate your license or view status, press Shift and click the Why Hidden button on the ribbon (or click the License button in the window footer). Enter your key and activate. - Device transfer: If you upgrade your hardware or switch workstations, you can transfer or release your license to the new computer. - Subscription preservation: Moving or unbinding your license never forfeits or shortens your remaining paid subscription days — the full active period remains available. Updating Run the new .msi installer over the previous version. The installer handles upgrades and replaces older files automatically. No manual uninstall required. Uninstalling Use Windows Settings → Apps → Installed apps (or Control Panel → Programs and Features), select Karo.WhyHidden, and click Uninstall. Alternatively, right-click the .msi file and select Uninstall, or run: msiexec /x "Karo.WhyHidden-Setup.msi" /qn Plugin files are cleanly removed from all Revit Addins folders. System Requirements ------------------- Requirement | Details ---------------------|-------------------------------------------------- Software | Autodesk Revit 2023, 2024, 2025, 2026, or 2027 (any edition that supports add-ins) Operating system | 64-bit Windows 10 or Windows 11 (Revit platform requirement) Architecture | x64 only Permissions | Administrator rights for installation Disk space | ~5 MB per installed Revit version Revit project type | Any — architectural, structural, MEP; workshared and non-workshared models Network | Not required for daily use (plugin runs entirely inside Revit) Additional runtime | None — all dependencies are included in the installer Compatibility notes - One installer covers all supported Revit versions; only versions detected on your PC (or manually selected) are installed. - Revit must be restarted after installation for the add-in to load. - The plugin supports both English and Russian Revit installations. Tips and Limitations -------------------- Tips for best results - Workflow trick: If you cannot select the element on the problem view, select it elsewhere (Project Browser → Select by ID, or another view where it is visible), then switch views and run Why Hidden. - Multiple reasons: Revit can hide an element for several reasons simultaneously. Fix them in order — start with direct hide or temporary hide, then check filters and categories. - View templates: If a View Template is listed, it may be locking the setting that causes hiding. Edit the template or temporarily remove it to change VG or filters. - Workshared models: Workset visibility is checked per view — confirm the element's workset is visible in VG → Worksets. - Copy for coordination: Use the Copy button to share findings with colleagues without screenshots. - Language: Toggle EN / RU at any time; preference is saved to %AppData%\Karo\WhyHidden\settings.cfg. Quick fixes vs. manual changes Automatic Fix is available only for: - Direct element hide - Invisible Lines graphics override - Active Temporary Hide/Isolate All other causes (filters, categories, view range, phases, etc.) require manual changes in Revit — the plugin tells you exactly where to look. Known limitations - One element at a time — multi-selection is not supported. - Graphical views only — schedules, sheets, panel schedules, and report views are not supported. - Element must be hidden on the active view — if the element is visible, the plugin stops with an informational message. - Undetermined cases — in rare situations the element is hidden but no checker identifies the cause (e.g. an unsupported or future Revit visibility mechanism). The plugin will say "No hiding reasons detected" rather than guess. - View-specific elements cannot appear on other views by design — this is a Revit limitation, not a bug. - View filters — when several filters match, only the highest-priority active filter is reported (same logic as Visibility/Graphics → Filters order). - Section Box check — applies only to 3D views with an active Section Box. - No batch mode — analyze one element per command run. - Read-only analysis — except for the three quick-fix actions, the plugin does not modify your model unless you click Fix. Privacy The plugin does not collect or transmit project data. Logging is limited to debug diagnostics inside Revit and is not written to disk by default. --- # SECTION 2: DETAILED SPECIFICATION — KARO.WHATSCHANGED Karo — WhatsChanged (Karo.WhatsChanged) v1.9.3 Installation & Documentation ========================================= How to Use ---------- Karo — WhatsChanged helps you track what changed in your Revit project since you last reviewed it. It compares the main project file and any loaded linked models against your personal reference point and shows added, modified, deleted, and link-replaced items in a clear list. Getting started 1. Open a Revit project (main file with or without links). 2. On first open, the add-in quietly saves a reference point — no alert is shown. 3. When something changes later (for example, after a link reload or edits to the main file), a short notification appears in Revit. 4. Click View Changes in the notification, or open the Karo tab on the ribbon and click Whats Changed. The Changes window - Browse all detected changes in a sortable table with filters for change type (Added, Modified, Deleted, Link replaced), document (main file or a specific link), and free-text search. - The summary line shows counts by change type and how many rows match your current filter. - Click a row to locate the element on the active view — works for both the main file and linked models. - Color changes on view (main file only) — added elements are shown in green and modified elements in yellow on the active view. Linked models are not bulk-colored; use row colors in the table and click a row to zoom and select. - Remove focus effect — clears neighbor dimming around a selected element; main-file highlight colors stay until you mark changes as reviewed. - Scan main file — rescans the main project file and all links when you need a full refresh (background monitoring focuses mainly on linked models). - Export reports (Excel, PDF) — saves structured spreadsheets (.xlsx) or formatted PDF change summaries of the rows currently visible in the list, respecting your active filters. - Always open in 3D — when an element is hard to see on a plan or section, the add-in can open a dedicated 3D view and frame the element with about 2 meters of surrounding context. Drag the section box handles to adjust the view. When you are done reviewing Click Mark as reviewed. This saves the current model state as your new personal reference point, clears the change list, and removes highlight colors on the main file. This affects only your reference point — each team member keeps their own. Workshared and cloud projects (BIM 360 / ACC) Each user keeps a personal reference point; it is not shared with the team. For cloud-hosted models, your data is stored locally on your computer. After syncing with the central model, the list may include changes made by other users — use Scan main file when you need the full picture of the main project file. In-app help Open About in the top-right corner of the Changes window, then click How to use for a full guide inside Revit. The interface is available in English and Russian. To manage, check, or activate your license at any time, hold Shift and click the Whats Changed ribbon button (or click the button without an active license to open the activation window). Installation ------------ Before you install - Close all running Revit sessions. - You need administrator rights on your computer (places add-in files in ProgramData and registers the publisher certificate). - Supported versions: Autodesk Revit 2023, 2024, 2025, 2026, and 2027 (64-bit Windows). Step-by-step installation 1. Download Karo.WhatsChanged-Setup.msi from your purchase confirmation or download page. 2. Double-click the downloaded .msi file. Windows Installer will launch and prompt for administrative permissions (UAC) to install per-machine. 3. If Windows SmartScreen shows a warning such as "Windows protected your PC": - Click More info → Run anyway. 4. The installer automatically detects installed Revit versions (2023–2027), ensures Revit is closed, and seamlessly migrates any previous versions. You can choose full installation or select specific versions manually. 5. Click Install and wait for completion. - The setup automatically registers the Karo publisher certificate in the Windows trust store for trusted future updates. 6. When installation completes, start Revit. The add-in loads automatically — look for the Karo tab on the ribbon with the Whats Changed button. Where files are installed The add-in is placed in the standard Revit add-ins folder: C:\ProgramData\Autodesk\Revit\Addins\{year}\Karo.WhatsChanged\ (one folder per installed Revit year) Silent & enterprise deployment For automated deployment across corporate networks or workstations, run via command line: msiexec /i "Karo.WhatsChanged-Setup.msi" /qn Digital signature & security Karo.WhatsChanged is digitally signed with a publisher certificate issued by Karo BIM Solutions. - Automated setup: The installer places DLLs in ProgramData and registers KaroBimSolutionsPublic.cer into Trusted Root Certification Authorities and Trusted Publishers. - IT-managed environments: If corporate policy restricts automated trust registration, administrators can deploy KaroBimSolutionsPublic.cer via Group Policy. - Data privacy: All baseline comparison data is stored strictly on your local machine or local project directory. No project data or geometry is uploaded to external clouds. License & device transfer - Activation in Revit: To activate your license key or view remaining days, hold Shift and click the Whats Changed ribbon button. - Device transfer: If you upgrade your hardware or switch workstations, you can transfer your license to the new computer. - Subscription preservation: Moving or unbinding your license never forfeits or shortens your remaining paid subscription days — the full active period remains available. Updating Run the new .msi installer over the previous version. The installer handles upgrades and replaces older files automatically. No manual uninstall required. Uninstalling Use Settings → Apps → Installed apps (or Control Panel → Programs and Features), select Karo.WhatsChanged, and click Uninstall. Alternatively, right-click the .msi file and select Uninstall, or run: msiexec /x "Karo.WhatsChanged-Setup.msi" /qn This cleanly removes the add-in files from all Revit versions. System Requirements ------------------- Requirement | Details -------------------------------|-------------------------------------------------- Software | Autodesk Revit 2023, 2024, 2025, 2026, or 2027 (64-bit) Operating system | 64-bit Windows 10 or Windows 11 (same as supported by your Revit version) Architecture | x64 only Permissions | Administrator rights required for initial installation (adds files to ProgramData and registers the publisher certificate) Disk space | Approximately 15–25 MB per installed Revit version for the add-in; additional space for per-project reference data (typically a few MB per project) Network | Not required for normal use. Internet needed only to download the installer. Revit worksharing | Supported — personal reference point per user (Level 1 worksharing support) Cloud models | BIM 360 / Autodesk Construction Cloud (ACC) supported — reference data stored locally Languages | User interface: English and Russian Supported model content - Main Revit project file (host model) - Loaded Revit links (.rvt) - Detection of: added, modified, and deleted elements; parameter, type, level, phase, geometry, and location changes; link file replacement Data storage - Local / server models: {Project folder}\.Karo\WhatsChanged\ProjectState.db - Cloud models (no local folder path): %LocalAppData%\Karo\WhatsChanged\{project-guid}\ProjectState.db - User preferences: stored next to the add-in DLL in user-settings.json Your reference data stays on your computer. It is not uploaded to any external service. Tips and Limitations -------------------- Tips for best results - First open = silent baseline. When you open a project for the first time, the add-in saves a reference point without showing changes. Edits after that point will be detected. - Linked models are watched automatically. The add-in monitors loaded links in the background. Use Scan main file when you want to refresh the main project file as well. - Mark as reviewed regularly. Click Mark as reviewed when you have finished checking changes. This updates your personal reference point and clears highlight colors on the main file. - Use filters. Narrow a long list with the change-type filter, document filter (main file vs. a specific link), or the search box. - Deleted elements. Deleted items appear in the list only — they cannot be selected in the model. Check the Details column for the last known level, type, and position. - 3D navigation. If an element is off-screen on a plan or sheet, the add-in offers to open a dedicated 3D view. Enable Always open in 3D to skip the prompt. - Excel reports. Export the current filtered view to share change summaries with colleagues. - Switch views. Host highlight colors apply to the active view. If you switch views, open the Changes window or click Scan main file to re-apply colors on the new view. - Closed worksets. If not all worksets are open, the change list may be incomplete and false "deleted" rows are possible. Open all relevant worksets before reviewing. Known limitations - Personal reference point only. Each user has their own baseline. Marking changes as reviewed does not affect other team members' lists. - Loaded Revit links only. Unloaded, missing, or non-Revit link types are not fully tracked while unavailable. - No bulk color overlay on links. Linked model elements are not bulk-colored in the view. Use table row colors and click a row to zoom, select, and dim neighbors. - Host highlights on active view only. Added/modified coloring applies to the main file on the currently active view, not on all views at once. - Background scan scope. Automatic background monitoring focuses on linked models. The main project file is scanned when you open the Changes window or click Scan main file. - Worksharing sync. Syncing with the central model alone does not always mean something changed for you, but after sync the list may include changes made by others. - Deleted elements cannot be zoomed to. They are listed for information only, with last-known details from your reference point. - Performance. Very large models (tens of thousands of elements) may take longer to scan. The add-in shows a thin progress indicator during scanning. - Revit version match. Install the add-in for each Revit year you use. The multi-version installer handles this automatically when multiple Revit versions are present. What this tool is designed for Karo — WhatsChanged is built for day-to-day coordination: catching link updates, spotting unexpected edits, and reviewing changes before you sign off on a model state. It is a personal review assistant, not a full project audit log or multi-user change-management system. Support For questions or installation help, contact us at support@karomodum.com (also shown in the in-app About dialog). --- # SECTION 3: DETAILED SPECIFICATION — KARO.MODELGUARD Karo.ModelGuard Installation & Documentation ========================================= How to Use ---------- What it does Karo.ModelGuard enforces BIM policies while people work in Revit, not after the model is already damaged. When a controlled action happens, the add-in either asks for a written reason (Justify), blocks the action (StrictBlock), or stays silent (Disabled). Every decision is written to one shared team log on your network share. 100% On-Premise & Zero-Cloud. A single configuration folder on your network share serves as the single source of truth for the entire office — project models and governance data never leave your corporate perimeter. Who does what Role | What they do ---------------------|---------------------------------------------------------- BIM manager / admin | Creates the shared config once, sets policy modes, reviews the log and Terminal Everyone else | Installs the add-in, connects to the same folder, keeps working in Revit First-time setup (BIM manager) 1. Install Karo.ModelGuard on a machine with Revit (Karo.ModelGuard-Setup.msi). 2. Start Revit. If nothing is connected yet and the add-in is licensed, it automatically prompts you to launch Karo.ModelGuard Initial Configuration. 3. Choose Create new configuration. 4. Pick a network folder (UNC path) that all team machines can reach. 5. The app creates the folder structure and makes you the first administrator (current Windows user). 6. Restart Revit. Open the Karo tab → ModelGuard. - Tip: To manage, check, or activate your license at any time, hold Shift and click the ModelGuard ribbon button. Connecting other users 1. Install the same add-in. 2. On first run, choose Connect to existing configuration. 3. Select the same network folder the BIM manager created. 4. Restart Revit. Policies apply automatically — no manual JSON editing. Typical day for a user 1. Work in Revit as usual. 2. If a policy is in Justify mode (for example Explode CAD), a dialog asks for a short reason before the action continues. Cancel = action does not run. 3. If a policy is in StrictBlock mode, the action is cancelled and a clear message explains why. 4. Open ModelGuard only when you need Overview, How to use, or language (EN / RU). Typical day for an administrator 1. Open ModelGuard on the Karo ribbon. 2. Rules — set each policy to Disabled / Justify / StrictBlock. Changes save to the shared config and reach connected users without restarting Revit. 3. Log — filter the central CSV event log (who, when, which policy, justification text). 4. Terminal — see who is connected, Revit/plugin versions, last activity (monitor only — no settings here). 5. Administrators — add or remove admin Windows accounts when needed. Policies included Policy | Pain it prevents -----------------------------|-------------------------------------------------- Explode CAD | Flood of useless CAD geometry and imported linework Delete Shared Parameter | Broken schedules and lost project parameter data In-Place Family Creation | Uncontrolled in-place families that degrade performance and standards Dimension Text Override | Fake dimension overrides that conceal modeling inaccuracies Delete Levels & Grids | Disrupted multi-discipline coordination and lost datum baselines Delete RVT/CAD Links | Accidental removal of architectural, structural, or MEP linked models Import CAD | Direct CAD imports that pollute model views and template settings Approved Family Paths | Unapproved, bloated, or external families loaded from non-standard folders Important - Daily admin work happens inside Revit, not in Initial Configuration. - Initial Configuration is only for create or first connect. - If the network folder is temporarily unavailable, the add-in can keep working from a local cache; if there is no cache, it enters a safe mode that does not crash Revit. Installation ------------ Safe to install. Karo.ModelGuard is digitally signed by Karo BIM Solutions. Windows SmartScreen may show an "Unknown publisher" notice on first download until reputation builds — this is expected for specialized BIM tools. The installer registers the publisher certificate automatically. Before you start - Close all running Revit sessions before installing or updating. - You need Windows administrator rights for installation (places add-in files in ProgramData and registers the publisher certificate once). - Make sure at least one supported Revit version (2023–2027) is installed. - Plan a network share for the team configuration (BIM manager). Users need read access to the config folder and write access to the runtime/log folder (IT can set this once). Step-by-step 1. Download Karo.ModelGuard-Setup.msi from your purchase confirmation or download page. 2. Double-click the downloaded .msi file. Windows Installer will launch and prompt for administrative permissions (UAC) to install per-machine. 3. If Windows SmartScreen shows "Windows protected your PC": - Click More info → Run anyway. 4. The installer automatically detects installed Revit versions (2023–2027), ensures Revit is closed, deploys Karo.ModelGuard Initial Configuration, and seamlessly upgrades any previous installations. 5. Click Install and wait for completion. - The setup automatically registers the Karo publisher certificate in the Windows trust store for trusted future updates. 6. Start Revit. On the Karo ribbon tab you will see ModelGuard. 7. Complete Create or Connect in Initial Configuration when prompted, then restart Revit. Silent & enterprise deployment For automated deployment across corporate networks or workstations, run via command line: msiexec /i "Karo.ModelGuard-Setup.msi" /qn Digital signature & security Karo.ModelGuard is digitally signed with a publisher certificate issued by Karo BIM Solutions. - Automated setup: The installer deploys add-in files to ProgramData and registers KaroBimSolutionsPublic.cer into Trusted Root Certification Authorities and Trusted Publishers. - IT-managed environments: If Group Policy restricts automated trust registration, administrators can deploy KaroBimSolutionsPublic.cer via Group Policy. - Data privacy: All governance policies, local cache, and central event logs reside strictly on your local computer or designated on-premise network share. License & seat management - Activation in Revit: To check status, activate a license key, or manage seats, press Shift and click the ModelGuard ribbon button. - Workstation reassignment: Team seats can be unassigned and reassigned to different workstations or team members at any time. - Subscription preservation: Reassigning or transferring seats does not reduce, reset, or forfeit active subscription days. Updating Run the new .msi installer over the previous version. Local connection and cache are preserved — users do not need to run Initial Configuration again. Uninstalling Use Windows Settings → Apps → Installed apps (or Control Panel → Programs and Features), select Karo.ModelGuard, and click Uninstall. Alternatively, right-click the .msi file and select Uninstall, or run: msiexec /x "Karo.ModelGuard-Setup.msi" /qn Network configuration and log files on the share are not deleted. System Requirements ------------------- Requirement | Details ---------------------|-------------------------------------------------- Software | Autodesk Revit 2023, 2024, 2025, 2026, or 2027 (any edition that supports add-ins) Operating system | 64-bit Windows 10 or Windows 11 (Revit platform requirement) Architecture | x64 only Permissions | Administrator rights for installation Disk space | Add-in files per Revit year plus shared Initial Configuration under ProgramData Network | Network share required for team configuration and central log; local cache used if the share is temporarily unavailable Additional runtime | None — all dependencies are included in the installer Languages | User interface: English and Russian (default follows Revit language; switcher in the hub). Initial Configuration is English only Compatibility notes - One installer covers all supported Revit versions; only versions detected on your PC (or manually selected) are installed. - Revit must be restarted after installation and after first Create/Connect for the connection to load. - Daily administration is done inside Revit; Initial Configuration is only for creating a new shared config or connecting to an existing one. - The plugin supports both English and Russian Revit installations. Tips and Limitations -------------------- Tips for best results - Create once, connect many times. The BIM manager creates the shared folder once; everyone else only connects to that folder. - Use Justify before StrictBlock. Start with Justify to collect reasons and build team habits, then switch critical rules to StrictBlock. - Review the Log regularly. The central CSV log shows who triggered a policy, when, and what justification they entered. - Watch Terminal for rollout. Confirm plugin versions and connection health across the team without changing settings. - Offline is expected. If the network share is briefly unavailable, the add-in can continue from a local cache. Restore the share so the cache can refresh. - Language: Toggle EN / RU in the hub; preference follows the product language settings. Initial Configuration stays English. Known limitations - File-based configuration — centralized governance via network share without external cloud database dependencies. - Initial Configuration is not an admin console — change policy modes, administrators, and connection path from inside Revit after the first setup. - Safe mode — if there is no usable config and no local cache, the add-in enters a safe mode that does not crash Revit; policies may not enforce until configuration is available again. - Optimistic save conflicts — if two administrators save overlapping changes, the later save may need a reload and retry (no automatic merge). - IT folder permissions — users need read access to the config folder and write access to the runtime/log folder on the share. What this tool is designed for Karo.ModelGuard is built for day-to-day BIM governance: stopping expensive model-quality mistakes as they happen, with a shared audit trail. It is not a full document management system or a post-project model audit suite. Support For questions or installation help, contact us at support@karomodum.com. --- # SECTION 4: DETAILED SPECIFICATION — KARO.SEGMENTS Karo.Segments (Karo — Segments) Installation & Documentation ========================================= How to Use ---------- Karo — Segments is a Revit add-in for placing and managing user-defined segments as plates on host geometry. Use it for flashings, cover strips, drips, panels, cassettes, sheet-material layout, and other linear or planar segments — all sharing the same catalog, schedules, and display workflow. Opening the plugin 1. On the Karo ribbon tab, click Segments. 2. The hub opens with four sections: Creation & catalog, Schedule, Display, and How to use. 3. Window size, position, and the last section are remembered between sessions. 4. Switch language anytime with the EN / RU toggle in the hub sidebar. 5. Manage license anytime — hold Shift and click the Segments ribbon button (or click the button without an active license to open the activation window). Creating a segment 1. Fill in the type parameters (or keep the defaults), or select an existing mark in the catalog. The placement form always shows the type and length; other fields are collapsed — click "Show all parameters" or open the type list to expand them. 2. Click Place. 3. Pick a planar face in the model. 4. Pick a reference edge. While picking: R rotates the plate, Space mirrors it. Magnetic snap engages near segment ends and face corners; otherwise the point moves along the edge in 5 mm steps. 5. After placement, the segment appears in the catalog and in the model as a Karo plate. In the model - Edit parameters in the hub or in Revit Properties / native schedules — they share the same fields; invalid values are reverted with a toast. - Delete a plate with Del (no confirmation); undo with Ctrl+Z. - Move plates with Revit's Move tool — the snap anchor moves with them. - Copy/Paste creates a new segment of the same mark. - On selected Karo plates: R = rotate, Space = mirror (Revit's Rotate is blocked for Karo plates). Catalog & Parameters -------------------- Catalog The catalog lists segment marks (types): sizes, check and construction colors, RAL, and instance counts. Rows are grouped by Schedule group; segments excluded from schedules appear separately. - Click a row to fill the placement form and select matching segments in the model; selecting a plate highlights the catalog row. - Filter by mark and description with the box above the grid. - Right-click a row for Place, Edit type, Overlap and side offset, or Delete. - Shift- or Ctrl-click to multi-select; Delete can remove several marks at once. - In Per segment mode, a mark has a parent row and nested length/color variants. Placement, Edit type, Overlap Mode tabs at the top of Creation & catalog: - Placement — place new segments for the selected or configured type. - Edit type — mark, description, sizes, image, RAL, and more; Save applies changes. When selection changes, the form switches to the selected mark (unsaved edits are discarded). - Overlap and side offset — overlap/gap along length and side offset across width for the selected segments only; the snap anchor does not move. Length and color modes - Shared for type — length, RAL, and image are the same for every segment of the mark; edits update the whole type. - Per segment — length, RAL, and image can differ across length+color groups; other parameters stay type-wide. The catalog shows a parent row plus nested variants. To change length, color, or image on an existing plate in Per segment mode: select a nested catalog variant or a plate, open Edit type, change fields, and Save. The parent row sets defaults only for new placements. RAL / construction RGB drive Construction display color; check color drives Check mode. You can also edit Length, RAL, and image from Properties or a Revit schedule. If stored length disagrees with 3D geometry on Per segment marks, use "Restore lengths from model" in the catalog. Schedules & Excel ----------------- Schedule groups Groups come from the Schedule group field on segment types. - Select a group, then Open (existing schedule) or Create (missing schedule). - Create all missing builds schedules for every group that still needs one. - If you rename a schedule in the Project Browser or with other Revit tools, the plugin updates Schedule group on every type in that group and will not offer a duplicate. Excel export - Export to Excel saves the selected group's schedule as an .xlsx that matches the Revit schedule look (fonts, colors, borders, merges, column widths) and embeds each type's image. - The export is always one continuous table, even if the schedule is split across sheet fragments on a sheet. - Export all to Excel does the same for every created schedule — one worksheet per group in a single workbook. Shared parameters (segment type, description, length, width, image, unfolded width, and others) keep the hub, Properties, and native schedules in sync. Display Modes ------------- Select views (or sheets — the mode applies to all views on the sheet) and click Apply. Mode | Behavior ---------------|-------------------------------------------------- Check | Semi-transparent fill from the check color field Construction | RAL/RGB fill, black edges Drafting | White fill, black edges Hidden | Karo plates hidden on that view Filters help narrow the list: all / 3D / plans / sections / elevations / sheets. The display mode is remembered per view. Installation ------------ Safe to install. Karo.Segments is digitally signed by Karo BIM Solutions. Windows SmartScreen may show an "Unknown publisher" notice on first download until reputation builds — this is expected for specialized BIM tools. The installer registers the publisher certificate automatically. Before you install - Close all running Revit sessions. - You need administrator rights on your computer (places add-in files in ProgramData and registers the publisher certificate). - Supported versions: Autodesk Revit 2023, 2024, 2025, 2026, and 2027 (64-bit Windows). Step-by-step installation 1. Download Karo.Segments-Setup.msi from your purchase confirmation or download page. 2. Double-click the downloaded .msi file. Windows Installer will launch and prompt for administrative permissions (UAC) to install per-machine. 3. If Windows SmartScreen shows a warning such as "Windows protected your PC": - Click More info → Run anyway. 4. The installer automatically detects installed Revit versions (2023–2027), ensures Revit is closed, and seamlessly migrates any previous versions. You can choose full installation or select specific versions manually. 5. Click Install and wait for completion. - The setup automatically registers the Karo publisher certificate in the Windows trust store for trusted future updates. 6. When installation completes, start Revit. The add-in loads automatically — look for the Karo tab on the ribbon with the Segments button. Where files are installed The add-in is placed in the standard Revit add-ins folder: C:\ProgramData\Autodesk\Revit\Addins\{year}\Karo.Segments\ (one folder per installed Revit year) Silent & enterprise deployment For automated deployment across corporate networks or workstations, run via command line: msiexec /i "Karo.Segments-Setup.msi" /qn Digital signature & security Karo.Segments is digitally signed with a publisher certificate issued by Karo BIM Solutions. - Automated setup: The installer deploys DLLs to ProgramData and registers KaroBimSolutionsPublic.cer into Trusted Root Certification Authorities and Trusted Publishers. - IT-managed environments: If Group Policy restricts automated trust registration, administrators can deploy KaroBimSolutionsPublic.cer via Group Policy. - Data privacy: All segment models, geometry definitions, and Excel exports stay entirely inside your Revit model and local environment. License & device transfer - Activation in Revit: To activate your license key or view remaining days, hold Shift and click the Segments ribbon button. - Device transfer: If you upgrade your hardware or switch workstations, you can transfer your license to the new computer. - Subscription preservation: Moving or unbinding your license never forfeits or shortens your remaining paid subscription days — the full active period remains available. Updating Run the new .msi installer over the previous version. The installer handles upgrades and replaces older files automatically. No manual uninstall required. Uninstalling Use Settings → Apps → Installed apps (or Control Panel → Programs and Features), select Karo.Segments, and click Uninstall. Alternatively, right-click the .msi file and select Uninstall, or run: msiexec /x "Karo.Segments-Setup.msi" /qn This cleanly removes the add-in files from all Revit versions. System Requirements ------------------- Requirement | Details ---------------------|-------------------------------------------------- Software | Autodesk Revit 2023, 2024, 2025, 2026, or 2027 Operating system | 64-bit Windows 10 or Windows 11 Architecture | x64 only Permissions | Administrator rights for installation Revit project type | Architectural, structural, MEP; workshared and non-workshared Network | Not required for daily placement and catalog use Languages | English and Russian hub UI Compatibility notes - One installer covers all supported Revit versions; only versions detected (or manually selected) are installed. - Revit must be restarted after installation for the add-in to load. - Future Revit versions are included while the product is actively maintained. Tips and Limitations -------------------- Tips - Start from a catalog mark, then place multiple instances of the same type along edges. - Use Shared for type when length and color are identical for a mark; switch to Per segment only when variants differ. - After bulk edits in schedules or Properties, return to the hub to confirm catalog counts and colors. - Use Check mode to spot plates during coordination; switch to Construction or Drafting for drawings and sheets. - Prefer Export all to Excel when producing a full package for fabricators or quantity takeoff. Limitations - Segments are represented as DirectShape plates today; geometry is driven by segment data, not traditional loadable families. - Placement requires a planar face and a reference edge. - Magnetic snap targets segment ends and host face corners within a short range; free placement along the edge uses 5 mm steps. - Display modes apply to Karo plates only — they do not replace view templates or VG settings for other categories. - Multi-row catalog delete removes entire marks and their instances after confirmation. Privacy The plugin works inside your Revit model. It does not require an always-on cloud service for catalog, schedules, or display workflows.