Difference between revisions of "Poltergust"
Jump to navigation
Jump to search
(1. Forgot to change Operating systems. 2. Version numbers are always displayed like v1.0 (v1 and v1.0.0 are not accepted). 3. Misread the converting aspect of the program by accident. 4. A future update can be listed in the Version History just fine.) |
(v.1.1 update) |
||
| Line 20: | Line 20: | ||
|- | |- | ||
! Version: | ! Version: | ||
| − | | v1. | + | | v1.1 |
|- | |- | ||
! Date of latest version: | ! Date of latest version: | ||
| − | | 2022-06- | + | | 2022-06-30 |
|- | |- | ||
! Download: | ! Download: | ||
| Line 30: | Line 30: | ||
== Overview == | == Overview == | ||
| − | '''Poltergust''' is a Python 3 application for visualizing and | + | '''Poltergust''' is a Python 3 application for visualizing, extracting, and converting data from [[Ghost Data (File Format)|ghost data files]]. This includes player ghosts, staff ghosts, and downloaded ghosts, but not [[MKTV Replay (File Format)|MKTV Replays]]. Currently, there is only active support for [[Wii U]] ghost files. |
== Media == | == Media == | ||
| Line 42: | Line 42: | ||
== Installation == | == Installation == | ||
| − | # | + | Navigate to the [https://github.com/Scutlet/mk8-poltergust/releases GitHub releases] and search for the latest one. If you're running Windows, you can grab the executable that's included there. These are automatically and directly built from the source code. Note that you'll likely get a Windows Defender popup when attempting to run the tool for the first time this way. |
| − | # Open up a terminal of choice | + | |
| − | # | + | If you're running MacOS or Linux, or if you don't want to run random executables from the internet, you will have to run the tool directly from source (see below). |
| − | # | + | |
| + | === Running from Source === | ||
| + | # Navigate to the [https://github.com/Scutlet/mk8-poltergust/releases GitHub releases], and download the latest source code (either the <i>zip</i> or <i>tar.gz</i>). | ||
| + | # Install the latest version of [https://www.python.org/downloads/ Python 3.10]. | ||
| + | # Open up a terminal of choice, and navigate to the place where you extracted the source code. | ||
| + | # Create a new virtual environment using {{code|python -m venv venv}}. | ||
| + | # Activate the newly created virtual environment using {{code|venv\Scripts\activate.bat}} (Windows CMD), {{code|venv\Scripts\Activate.ps1}} (Windows Powershell), or {{code|source venv/bin/activate}} (MacOS or Linux). | ||
| + | # Install the tool's dependencies using {{code|pip install -r requirements.txt}}. | ||
| + | # Run the tool using {{code|python poltergust.py}}. | ||
| + | |||
| + | If you ever want to re-run the tool after closing your terminal, you'll need to repeat steps 3, 5 and 7. You can skip the other steps. | ||
== Version History == | == Version History == | ||
| Line 58: | Line 68: | ||
|- | |- | ||
| v1.1 | | v1.1 | ||
| − | | 2022- | + | | 2022-06-30 |
| − | | | + | | Added an auto-build script that creates a Windows executable. |
| + | Various bugfixes related to downloaded ghosts. | ||
|} | |} | ||
{{User-Scutlet-Link}} | {{User-Scutlet-Link}} | ||
[[Category:Software]] | [[Category:Software]] | ||
Revision as of 18:32, 30 June 2022
| Author: | Scutlet |
|---|---|
| Operating systems: | Any |
| Programming language: | Python 3 |
| Software type: | Viewer |
| Console: | Wii U |
| File Formats: | DAT (Ghost Data) |
| Version: | v1.1 |
| Date of latest version: | 2022-06-30 |
| Download: | GitHub |
Overview
Poltergust is a Python 3 application for visualizing, extracting, and converting data from ghost data files. This includes player ghosts, staff ghosts, and downloaded ghosts, but not MKTV Replays. Currently, there is only active support for Wii U ghost files.
Media
File:Poltergust v1.0 UI Preview.png
A preview of the UI viewing the staff ghost of Sunshine Airport
Features
- Previewing information such as player name, vehicle combination, and lap splits.
- Extracting Mii Data.
- Converting player/downloaded ghosts to staff ghosts.
- Converting player ghosts to downloaded ghosts.
Installation
Navigate to the GitHub releases and search for the latest one. If you're running Windows, you can grab the executable that's included there. These are automatically and directly built from the source code. Note that you'll likely get a Windows Defender popup when attempting to run the tool for the first time this way.
If you're running MacOS or Linux, or if you don't want to run random executables from the internet, you will have to run the tool directly from source (see below).
Running from Source
- Navigate to the GitHub releases, and download the latest source code (either the zip or tar.gz).
- Install the latest version of Python 3.10.
- Open up a terminal of choice, and navigate to the place where you extracted the source code.
- Create a new virtual environment using python -m venv venv.
- Activate the newly created virtual environment using venv\Scripts\activate.bat (Windows CMD), venv\Scripts\Activate.ps1 (Windows Powershell), or source venv/bin/activate (MacOS or Linux).
- Install the tool's dependencies using pip install -r requirements.txt.
- Run the tool using python poltergust.py.
If you ever want to re-run the tool after closing your terminal, you'll need to repeat steps 3, 5 and 7. You can skip the other steps.
Version History
| Version | Date of release | Information |
|---|---|---|
| v1.0 | 2022-06-27 | First release |
| v1.1 | 2022-06-30 | Added an auto-build script that creates a Windows executable.
Various bugfixes related to downloaded ghosts. |
By the same author: Scutlet
Retro Tracks:
Wii Dry Dry Ruins –
SMG2 Tall Trunk's Big Slide
Software:
Poltergust –
Character Roster Swapper