@uepm/example-plugin 1.0.1

package/ExamplePlugin.uplugin

@@ -0,0 +1,24 @@
+{
+  "FileVersion": 3,
+  "Version": 1,
+  "VersionName": "1.0.0",
+  "FriendlyName": "Example Plugin",
+  "Description": "An example Unreal Engine plugin demonstrating NPM distribution pattern",
+  "Category": "Other",
+  "CreatedBy": "UEPM",
+  "CreatedByURL": "https://github.com/uepm/uepm",
+  "DocsURL": "",
+  "MarketplaceURL": "",
+  "SupportURL": "",
+  "CanContainContent": true,
+  "IsBetaVersion": false,
+  "IsExperimentalVersion": false,
+  "Installed": false,
+  "Modules": [
+    {
+      "Name": "ExamplePlugin",
+      "Type": "Runtime",
+      "LoadingPhase": "Default"
+    }
+  ]
+}

package/README.md

@@ -0,0 +1,90 @@
+# @uepm/example-plugin
+
+Example Unreal Engine plugin distributed via NPM, demonstrating the UEPM (Unreal Engine Package Manager) workflow.
+
+## Installation
+
+```bash
+npm install @uepm/example-plugin
+```
+
+## Prerequisites
+
+Your Unreal Engine project must be initialized for UEPM:
+
+```bash
+npx @uepm/init
+```
+
+## What's Included
+
+This plugin demonstrates:
+
+- **Basic plugin structure** - Standard Unreal Engine plugin layout
+- **NPM distribution** - Plugin distributed via NPM registry
+- **Engine compatibility** - Semver-based engine version requirements
+- **C++ module** - Simple module with logging functionality
+- **Plugin descriptor** - Proper .uplugin file configuration
+
+## Plugin Structure
+
+```
+@uepm/example-plugin/
+├── ExamplePlugin.uplugin     # Plugin descriptor
+├── package.json              # NPM package configuration
+├── Source/                   # C++ source code
+│   └── ExamplePlugin/
+│       ├── Private/
+│       │   ├── ExamplePlugin.cpp
+│       │   └── ExamplePluginModule.cpp
+│       ├── Public/
+│       │   ├── ExamplePlugin.h
+│       │   └── ExamplePluginModule.h
+│       └── ExamplePlugin.Build.cs
+├── Resources/                # Plugin resources
+│   └── Icon128.png
+└── README.md
+```
+
+## Engine Compatibility
+
+- **Unreal Engine**: 5.0.0 or later (< 6.0.0)
+- **Platforms**: All platforms supported by Unreal Engine
+
+## Usage in Unreal Engine
+
+1. Install the plugin via NPM
+2. Open your project in Unreal Engine
+3. Go to **Edit > Plugins**
+4. Find "Example Plugin" in the list
+5. Enable the plugin
+6. Restart the editor when prompted
+
+The plugin will log a message when loaded:
+
+```
+LogExamplePlugin: Example Plugin has been loaded!
+```
+
+## Development
+
+This plugin serves as a template for creating your own NPM-distributed Unreal Engine plugins. Key features:
+
+- **Proper package.json** with `unreal.engineVersion` field
+- **Standard plugin structure** following Unreal Engine conventions
+- **Build configuration** with proper module dependencies
+- **NPM publishing** ready with correct file inclusions
+
+## Creating Your Own Plugin
+
+Use this plugin as a starting point:
+
+1. Copy the plugin structure
+2. Rename files and classes
+3. Update package.json with your plugin details
+4. Implement your plugin functionality
+5. Publish to NPM
+
+## License
+
+MIT

package/Resources/Icon128.png

@@ -0,0 +1,3 @@
+# This is a placeholder for the plugin icon
+# In a real plugin, this would be a 128x128 PNG image file
+# For this example, we're using a text placeholder to demonstrate the file structure

package/Source/ExamplePlugin/ExamplePlugin.Build.cs

@@ -0,0 +1,42 @@
+using UnrealBuildTool;
+
+public class ExamplePlugin : ModuleRules
+{
+    public ExamplePlugin(ReadOnlyTargetRules Target) : base(Target)
+    {
+        PCHUsage = ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs;
+
+        PublicIncludePaths.AddRange(
+            new string[] {
+            }
+        );
+
+        PrivateIncludePaths.AddRange(
+            new string[] {
+            }
+        );
+
+        PublicDependencyModuleNames.AddRange(
+            new string[]
+            {
+                "Core",
+            }
+        );
+
+        PrivateDependencyModuleNames.AddRange(
+            new string[]
+            {
+                "CoreUObject",
+                "Engine",
+                "Slate",
+                "SlateCore",
+            }
+        );
+
+        DynamicallyLoadedModuleNames.AddRange(
+            new string[]
+            {
+            }
+        );
+    }
+}

package/Source/ExamplePlugin/Private/ExamplePlugin.cpp

@@ -0,0 +1,20 @@
+#include "ExamplePlugin.h"
+
+#define LOCTEXT_NAMESPACE "FExamplePluginModule"
+
+void FExamplePluginModule::StartupModule()
+{
+    // This code will execute after your module is loaded into memory; the exact timing is specified in the .uplugin file per-module
+    UE_LOG(LogTemp, Warning, TEXT("ExamplePlugin module has been loaded"));
+}
+
+void FExamplePluginModule::ShutdownModule()
+{
+    // This function may be called during shutdown to clean up your module.  For modules that support dynamic reloading,
+    // we call this function before unloading the module.
+    UE_LOG(LogTemp, Warning, TEXT("ExamplePlugin module has been unloaded"));
+}
+
+#undef LOCTEXT_NAMESPACE
+
+IMPLEMENT_MODULE(FExamplePluginModule, ExamplePlugin)

package/Source/ExamplePlugin/Public/ExamplePlugin.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include "CoreMinimal.h"
+#include "Modules/ModuleManager.h"
+
+class FExamplePluginModule : public IModuleInterface
+{
+public:
+
+    /** IModuleInterface implementation */
+    virtual void StartupModule() override;
+    virtual void ShutdownModule() override;
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@uepm/example-plugin",
+  "version": "1.0.1",
+  "description": "Example Unreal Engine plugin distributed via NPM",
+  "main": "ExamplePlugin.uplugin",
+  "scripts": {
+    "test": "vitest --run",
+    "test:watch": "vitest"
+  },
+  "unreal": {
+    "engineVersion": ">=5.0.0 <6.0.0",
+    "pluginName": "ExamplePlugin"
+  },
+  "files": [
+    "ExamplePlugin.uplugin",
+    "Source/**/*",
+    "Resources/**/*",
+    "Content/**/*"
+  ],
+  "keywords": [
+    "unreal",
+    "unreal-engine",
+    "plugin",
+    "uepm"
+  ],
+  "author": "",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}