unreal-qt-stylesheet


Nameunreal-qt-stylesheet JSON
Version 0.0.1 PyPI version JSON
download
home_page
Summarystyle qt like unreal 5
upload_time2023-06-27 20:30:50
maintainer
docs_urlNone
authorXingyu Lei, Hannes Delbeke
requires_python>=3.4
licenseMIT License Copyright (c) 2022 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 qt unreal unrealengine engine pyside pyside2 pyside6 pyqt5 pyqt6 stylesheet dark night theme darkmode
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Unreal Style Sheet
 A Qt style sheet designed to make your tools look native in Unreal Engine 5  

<img src="https://i.imgur.com/y7UP7k3.jpg" alt="main" width="100%"/>  

## Using the style sheet
simply import `unreal_qt_stylesheet` and call `setup()`:  
```python
# ensure you have a Qt application:
# app = QtWidgets.QApplication(sys.argv)

import unreal_qt_stylesheet
unreal_qt_stylesheet.setup()

# show your qt widgets
# window = YourTool()
# window.show()
```

## Comparison

The following `.ui` files for testing can be found inside the `/ui` folder.  

|default (editor.ui)| ue.qss|
|---|---|
|![](https://i.imgur.com/EX5naMy.png)| ![](https://i.imgur.com/M8CU4cN.jpg)|

|default (tree.ui)|ue.qss |
|---|---|
|![](https://i.imgur.com/Xk8XYlQ.png)|![](https://i.imgur.com/DcQQwak.jpg) |

|default (progress.ui)| ue.qss|
|---|---|
|![](https://i.imgur.com/6yMuCKD.png)| ![](https://i.imgur.com/NyskX8m.jpg)|

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

You can modify the `.qss` style sheet directly,  
or you can modify on top of the _CSS_ preprocessor `.scss` file.  
Once finished, re-compile the `.qss`:   
```commandline
qtsass ue.scss -o ue.qss
```

> 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 (to learn more, visit [here](https://doc.qt.io/qt-5/resources.html))

You can modify the `.qrc` file and re-compile the `.rcc` as follows:

```commandline
rcc -binary icons.qrc -o icons.rcc
```


## Reference

[Qt Documentation: Qt Style Sheets Examples](https://doc.qt.io/qt-5/stylesheet-examples.html)

[Qt Documentation: Qt Style Sheets Reference](https://doc.qt.io/qt-5/stylesheet-reference.html)

[Github: 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 

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "unreal-qt-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",
    "author": "Xingyu Lei, Hannes Delbeke",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/65/dd/81385994eb610399c850011fc8f5b90471d18c744f64bc33e895f18e5631/unreal-qt-stylesheet-0.0.1.tar.gz",
    "platform": null,
    "description": "# Unreal Style Sheet\n A Qt style sheet designed to make your tools look native in Unreal Engine 5  \n\n<img src=\"https://i.imgur.com/y7UP7k3.jpg\" alt=\"main\" width=\"100%\"/>  \n\n## Using the style sheet\nsimply import `unreal_qt_stylesheet` and call `setup()`:  \n```python\n# ensure you have a Qt application:\n# app = QtWidgets.QApplication(sys.argv)\n\nimport unreal_qt_stylesheet\nunreal_qt_stylesheet.setup()\n\n# show your qt widgets\n# window = YourTool()\n# window.show()\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|![](https://i.imgur.com/EX5naMy.png)| ![](https://i.imgur.com/M8CU4cN.jpg)|\n\n|default (tree.ui)|ue.qss |\n|---|---|\n|![](https://i.imgur.com/Xk8XYlQ.png)|![](https://i.imgur.com/DcQQwak.jpg) |\n\n|default (progress.ui)| ue.qss|\n|---|---|\n|![](https://i.imgur.com/6yMuCKD.png)| ![](https://i.imgur.com/NyskX8m.jpg)|\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\nYou can modify the `.qss` style sheet directly,  \nor you can modify on top of the _CSS_ preprocessor `.scss` file.  \nOnce finished, re-compile the `.qss`:   \n```commandline\nqtsass ue.scss -o ue.qss\n```\n\n> Documentation about .scss can be found: [Sass Official website](https://sass-lang.com/guide)\n>\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 (to learn more, visit [here](https://doc.qt.io/qt-5/resources.html))\n\nYou can modify the `.qrc` file and re-compile the `.rcc` as follows:\n\n```commandline\nrcc -binary icons.qrc -o icons.rcc\n```\n\n\n## Reference\n\n[Qt Documentation: Qt Style Sheets Examples](https://doc.qt.io/qt-5/stylesheet-examples.html)\n\n[Qt Documentation: Qt Style Sheets Reference](https://doc.qt.io/qt-5/stylesheet-reference.html)\n\n[Github: Qt-Material](https://github.com/UN-GCPDS/qt-material)\n\n> Unreal has a different UI framework (Slate), future [read](https://minimaleffort.tech/qt-to-slate-transition-guide/) on comparing Qt to Slate \n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2022 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": "style qt like unreal 5",
    "version": "0.0.1",
    "project_urls": {
        "Homepage": "https://github.com/hannesdelbeke/unrealStylesheet",
        "Source": "https://github.com/hannesdelbeke/unrealStylesheet"
    },
    "split_keywords": [
        "qt",
        "unreal",
        "unrealengine",
        "engine",
        "pyside",
        "pyside2",
        "pyside6",
        "pyqt5",
        "pyqt6",
        "stylesheet",
        "dark",
        "night",
        "theme",
        "darkmode"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f8401d76b6547d5cd02dc6fad21afcedfb4af337e7aac82c71d7db5c446669d",
                "md5": "422033628773ab588c35d76cc5002803",
                "sha256": "f6a670bff915cf41be56dab8a248223c2ff81714597ab81888f7cb5dce5d0f00"
            },
            "downloads": -1,
            "filename": "unreal_qt_stylesheet-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "422033628773ab588c35d76cc5002803",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.4",
            "size": 26266,
            "upload_time": "2023-06-27T20:30:48",
            "upload_time_iso_8601": "2023-06-27T20:30:48.639119Z",
            "url": "https://files.pythonhosted.org/packages/8f/84/01d76b6547d5cd02dc6fad21afcedfb4af337e7aac82c71d7db5c446669d/unreal_qt_stylesheet-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "65dd81385994eb610399c850011fc8f5b90471d18c744f64bc33e895f18e5631",
                "md5": "71fabc8e8845e53872efb54731698e12",
                "sha256": "d53c19422b44679894d7d4c0160dc8d3910425a34e114e44f0dcd8e50df70e59"
            },
            "downloads": -1,
            "filename": "unreal-qt-stylesheet-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "71fabc8e8845e53872efb54731698e12",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4",
            "size": 18434,
            "upload_time": "2023-06-27T20:30:50",
            "upload_time_iso_8601": "2023-06-27T20:30:50.232445Z",
            "url": "https://files.pythonhosted.org/packages/65/dd/81385994eb610399c850011fc8f5b90471d18c744f64bc33e895f18e5631/unreal-qt-stylesheet-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-27 20:30:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hannesdelbeke",
    "github_project": "unrealStylesheet",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "unreal-qt-stylesheet"
}
        
Elapsed time: 0.08229s