ncsoft/unreal.js

★ 3,755Audience · developerComplexity · 4/5LicenseSetup · hard

Mindmap

mindmap
  root((Unreal.js))
    What it does
      JS in Unreal Engine
      V8 scripting plugin
      npm package support
    Features
      Full Unreal API access
      Live reload
      V8 debugger support
      Editor extensions
    Tech Stack
      JavaScript ES modern
      V8 engine
      TypeScript defs
    Use Cases
      Game logic in JS
      Custom editor tools
      Multiplayer scripting
    Versions
      UE 4.11 to 4.27
      UE 5.0 to 5.1

mindmap root((Unreal.js)) What it does JS in Unreal Engine V8 scripting plugin npm package support Features Full Unreal API access Live reload V8 debugger support Editor extensions Tech Stack JavaScript ES modern V8 engine TypeScript defs Use Cases Game logic in JS Custom editor tools Multiplayer scripting Versions UE 4.11 to 4.27 UE 5.0 to 5.1

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Write Unreal Engine game logic in JavaScript instead of C++, using modern syntax and npm packages you already know

USE CASE 2

Build custom Unreal Editor panels and tools using JavaScript without writing C++ plugin code

USE CASE 3

Debug Unreal game scripts using VS Code breakpoints through the V8 protocol, stepping through JavaScript running inside the engine

USE CASE 4

Add live-reload JavaScript scripting to an Unreal Engine project so script changes take effect without restarting the editor

Tech stack

JavaScriptTypeScriptC++V8Unreal Enginenpm

Getting it running

Difficulty · hard Time to first run · 1h+

Must install the plugin into your Unreal Engine project's Plugins folder and rebuild the project, available versions only cover up to UE 5.1.

BSD 3-Clause, use freely in personal or commercial projects, just keep the copyright notice and don't use the project name for endorsement.

In plain English

Unreal.js is a plugin for Unreal Engine, the game development platform used to build many commercial games and real-time 3D applications. The plugin adds JavaScript scripting directly inside Unreal Engine, so developers can write game logic, extend the editor, and interact with the engine using JavaScript instead of or alongside the usual C++ and Blueprint visual scripting tools. The JavaScript environment is powered by V8, the same engine that runs JavaScript in Chrome and Node.js. This means the plugin supports modern JavaScript syntax and allows you to import and use packages from npm, the standard JavaScript package registry. It also supports CommonJS-style modules, so code can be organized the way JavaScript developers are already accustomed to. From within a JavaScript script, you get access to the full Unreal Engine API: you can create actors in the game world, move them around, subclass existing engine classes, define replicated properties for multiplayer, and extend the Unreal Editor itself with custom panels and tools. The plugin includes a JavaScript console inside the editor for quick testing. Live reload is supported, so changes to scripts take effect without restarting the engine. Debugging works through the V8 protocol, which means you can use Visual Studio, Visual Studio Code, WebStorm, or any compatible IDE to set breakpoints and step through JavaScript running inside Unreal Engine. Auto-completion is available in Visual Studio Code through automatically generated TypeScript definition files. The plugin is available through the Unreal Engine Marketplace for versions 4.11 through 4.27 and 5.0 to 5.1. It can also be installed manually by cloning the core repository into a project's Plugins folder. A demo project and several example scripts are provided to help get started. The code is released under the BSD 3-Clause license.

Copy-paste prompts

Prompt 1

Show me how to set up unreal.js in an Unreal Engine 5 project and write a JavaScript actor that moves a mesh up and down on tick.

Prompt 2

Help me write a custom Unreal Editor panel in JavaScript using unreal.js that lists all actors in the current level and lets me select one.

Prompt 3

I want to use a popular npm package inside Unreal Engine via unreal.js, show me how to install it and import it in a game script.

Prompt 4

Set up VS Code debugging for a JavaScript script running inside Unreal Engine via the unreal.js V8 protocol, show me the launch.json config.

Open on GitHub → Explain another repo

← ncsoft on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.