Skip to content

leixingyu/unrealScriptEditor

Repository files navigation

Unreal Python Editor PyPI

A Qt widget that's the Unreal equivalent of the "Maya Script Editor".
This repo hosts the Python module, for the Unreal plugin, see this repo

About The Project

ui

With the rapid advancement of Unreal Engine and the Python support in Unreal Engine, more and more people are jumping into Unreal Python scripting. Hence the creation of this tool!

Getting Started

Prerequisites

The tool needs the following library to be installed:

Add as Menu Button

The tool is meant to be launched from a menu bar button like such:

menu

You can set up this very easily by adding startup.py as a startup script, under Project Settings - Plugins - Python

  • download & extract the project zip file
  • find the startup.py location, and add it to the startup scripts: e.g. C:\Downloads\unrealScriptEditor\startup.py

menu

Simple Launch Script

If you just want to launch the tool in Unreal's python console without adding it to menu, or if you want to customize the location where the tool is being launched; refer to the following command:

  • the tool has to be in a path that Unreal will search for!
from unreal_script_editor import main
global editor
editor = main.show()

Install as module

install with pip

pip install unreal-script-editor

Install the module from the repo

python -m pip install git+https://github.com/hannesdelbeke/unreal-script-editor

Features

  • Unreal "native" stylesheet
  • Save and load python files and temporary scripts
  • Code editor short-cut support and Highlighter
  • Auto-completion

Support

This tool is still in development, if there's any issue please submit your bug here or contact techartlei@gmail.com