Skip to content

Changes

Page history
Update pyenv-win with App Execution Alias notes authored by Travis Law's avatar Travis Law
Show whitespace changes
Inline Side-by-side
Developer-Guide.md
View page @ 49a0e1d4
...@@ -22,7 +22,7 @@ StarFab is developed in Python using [Qt for Python](https://wiki.qt.io/Qt_for_P ...@@ -22,7 +22,7 @@ StarFab is developed in Python using [Qt for Python](https://wiki.qt.io/Qt_for_P
## Core Guidelines ## Core Guidelines
* Python [3.10.2](https://www.python.org/downloads/release/python-3102/) * Python [3\.10.2](https://www.python.org/downloads/release/python-3102/)
* [Black](https://black.readthedocs.io/en/stable/) for code style/formatting * [Black](https://black.readthedocs.io/en/stable/) for code style/formatting
* Dependencies managed by [Poetry](https://python-poetry.org/) * Dependencies managed by [Poetry](https://python-poetry.org/)
* Release packages built with [briefcase](https://beeware.org/project/projects/tools/briefcase/) * Release packages built with [briefcase](https://beeware.org/project/projects/tools/briefcase/)
...@@ -40,13 +40,13 @@ Often these optional dependencies are included in the platform specific release ...@@ -40,13 +40,13 @@ Often these optional dependencies are included in the platform specific release
##### View and Convert textures (dds) ##### View and Convert textures (dds)
To view or convert textures (.dds*) files, StarFab relies on [texconv](https://github.com/microsoft/DirectXTex/releases) or [compressonator](https://gpuopen.com/compressonator/). Ensure that `texconv` or `compressonatorcli` is installed and in your system `PATH`. To view or convert textures (.dds\*) files, StarFab relies on [texconv](https://github.com/microsoft/DirectXTex/releases) or [compressonator](https://gpuopen.com/compressonator/). Ensure that `texconv` or `compressonatorcli` is installed and in your system `PATH`.
##### Convert Audio Files (wem) ##### Convert Audio Files (wem)
To convert wem files, you must have [ww2ogg](https://github.com/hcs64/ww2ogg) and [revorb](https://cloudflare-ipfs.com/ipfs/QmVgjfU7qgPEtANatrfh7VQJby9t1ojrTbN7X8Ei4djF4e/revorb.exe) in your path. **Both are included in the MSI installer for Windows.** To convert wem files, you must have [ww2ogg](https://github.com/hcs64/ww2ogg) and [revorb](https://cloudflare-ipfs.com/ipfs/QmVgjfU7qgPEtANatrfh7VQJby9t1ojrTbN7X8Ei4djF4e/revorb.exe) in your path. **Both are included in the MSI installer for Windows.**
> **Note for Windows: you must have the Vorbis codecs installed to listen to audio in StarFab. You can download them on [Xiph.org](https://xiph.org/dshow/downloads/)** > **Note for Windows: you must have the Vorbis codecs installed to listen to audio in StarFab. You can download them on **[**Xiph.org**](https://xiph.org/dshow/downloads/)
##### Convert CryEngine Models (cga/cgf/chr/skin) ##### Convert CryEngine Models (cga/cgf/chr/skin)
...@@ -64,11 +64,11 @@ While there are many ways to configure your development environment, the followi ...@@ -64,11 +64,11 @@ While there are many ways to configure your development environment, the followi
##### Git Bash ##### Git Bash
Install from [https://git-scm.com/downloads](https://git-scm.com/downloads). Install from https://git-scm.com/downloads.
##### pyenv-win ##### pyenv-win
pyenv-win provides an easy way to manage multiple Python versions on Windows. The easiest/preferred method is to install using [chocolatey](https://chocolatey.org/install). Follow the instructions here: [https://pyenv-win.github.io/pyenv-win/#installation](https://pyenv-win.github.io/pyenv-win/#installation) pyenv-win provides an easy way to manage multiple Python versions on Windows. The easiest/preferred method is to install using [chocolatey](https://chocolatey.org/install). Follow the instructions here: https://pyenv-win.github.io/pyenv-win/#installation
* Install Python 3.10.2 with `pyenv-win` * Install Python 3.10.2 with `pyenv-win`
...@@ -76,19 +76,23 @@ pyenv-win provides an easy way to manage multiple Python versions on Windows. Th ...@@ -76,19 +76,23 @@ pyenv-win provides an easy way to manage multiple Python versions on Windows. Th
pyenv install 3.10.2 pyenv install 3.10.2
``` ```
* Disabling App Execution Aliases in Windows 10 1905+
If you are running Windows 10 1905 or newer, you might need to disable the built-in Python launcher via Start > “Manage App Execution Aliases” and turning off the “App Installer” aliases for Python, otherwise Poetry and windows will attempt to redirect all python invocations to either a Windows Store or actual Python install.
##### poetry ##### poetry
[Install poetry](https://python-poetry.org/docs/#windows-powershell-install-instructions): [Install poetry](https://python-poetry.org/docs/#windows-powershell-install-instructions):
```shell ```shell
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py - (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -
``` ```
#### Linux/OSX #### Linux/OSX
##### pyenv ##### pyenv
pyenv provides an easy way to manage multiple Python versions on Linux/OSX. Set it up by following the instructions here [https://github.com/pyenv/pyenv-installer](https://github.com/pyenv/pyenv-installer) pyenv provides an easy way to manage multiple Python versions on Linux/OSX. Set it up by following the instructions here https://github.com/pyenv/pyenv-installer
* Install Python 3.10.2 with `pyenv` * Install Python 3.10.2 with `pyenv`
...@@ -96,7 +100,7 @@ pyenv provides an easy way to manage multiple Python versions on Linux/OSX. Set ...@@ -96,7 +100,7 @@ pyenv provides an easy way to manage multiple Python versions on Linux/OSX. Set
pyenv install 3.10.2 pyenv install 3.10.2
``` ```
> Every distro is different. If pyenv fails to build python, check [https://github.com/pyenv/pyenv/wiki#suggested-build-environment](https://github.com/pyenv/pyenv/wiki#suggested-build-environment) > Every distro is different. If pyenv fails to build python, check https://github.com/pyenv/pyenv/wiki#suggested-build-environment
##### poetry ##### poetry
...@@ -161,6 +165,7 @@ This will trigger the StarFab Blender add-on to connect to the PyCharm debug ser ...@@ -161,6 +165,7 @@ This will trigger the StarFab Blender add-on to connect to the PyCharm debug ser
### Debug Environment Variables ### Debug Environment Variables
There are a number of environment variables that can be set to adjust how StarFab runs for debugging purporses. There are a number of environment variables that can be set to adjust how StarFab runs for debugging purporses.
| Environment Variable | Example Setting | Description | | Environment Variable | Example Setting | Description |
|----------------------|-----------------|-------------| |----------------------|-----------------|-------------|
| STARFAB_LOGLEVEL | DEBUG | Overrides the log output level | | STARFAB_LOGLEVEL | DEBUG | Overrides the log output level |
...@@ -169,3 +174,4 @@ There are a number of environment variables that can be set to adjust how StarFa ...@@ -169,3 +174,4 @@ There are a number of environment variables that can be set to adjust how StarFa
| STARFAB_P4K_LIMIT | 1000 | Stop loading the Data.p4k after N number of records have been read | | STARFAB_P4K_LIMIT | 1000 | Stop loading the Data.p4k after N number of records have been read |
| STARFAB_QUICK | 1 | If set, this will disable some calculations that take a long time to initially process (like folder sizes in the p4k) | | STARFAB_QUICK | 1 | If set, this will disable some calculations that take a long time to initially process (like folder sizes in the p4k) |
| STARFAB_SC_PATH | e:/sc/archive/PTU/Data.p4k | Override which SC directory will automatically be loaded on startup | | STARFAB_SC_PATH | e:/sc/archive/PTU/Data.p4k | Override which SC directory will automatically be loaded on startup |