| Name | unreal-script-editor JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | A Qt Python script editor, styled in Unreal stylesheet |
| upload_time | 2024-10-06 19:16:51 |
| maintainer | None |
| docs_url | None |
| author | Lei Xingyu, Hannes Delbeke |
| requires_python | >=3.4 |
| license | MIT License Copyright (c) 2023 Xingyu Lei Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
unreal
scripter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
unreal-stylesheet
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Unreal Python Editor [](https://pypi.org/project/unreal-script-editor/) 
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) 
## About The Project
<img src="https://i.imgur.com/KscixlU.png" alt="ui" height="580px"/>
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:
<img src="https://i.imgur.com/IcQGGu5.png" alt="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`
<img src="https://i.imgur.com/wJrkp5b.png" alt="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!
```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 [techartlei@gmail.com]()
Raw data
{
"_id": null,
"home_page": null,
"name": "unreal-script-editor",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": null,
"keywords": "unreal, scripter",
"author": "Lei Xingyu, Hannes Delbeke",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d0/f5/e257189a7c13b94b1f1f682c55e19423dde8cb20122ca46bbf7f40c796b1/unreal_script_editor-0.0.3.tar.gz",
"platform": null,
"description": "\n# Unreal Python Editor [](https://pypi.org/project/unreal-script-editor/) \n\nA Qt widget that's the Unreal equivalent of the \"Maya Script Editor\". \nThis repo hosts the Python module, for the Unreal plugin, see [this repo](https://github.com/hannesdelbeke/unreal-plugin-python-script-editor) \n\n\n## About The Project\n\n<img src=\"https://i.imgur.com/KscixlU.png\" alt=\"ui\" height=\"580px\"/>\n\nWith the rapid advancement of Unreal Engine and the Python support in Unreal\nEngine, more and more people are jumping into Unreal Python scripting. \nHence the creation of this tool!\n\n## Getting Started\n\n### Prerequisites\n\nThe tool needs the following library to be installed:\n\n- 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/) \n- v0.0.3+ uses PySide6\n\n\n### Add as Menu Button\n\nThe tool is meant to be launched from a menu bar button like such:\n\n<img src=\"https://i.imgur.com/IcQGGu5.png\" alt=\"menu\">\n\nYou can set up this very easily by adding `startup.py` as a startup script,\nunder _Project Settings - Plugins - Python_\n\n- download & extract the project zip file\n- find the `startup.py` location, and add it to the startup scripts: e.g. `C:\\Downloads\\unrealScriptEditor\\startup.py`\n\n\n<img src=\"https://i.imgur.com/wJrkp5b.png\" alt=\"menu\">\n\n### Simple Launch Script\n\n**If** you just want to launch the tool in Unreal's python console without adding it to menu,\nor if you want to customize the location where the tool is being launched;\nrefer to the following command:\n\n- the tool has to be in a path that Unreal will search for!\n\n```python\nfrom unreal_script_editor import main\nglobal editor\neditor = main.show()\n```\n\n### Install as module\ninstall with pip\n```bash\npip install unreal-script-editor\n```\n\nInstall the module from the repo\n```bash\npython -m pip install git+https://github.com/hannesdelbeke/unreal-script-editor\n```\n\n## Features\n\n- [x] Unreal \"native\" [stylesheet](https://github.com/leixingyu/unrealStylesheet)\n- [x] Save and load python files and temporary scripts\n- [x] Code editor short-cut support and Highlighter\n- [ ] Auto-completion\n\n## Support\n\nThis tool is still in development, if there's any issue please submit your bug\n[here](https://github.com/leixingyu/unrealScriptEditor/issues)\nor contact [techartlei@gmail.com]()\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Xingyu Lei Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A Qt Python script editor, styled in Unreal stylesheet",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/leixingyu/unrealScriptEditor",
"Source": "https://github.com/leixingyu/unrealScriptEditor"
},
"split_keywords": [
"unreal",
" scripter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d0e1c6eb8df70e8da08e679a1cdad5a1c7329f782df521c56289ce744ed0e80",
"md5": "703c155b26953b7ac98b0f427951b624",
"sha256": "4eab4c72a819d0cbc5c5db1d1cefea84e30a0d660003ca4330f5c4f3ab71fcf2"
},
"downloads": -1,
"filename": "unreal_script_editor-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "703c155b26953b7ac98b0f427951b624",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 28468,
"upload_time": "2024-10-06T19:16:50",
"upload_time_iso_8601": "2024-10-06T19:16:50.056546Z",
"url": "https://files.pythonhosted.org/packages/4d/0e/1c6eb8df70e8da08e679a1cdad5a1c7329f782df521c56289ce744ed0e80/unreal_script_editor-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d0f5e257189a7c13b94b1f1f682c55e19423dde8cb20122ca46bbf7f40c796b1",
"md5": "95d2279b0c7f38925201e1775a6c7524",
"sha256": "992d9fa96ec1dc2606e00f28e6ace1c29f8288f30f7006a8e6f7327f252b5926"
},
"downloads": -1,
"filename": "unreal_script_editor-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "95d2279b0c7f38925201e1775a6c7524",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 24352,
"upload_time": "2024-10-06T19:16:51",
"upload_time_iso_8601": "2024-10-06T19:16:51.326184Z",
"url": "https://files.pythonhosted.org/packages/d0/f5/e257189a7c13b94b1f1f682c55e19423dde8cb20122ca46bbf7f40c796b1/unreal_script_editor-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-06 19:16:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "leixingyu",
"github_project": "unrealScriptEditor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "unreal-stylesheet",
"specs": []
}
],
"lcname": "unreal-script-editor"
}
