OrchardCore Module Creator

This skill guides you through creating new OrchardCore modules following project conventions.

Prerequisites

• OrchardCore repository at D:\orchardcore
• .NET SDK 10.0+ installed

Module Creation Workflow

Step 1: Determine Module Type

What kind of module are you creating?

Step 2: Create Module Directory

bash
1# Create module folder
2mkdir src/OrchardCore.Modules/OrchardCore.YourModule
3cd src/OrchardCore.Modules/OrchardCore.YourModule

Step 3: Create Required Files

Every module needs these three files:

1. Manifest.cs - Module metadata
2. Startup.cs - Service registration
3. OrchardCore.YourModule.csproj - Project file

See references/module-structure.md for templates.

Step 4: Add Components Based on Type

For Content Part modules:

Models/YourPart.cs
ViewModels/YourPartViewModel.cs
Drivers/YourPartDisplayDriver.cs
Views/YourPart.cshtml
Views/YourPart_Edit.cshtml

For Admin modules:

Controllers/AdminController.cs
Views/Admin/Index.cshtml
AdminMenu.cs
PermissionProvider.cs

For Data-storing modules:

Migrations.cs
Indexes/YourIndex.cs

See references/patterns.md for code templates.

Step 5: Register in Startup.cs

csharp
1public override void ConfigureServices(IServiceCollection services)
2{
3    // Content part
4    services.AddContentPart<YourPart>()
5        .UseDisplayDriver<YourPartDisplayDriver>();
6    
7    // Services
8    services.AddScoped<IYourService, YourService>();
9    
10    // Migrations (if storing data)
11    services.AddDataMigration<Migrations>();
12    
13    // Permissions (if securing features)
14    services.AddPermissionProvider<PermissionProvider>();
15    
16    // Navigation (if adding admin menu)
17    services.AddNavigationProvider<AdminMenu>();
18}

Step 6: Build and Test

bash
1# Build the module
2cd D:\orchardcore
3dotnet build src/OrchardCore.Modules/OrchardCore.YourModule
4
5# Run the application
6cd src/OrchardCore.Cms.Web
7dotnet run -f net10.0
8
9# Enable the feature in Admin → Features

Quick Reference

Naming Conventions

Common Dependencies

Add to .csproj as needed:

xml
1<!-- Core module support -->
2<ProjectReference Include="..\..\OrchardCore\OrchardCore.Module.Targets\OrchardCore.Module.Targets.csproj" />
3
4<!-- Content management -->
5<ProjectReference Include="..\..\OrchardCore\OrchardCore.ContentManagement\OrchardCore.ContentManagement.csproj" />
6
7<!-- Admin UI -->
8<ProjectReference Include="..\..\OrchardCore\OrchardCore.Admin\OrchardCore.Admin.csproj" />

Feature Categories

Use in Manifest.cs:

• Content Management
• Content
• Navigation
• Security
• Infrastructure
• Theming
• Developer

References

• references/module-structure.md - Directory layout and file templates
• references/patterns.md - Code patterns (parts, drivers, handlers, etc.)
• references/examples.md - Complete module examples
• AGENTS.md (repo root) - Coding conventions and build commands