OpenSkp 0.3.0

OpenSKP — C# / .NET SketchUp Binary Parser

OpenSKP is a pure class library that enables programmatic parsing of SketchUp (.skp) binary files without requiring Trimble SketchUp or its proprietary SDK.

🌟 Vision

Provide .NET developers (desktop, cloud, and mobile) with native, fast, zero-dependency access to SketchUp 3D models. Works seamlessly across Windows, macOS, Linux, and Xamarin/MAUI platforms.

🌐 Try the Live Web Viewer (Drag-and-Drop)

🚀 Installation

Install the package via the .NET CLI:

dotnet add package OpenSkp

Or via the NuGet Package Manager:

Install-Package OpenSkp

💻 Quick Start

1. Parse an SKP File

Open and parse a SketchUp model to inspect its metadata:

using System;
using OpenSkp;

class Program
{
    static void Main()
    {
        // Open and decode an SKP file
        SkpModel model = SkpFile.Open("house.skp");

        Console.WriteLine($"SketchUp File Version: {model.Version}");
        
        // Print Layer Names
        Console.WriteLine("Layers:");
        foreach (var layer in model.Layers)
        {
            Console.WriteLine($"- {layer.Name} (RGB: {layer.ColorR}, {layer.ColorG}, {layer.ColorB})");
        }

        // Print Materials List
        Console.WriteLine("Materials:");
        foreach (var material in model.Materials)
        {
            Console.WriteLine($"- {material.Name} (Transparency: {material.Transparency})");
        }

        // Walk component definitions and their geometry
        foreach (var (id, def) in model.Definitions)
        {
            Console.WriteLine($"Definition {id}: {def.Name} - {def.Vertices.Count} vertices, {def.Faces.Count} faces");
        }

        // model.Root holds whatever is placed directly in the model (not
        // inside any component/group), including root-level instances.
        Console.WriteLine($"Root-level instances: {model.Root.Instances.Count}");
    }
}

⚙️ Target Frameworks

OpenSKP targets .NET Standard 2.0, ensuring full compatibility with:

• .NET 5 / 6 / 7 / 8 / 9 (Console, Web APIs, ASP.NET Core)
• .NET Core 2.0+
• .NET Framework 4.6.1+ (WPF, WinForms)
• Mono / Xamarin / .NET MAUI (iOS, Android)

🖥️ Monorepo Package Ecosystem

OpenSKP is designed as a unified cross-platform monorepo:

• Python Package (openskp)
• TypeScript / JS Package (openskp)
• .NET Package (OpenSkp)
• Dart Package (openskp)

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.