Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ncsoft/Unreal.js
Unreal.js: Javascript runtime built for UnrealEngine
https://github.com/ncsoft/Unreal.js
javascript plugin scripting unrealengine
Last synced: 15 days ago
JSON representation
Unreal.js: Javascript runtime built for UnrealEngine
- Host: GitHub
- URL: https://github.com/ncsoft/Unreal.js
- Owner: ncsoft
- License: other
- Created: 2015-11-18T22:51:40.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T09:03:36.000Z (12 months ago)
- Last Synced: 2024-04-15T02:31:21.287Z (3 months ago)
- Topics: javascript, plugin, scripting, unrealengine
- Homepage:
- Size: 37.8 MB
- Stars: 3,599
- Watchers: 186
- Forks: 346
- Open Issues: 157
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - Unreal.js
- awesome-unreal - Unreal.js - Javascript runtime built for Unreal Engine. (Awesome Unreal Repositories / Scripting)
- awesome-unreal - Unreal.js - Unreal.js: Javascript runtime built for UnrealEngine 4 (Scripting)
- awesome-stars - ncsoft/Unreal.js - Unreal.js: Javascript runtime built for UnrealEngine (Others)
- awesome-stars - Unreal.js
- awesome-ue4 - Unreal.js - Plugin for integrating JavaScript as a scripting language. (Assets / Scripting)
- awesome - ncsoft/Unreal.js - Unreal.js: Javascript runtime built for UnrealEngine (miscellaneous)
README
# Unreal.js
Unreal.js is a plug-in which brings V8-powered Javascript into UnrealEngine.
- [Link to Demo project](https://github.com/ncsoft/Unreal.js-demo)
- [Link to the Unreal Engine Marketplace](https://www.unrealengine.com/marketplace/unrealjs) (4.11-4.27, 5.0-5.1)
- [Update notes](https://github.com/ncsoft/Unreal.js/wiki/Update-notes)
- [Link to NDC 2017 presentation (KR)](https://www.slideshare.net/crocuis/unrealjs-ue4-75499471)
- [Link to NDC 2017 presentation Video (KR)](http://ndc.vod.nexoncdn.co.kr/NDC2017/videos/NDC2017_0114.mp4)
- Support Platform : Win64, Mac, Linux, Android, iOS
## Installation
- Search unreal.js on the epic marketplace
- Manual installation
1. `git clone https://github.com/ncsoft/Unreal.js-core /Plugins/UnrealJS`
2. `cd /Plugins/UnrealJS && ./install-v8-libs`
### Features
- Powered by latest [V8](http://v8project.blogspot.kr/) (ES6)
- CommonJS modules
- Full access to the whole UnrealEngine API
- Free to subclass existing classes including blueprint
- Live reload
- Communicate with outer world: REST(http), process(pipe), arraybuffer, ...
- Bridge API for editor extension
- Auto-completion for [**Visual Studio Code**](https://code.visualstudio.com/) (auto-generated [*.d.ts](http://definitelytyped.org/))
- Debugging within **Visual Studio**, Visual Studio Code, WebStorm and all IDE which supports V8 protocol
- Profiling supported by V8
- Dedicated Javascript console on UnrealEditor
- (Full) access to existing javascript libraries via npm, bower, ...
### Dummy demo
- Very simple demo available (https://github.com/ncsoft/Unreal.js/archive/snippet-editor.zip)
### Tutorials & documentation
- [Building the plugin](https://github.com/ncsoft/Unreal.js/wiki/Building-the-plugin)
- [Running the examples](https://github.com/ncsoft/Unreal.js/wiki/Running-the-examples)
- [Video tutorials](https://github.com/ncsoft/Unreal.js/wiki/Video-tutorials)
- [Wiki](https://github.com/ncsoft/Unreal.js/wiki)
### License
- Licensed under the BSD 3-Clause "New" or "Revised" License
- see [LICENSE](https://github.com/ncsoft/Unreal.js/blob/master/LICENSE) for details
### Examples
#### [2048](https://github.com/gabrielecirulli/2048)
- [View source code](https://github.com/ncsoft/Unreal.js/blob/master/Examples/Content/Scripts/2048/)
#### [Springy](http://getspringy.com)
- [View source code](https://github.com/ncsoft/Unreal.js/blob/master/Examples/Content/Scripts/helloSpringy.js)
#### Editor extension
- [View source code](https://github.com/ncsoft/Unreal.js/blob/master/Examples/Content/Scripts/extension-spiralGenerator.js)
#### Create a new actor
```js
let myActor = new Actor(GWorld,{X:10,Y:20,Z:30});
myActor.SetActorLocation({X:40,Y:80,Z:120});
```
#### Subclass an existing class
```js
class MyActor extends Actor {
properties() {
this.MyProp/*EditAnywhere+Replicated+int*/;
}
RPC(x/*int*/) /*Server+Reliable*/ {
console.log('This function is replicated',this.MyProp++);
}
}
let MyActor_C = require('uclass')()(global,MyActor);
if (GWorld.IsServer()) {
new MyActor_C(GWorld);
}
```
#### Node.js like
```js
let _ = require('lodash');
let kick = () => {
console.log("Hello timer!",_.keys(this));
setTimeout(kick,1000);
};
kick();
```