https://github.com/leixingyu/unrealscripteditor

Unreal Engine equivalent Maya Python Script Editor
https://github.com/leixingyu/unrealscripteditor

python ue5 unreal unreal-engine unreal-python

Last synced: 3 months ago
JSON representation

Unreal Engine equivalent Maya Python Script Editor

• Host: GitHub
• URL: https://github.com/leixingyu/unrealscripteditor
• Owner: leixingyu
• License: mit
• Created: 2022-06-27T01:02:32.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-09-15T06:40:34.000Z (over 1 year ago)
• Last Synced: 2024-05-08T00:12:32.636Z (9 months ago)
• Topics: python, ue5, unreal, unreal-engine, unreal-python
• Language: Python
• Homepage:
• Size: 88.9 KB
• Stars: 32
• Watchers: 2
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Unreal Python Editor [![PyPI](https://img.shields.io/pypi/v/unreal-script-editor?color=blue)](https://pypi.org/project/unreal-script-editor/) ![](https://img.shields.io/github/stars/leixingyu/unrealScriptEditor?label=GitHub%E2%AD%90)

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](https://github.com/hannesdelbeke/unreal-plugin-python-script-editor) ![](https://img.shields.io/github/stars/hannesdelbeke/unreal-plugin-python-script-editor?label=%E2%AD%90)

## About The Project



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:

- v0.0.2 uses [Qt.py](https://pypi.org/project/Qt.py/), and [PySide2](https://pypi.org/project/PySide2/) or [PyQt5](https://pypi.org/project/PyQt5/) 

- v0.0.3+ uses PySide6

### Add as Menu Button

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



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`



### 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!

```python

from unreal_script_editor import main

global editor

editor = main.show()

```

### Install as module

install with pip

```bash

pip install unreal-script-editor

```

Install the module from the repo

```bash

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

```

## Features

- [x] Unreal "native" [stylesheet](https://github.com/leixingyu/unrealStylesheet)

- [x] Save and load python files and temporary scripts

- [x] 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](https://github.com/leixingyu/unrealScriptEditor/issues)

or contact [[email protected]]()