README.md

Welcome Screen

An awesome welcome screen for your Digital Content Creation Software
View Demo • Report Bug • Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

This project is inspired from www.nukepedia.com/python/ui/welcomescreen
Welcome screen work with other DCC software such as Maya, and Houdini that use QT as base
Shows list of recently opened files and also build-in File Browser build using QT

Tested to be Working on:

• Nuke 7-11
• Maya 2017-2018

Build With

• PySide2 or PySide
• Python

Getting Started

Prerequisites

• Git
• Python
• PySide2 or PySide

Installation

• Clone Repository
• Install tutorial for each DCC is located on app/{software}/install.txt

Usage

After following the install tutorial, you can run Welcome Screen by Pressing Ctrl + Shift + W For your studio need you might want to change some parameter in config.py

• Project Name is derived from environment variable using os.environ.get("PROJECTNAME", "Welcome")
• Settings and RecentFiles filepath is also located in config.py

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Released under the GNU General Public License (GPL, or “free software”).

Contact

Timo.ink - mail@timo.ink

Project Link: https://github.com/timothyhalim/welcome-screen