| Name | unreal-stylesheet JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | |
| Summary | style qt like unreal 5 |
| upload_time | 2023-09-27 20:43:12 |
| maintainer | |
| docs_url | None |
| author | Xingyu Lei, Hannes Delbeke |
| requires_python | >=3.4 |
| license | MIT License Copyright (c) 2022 Xingyu Lei Copyright (c) 2023 Hannes D 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 |
qt
unreal
unrealengine
engine
pyside
pyside2
pyside6
pyqt5
pyqt6
stylesheet
dark
night
theme
darkmode
ui
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Unreal Stylesheet [](https://pypi.org/project/unreal-stylesheet/)
A Qt stylesheet designed to make your tools look native in Unreal Engine 5
Quickstart sample code:
```python
import unreal_stylesheet
if __name__ == '__main__':
app = QtWidgets.QApplication(sys.argv)
# style your QApp, requires a QApplication instance
unreal_stylesheet.setup() # <== Just 1 line of code to make the magic happen
# create & show your Qt widget
window = TestWindow()
window.show()
sys.exit(app.exec_())
```
<img src="https://i.imgur.com/y7UP7k3.jpg" alt="main" width="100%"/>
## Installation
PIP install the [latest release](https://pypi.org/project/unreal-stylesheet/) from PYPi (recommended):
```
python -m pip install unreal-stylesheet
```
or install from the repo:
```
python -m pip install git+https://github.com/leixingyu/unrealStylesheet
```
## Comparison
The following `.ui` files for testing can be found inside the `/ui` folder.
|default (editor.ui)| ue.qss|
|---|---|
|| |
|default (tree.ui)|ue.qss |
|---|---|
|| |
|default (progress.ui)| ue.qss|
|---|---|
|| |
## Contribute
Feel free to make a PR or issue if you find a bug, or want to request a feature.
Some guidelines to modify this stylesheet:
### Modifying the style sheet
1. Modify the _CSS_ preprocessor `.scss` file
2. Re-compile the `.qss`:
```commandline
qtsass ue.scss -o ue.qss
```
⚠️ If you modify the `.qss` style sheet directly, your changes will be lost when the `.qss` is re-compiled in the future
> Documentation about .scss can be found: [Sass Official website](https://sass-lang.com/guide)
> You'll also need to install a Qt specific Sass: [qt-sass](https://github.com/spyder-ide/qtsass)
### Modifying icons
The icons are handled with Qt's resource system (see the [docs](https://doc.qt.io/qt-5/resources.html)) (which is dropped in qt6)
1. Modify the `.qrc` file
2. Re-compile the `.rcc` :
```commandline
rcc -binary icons.qrc -o icons.rcc
```
## References
- Qt documentation:
- [stylesheets examples](https://doc.qt.io/qt-5/stylesheet-examples.html)
- [stylesheets reference](https://doc.qt.io/qt-5/stylesheet-reference.html)
- Github repo: [Qt-Material](https://github.com/UN-GCPDS/qt-material)
- Unreal has a different UI framework (Slate), future [read](https://minimaleffort.tech/qt-to-slate-transition-guide/) on comparing Qt to Slate
- An example of this stylesheet in action: [unrealScriptEditor](https://github.com/leixingyu/unrealScriptEditor)
Raw data
{
"_id": null,
"home_page": "",
"name": "unreal-stylesheet",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": "",
"keywords": "qt,unreal,unrealengine,engine,pyside,pyside2,pyside6,PyQt5,PyQt6,stylesheet,dark,night,theme,darkmode,ui",
"author": "Xingyu Lei, Hannes Delbeke",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/a1/f6/afd0661611d8cad2bdb837c04e7cfaa2f577bf37d738734a024253f1ba61/unreal-stylesheet-0.0.4.tar.gz",
"platform": null,
"description": "# Unreal Stylesheet [](https://pypi.org/project/unreal-stylesheet/)\n\n A Qt stylesheet designed to make your tools look native in Unreal Engine 5 \n\nQuickstart sample code:\n```python\nimport unreal_stylesheet\n\nif __name__ == '__main__':\n app = QtWidgets.QApplication(sys.argv)\n\n # style your QApp, requires a QApplication instance\n unreal_stylesheet.setup() # <== Just 1 line of code to make the magic happen\n\n # create & show your Qt widget\n window = TestWindow()\n window.show()\n sys.exit(app.exec_()) \n```\n\n<img src=\"https://i.imgur.com/y7UP7k3.jpg\" alt=\"main\" width=\"100%\"/> \n\n## Installation\nPIP install the [latest release](https://pypi.org/project/unreal-stylesheet/) from PYPi (recommended):\n```\npython -m pip install unreal-stylesheet\n```\nor install from the repo:\n```\npython -m pip install git+https://github.com/leixingyu/unrealStylesheet\n```\n\n## Comparison\n\nThe following `.ui` files for testing can be found inside the `/ui` folder. \n\n|default (editor.ui)| ue.qss|\n|---|---|\n|| |\n\n|default (tree.ui)|ue.qss |\n|---|---|\n|| |\n\n|default (progress.ui)| ue.qss|\n|---|---|\n|| |\n\n## Contribute\n\nFeel free to make a PR or issue if you find a bug, or want to request a feature. \nSome guidelines to modify this stylesheet:\n\n### Modifying the style sheet\n\n1. Modify the _CSS_ preprocessor `.scss` file\n2. Re-compile the `.qss`: \n```commandline\nqtsass ue.scss -o ue.qss\n```\n\n\u26a0\ufe0f If you modify the `.qss` style sheet directly, your changes will be lost when the `.qss` is re-compiled in the future \n\n> Documentation about .scss can be found: [Sass Official website](https://sass-lang.com/guide) \n> You'll also need to install a Qt specific Sass: [qt-sass](https://github.com/spyder-ide/qtsass) \n\n### Modifying icons\n\nThe icons are handled with Qt's resource system (see the [docs](https://doc.qt.io/qt-5/resources.html)) (which is dropped in qt6)\n\n1. Modify the `.qrc` file\n2. Re-compile the `.rcc` :\n```commandline\nrcc -binary icons.qrc -o icons.rcc\n```\n\n## References\n- Qt documentation: \n - [stylesheets examples](https://doc.qt.io/qt-5/stylesheet-examples.html)\n - [stylesheets reference](https://doc.qt.io/qt-5/stylesheet-reference.html)\n- Github repo: [Qt-Material](https://github.com/UN-GCPDS/qt-material)\n- Unreal has a different UI framework (Slate), future [read](https://minimaleffort.tech/qt-to-slate-transition-guide/) on comparing Qt to Slate\n- An example of this stylesheet in action: [unrealScriptEditor](https://github.com/leixingyu/unrealScriptEditor)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Xingyu Lei Copyright (c) 2023 Hannes D 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": "style qt like unreal 5",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/leixingyu/unrealStylesheet",
"Source": "https://github.com/leixingyu/unrealStylesheet"
},
"split_keywords": [
"qt",
"unreal",
"unrealengine",
"engine",
"pyside",
"pyside2",
"pyside6",
"pyqt5",
"pyqt6",
"stylesheet",
"dark",
"night",
"theme",
"darkmode",
"ui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58d5680f35e7f685e92de58db77e5458cbf40b0b4d36619312dfdd08f34055c6",
"md5": "b408c0595cf8a02ad7dd5977203b5c8d",
"sha256": "f7c5c9aae0e17910b05414ec453ed0b64e74e6c9b61e723270aa6a573980ad56"
},
"downloads": -1,
"filename": "unreal_stylesheet-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b408c0595cf8a02ad7dd5977203b5c8d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 18594,
"upload_time": "2023-09-27T20:43:10",
"upload_time_iso_8601": "2023-09-27T20:43:10.592566Z",
"url": "https://files.pythonhosted.org/packages/58/d5/680f35e7f685e92de58db77e5458cbf40b0b4d36619312dfdd08f34055c6/unreal_stylesheet-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a1f6afd0661611d8cad2bdb837c04e7cfaa2f577bf37d738734a024253f1ba61",
"md5": "bb8a9f41d35500d1f9911872e36d9671",
"sha256": "820ac1ecec65121e291884860a1b86e84d5e37af00bc99d9d6dde4db47c9e9af"
},
"downloads": -1,
"filename": "unreal-stylesheet-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "bb8a9f41d35500d1f9911872e36d9671",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 21259,
"upload_time": "2023-09-27T20:43:12",
"upload_time_iso_8601": "2023-09-27T20:43:12.168364Z",
"url": "https://files.pythonhosted.org/packages/a1/f6/afd0661611d8cad2bdb837c04e7cfaa2f577bf37d738734a024253f1ba61/unreal-stylesheet-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 20:43:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "leixingyu",
"github_project": "unrealStylesheet",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "unreal-stylesheet"
}
