Package: wingman
WingmanJump to source|Project thread|ScreenshotsWingmanis a powerful desktop companion application specifically crafted forDiscovery Freelancer. Intended to be a modern addition to the venerableFLStatandFreelancer Companion, it seeks to bring a wealth of new features to the community.Wingman features:Navmap: a beautiful navigation aid integrating and extending @Error'sOnline NavmapMerchant: a powerful trading assistantRoster: a record of your in-game characters and their attributesDatabase: an information-dense overview of the game's worldAugmentation of the game client, including clipboard access, named screenshots and new commandsDisplay of infocards with full rich text formatting, plus TGA iconsFull cross-platform support, with downloads for Windows and LinuxUnder the hood, Wingman combines my two libraries for Freelancer -flint(to read the game's static data) andflair(to hook the client) - with a rich graphical interface implemented in PyQt.Wingman is free software, released under the GNU General Public License, version 3.0.SuggestionsSeeIssuesfor a list of new features that are currently planned. To be maximally useful Wingman should be community-led, so please feel free to make your own either in the project thread or here on GitHub.InstallationInstalling on WindowsThe minimum supported Windows version is Windows 7.Download and run the installer. After installation Wingman can be launched from the Start Menu.Alternatively, if you have Python 3.7 or higher installed, you can use the installation instructions for Linux (ignoring those about native styling, since this is not an issue on Windows). However, this will not create a Start Menu entry or desktop icon and you will need to start the process as administrator manually, or create a custom shortcut.Installing on LinuxAssuming you have Python 3.7 or higher installed and available aspython3, simply runpython3 -m pip install wingman.After installation the application should be available either from your desktop's application menu or, if you ran pip with sudo, by runningwingmanin a terminal.To upgrade, runpython3 -m pip install -U wingman. To uninstall, runpython3 -m pip uninstall wingman.Note that the latest version available on PyPI may not match the latest version number for Windows because minor bugfix releases that only affect Windows are not published on PyPI.The application will probably be installable on macOS using the above commands but I'm unable to test this platform myself. If someone was able to try it out that would be great.Native stylingBecause the PyQt wheels do not include platform-specific style plugins, Wingman will run with the default Fusion theme when using pip-installed PyQt5. This works OK, but if you prefer native theming (e.g. Breeze on a KDE system) you need to install the PyQt5 packages from your distro's package manager rather than pip. Unless you want to build PyQt from source,this is only possible if your distro provides a PyQt5 package for Python 3.7 or higher. This rules out Ubuntu LTS, as at the time of writing packages are built only for Python 3.6.Uninstall thePyQt5andPyQtWebEnginepackages with pipInstallpython-pyqt5andpython-pyqtwebengine(e.g. if you use pacman) orpython3-pyqt5andpython3-pyqt5.qtwebengine(if you use apt) with your package managerBuilding and packagingCIAworkflowexists that produces automated builds for Linux and Windows.LocalPrerequisites (for all platforms)Ensure the development dependencies inrequirements.txtare installed. To build on Windows you will additionally need to install the requirements of the application itself listed insetup.py.For WindowsFrom the root directory,cd packaging/windows.Runbuild.batto build a one folder application and an installer. The application is built against Python 3.8, thelast versionto support Windows 7.For LinuxFrom the root directory,cd packaging/linuxand runbuild.shto build a source distribution.To install your locally-built distribution, runpip install dist/wingman-*.tar.gz.