@uepm/example-plugin 1.1.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ExamplePlugin.uplugin +2 -2
- package/package.json +10 -23
- package/README.md +0 -90
package/ExamplePlugin.uplugin
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"FileVersion": 3,
|
|
3
3
|
"Version": 1,
|
|
4
|
-
"VersionName": "
|
|
4
|
+
"VersionName": "2.0.1",
|
|
5
5
|
"FriendlyName": "Example Plugin",
|
|
6
6
|
"Description": "An example Unreal Engine plugin demonstrating NPM distribution pattern",
|
|
7
7
|
"Category": "Other",
|
|
@@ -21,4 +21,4 @@
|
|
|
21
21
|
"LoadingPhase": "Default"
|
|
22
22
|
}
|
|
23
23
|
]
|
|
24
|
-
}
|
|
24
|
+
}
|
package/package.json
CHANGED
|
@@ -1,31 +1,18 @@
|
|
|
1
1
|
{
|
|
2
|
-
"
|
|
3
|
-
"
|
|
4
|
-
"description": "Example Unreal Engine plugin distributed via NPM",
|
|
5
|
-
"main": "ExamplePlugin.uplugin",
|
|
6
|
-
"scripts": {
|
|
7
|
-
"test": "vitest --run",
|
|
8
|
-
"test:watch": "vitest"
|
|
9
|
-
},
|
|
10
|
-
"unreal": {
|
|
11
|
-
"engineVersion": ">=5.0.0 <6.0.0",
|
|
12
|
-
"pluginName": "ExamplePlugin"
|
|
13
|
-
},
|
|
14
|
-
"files": [
|
|
15
|
-
"ExamplePlugin.uplugin",
|
|
16
|
-
"Source/**/*",
|
|
17
|
-
"Resources/**/*",
|
|
18
|
-
"Content/**/*"
|
|
19
|
-
],
|
|
2
|
+
"author": "UEPM",
|
|
3
|
+
"description": "An example Unreal Engine plugin demonstrating NPM distribution pattern",
|
|
20
4
|
"keywords": [
|
|
21
5
|
"unreal",
|
|
22
6
|
"unreal-engine",
|
|
23
7
|
"plugin",
|
|
24
8
|
"uepm"
|
|
25
9
|
],
|
|
26
|
-
"author": "",
|
|
27
10
|
"license": "MIT",
|
|
28
|
-
"
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
11
|
+
"main": "ExamplePlugin.uplugin",
|
|
12
|
+
"name": "@uepm/example-plugin",
|
|
13
|
+
"unreal": {
|
|
14
|
+
"engineVersion": ">=5.7.0, <6.0.0",
|
|
15
|
+
"pluginName": "ExamplePlugin"
|
|
16
|
+
},
|
|
17
|
+
"version": "2.0.1"
|
|
18
|
+
}
|
package/README.md
DELETED
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
# @uepm/example-plugin
|
|
2
|
-
|
|
3
|
-
Example Unreal Engine plugin distributed via NPM, demonstrating the UEPM (Unreal Engine Package Manager) workflow.
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install @uepm/example-plugin
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Prerequisites
|
|
12
|
-
|
|
13
|
-
Your Unreal Engine project must be initialized for UEPM:
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
npx @uepm/init
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
## What's Included
|
|
20
|
-
|
|
21
|
-
This plugin demonstrates:
|
|
22
|
-
|
|
23
|
-
- **Basic plugin structure** - Standard Unreal Engine plugin layout
|
|
24
|
-
- **NPM distribution** - Plugin distributed via NPM registry
|
|
25
|
-
- **Engine compatibility** - Semver-based engine version requirements
|
|
26
|
-
- **C++ module** - Simple module with logging functionality
|
|
27
|
-
- **Plugin descriptor** - Proper .uplugin file configuration
|
|
28
|
-
|
|
29
|
-
## Plugin Structure
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
@uepm/example-plugin/
|
|
33
|
-
├── ExamplePlugin.uplugin # Plugin descriptor
|
|
34
|
-
├── package.json # NPM package configuration
|
|
35
|
-
├── Source/ # C++ source code
|
|
36
|
-
│ └── ExamplePlugin/
|
|
37
|
-
│ ├── Private/
|
|
38
|
-
│ │ ├── ExamplePlugin.cpp
|
|
39
|
-
│ │ └── ExamplePluginModule.cpp
|
|
40
|
-
│ ├── Public/
|
|
41
|
-
│ │ ├── ExamplePlugin.h
|
|
42
|
-
│ │ └── ExamplePluginModule.h
|
|
43
|
-
│ └── ExamplePlugin.Build.cs
|
|
44
|
-
├── Resources/ # Plugin resources
|
|
45
|
-
│ └── Icon128.png
|
|
46
|
-
└── README.md
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## Engine Compatibility
|
|
50
|
-
|
|
51
|
-
- **Unreal Engine**: 5.0.0 or later (< 6.0.0)
|
|
52
|
-
- **Platforms**: All platforms supported by Unreal Engine
|
|
53
|
-
|
|
54
|
-
## Usage in Unreal Engine
|
|
55
|
-
|
|
56
|
-
1. Install the plugin via NPM
|
|
57
|
-
2. Open your project in Unreal Engine
|
|
58
|
-
3. Go to **Edit > Plugins**
|
|
59
|
-
4. Find "Example Plugin" in the list
|
|
60
|
-
5. Enable the plugin
|
|
61
|
-
6. Restart the editor when prompted
|
|
62
|
-
|
|
63
|
-
The plugin will log a message when loaded:
|
|
64
|
-
|
|
65
|
-
```
|
|
66
|
-
LogExamplePlugin: Example Plugin has been loaded!
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
## Development
|
|
70
|
-
|
|
71
|
-
This plugin serves as a template for creating your own NPM-distributed Unreal Engine plugins. Key features:
|
|
72
|
-
|
|
73
|
-
- **Proper package.json** with `unreal.engineVersion` field
|
|
74
|
-
- **Standard plugin structure** following Unreal Engine conventions
|
|
75
|
-
- **Build configuration** with proper module dependencies
|
|
76
|
-
- **NPM publishing** ready with correct file inclusions
|
|
77
|
-
|
|
78
|
-
## Creating Your Own Plugin
|
|
79
|
-
|
|
80
|
-
Use this plugin as a starting point:
|
|
81
|
-
|
|
82
|
-
1. Copy the plugin structure
|
|
83
|
-
2. Rename files and classes
|
|
84
|
-
3. Update package.json with your plugin details
|
|
85
|
-
4. Implement your plugin functionality
|
|
86
|
-
5. Publish to NPM
|
|
87
|
-
|
|
88
|
-
## License
|
|
89
|
-
|
|
90
|
-
MIT
|