Difference between revisions of "Poltergust"

From MK8
Jump to navigation Jump to search
(Cleanup)
m (v2.0.0 update)
Line 20: Line 20:
 
|-
 
|-
 
! Version:
 
! Version:
| v1.1
+
| v2.0
 
|-
 
|-
 
! Date of latest version:
 
! Date of latest version:
| 2022-06-30
+
| 2022-07-21
 
|-
 
|-
 
! Download:
 
! Download:
Line 33: Line 33:
  
 
== Media ==
 
== Media ==
[[File:Poltergust v1.0 UI Preview.png|400px|thumb|none|A preview of the UI viewing the staff ghost of [[Wii U Sunshine Airport|Sunshine Airport]]]]
+
<gallery>
 +
File:Poltergust v2.0 UI Preview CT.png|thumb|Preview of a custom staff ghost linked to [[Wii Dry Dry Ruins (Scutlet)|<small>Wii</small> Dry Dry Ruins]].
 +
File:Poltergust v1.0 UI Preview.png|400px|thumb|none|A preview of the UI viewing the staff ghost of [[Wii U Sunshine Airport|Sunshine Airport]]
 +
File:Poltergust v2.0 UI Preview Track Changer.png|thumb|UI Preview of changing the track slot and custom track of a ghost.
 +
File:Poltergust v2.0 UI Preview Search.png|thumb|UI Preview of selecting and searching a track slot.
 +
File:Poltergust v2.0 UI Preview CT Selector.png|thumb|UI Preview for selecting a custom track to link to a ghost.
 +
File:Poltergust v2.0 UI Preview Downloader.png|thumb|UI Preview for downloading custom track information.
 +
</gallery>
  
 
== Features ==
 
== Features ==
 
* Previewing information such as player name, vehicle combination, and lap splits.
 
* Previewing information such as player name, vehicle combination, and lap splits.
 
* Extracting [[Mii]] Data.
 
* Extracting [[Mii]] Data.
* Converting player/downloaded ghosts to staff ghosts.
+
* Converting player/downloaded ghosts to staff ghosts, or player/staff ghosts to downloaded ghosts.
* Converting player ghosts to downloaded ghosts.
+
* Change the ghost slot of a downloaded ghost, or the track slot of any ghost.
 +
* Link a ghost to a specific custom track*
 +
 
 +
*Poltergust stores custom track information locally. When ghost files  linked to a custom track are loaded, the custom track information is automatically added to this local storage. Custom tracks can also be added manually through Poltergust's Custom Track Manager, and doing so is required when a mod author wishes to link their (staff) ghost to their custom track.
  
 
== Installation ==
 
== Installation ==
Windows users can use the executable in the provided download. Other systems (but also Windows) can run the source code:
+
Windows users can use the executable in the provided [https://github.com/Scutlet/mk8-poltergust/releases download]. Other systems (but also Windows) can run the source code:
 
# Download the latest source code (either the <i>zip</i> or <i>tar.gz</i>).
 
# 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].
 
# Install the latest version of [https://www.python.org/downloads Python 3.10].
Line 67: Line 77:
 
* Added an auto-build script that creates a Windows executable.
 
* Added an auto-build script that creates a Windows executable.
 
* Various bug fixes related to downloaded ghosts.
 
* Various bug fixes related to downloaded ghosts.
 +
|-
 +
| v2.0
 +
| 2022-07-21
 +
|
 +
* Major refactor of the internal code
 +
* Ghost files can be "dragged into" the Poltergust exe to open them immediately.
 +
* Track slots of ghost can be changed under Edit -> Change Track.
 +
* Ghosts can be linked to specific custom tracks on the CT Wiki or GameBanana. When a ghost file linked to a specific custom track is loaded, Poltergust automatically fetches info from these websites in order to display the track's name, author, and image. Custom tracks must be linked to ghosts manually. Custom tracks can be added to Poltergust by inserting their URL in Poltergust's Custom Track Manager.
 +
* Various minor bugfixes.
 +
 
|}
 
|}
  
 
{{User-Scutlet-Link}}
 
{{User-Scutlet-Link}}
 
[[Category:Software]]
 
[[Category:Software]]

Revision as of 15:55, 21 July 2022

Poltergust
Author: Scutlet
Operating systems: Any
Programming language: Python 3
Software type: Viewer
Console: Wii U
File Formats: DAT (Ghost Data)
Version: v2.0
Date of latest version: 2022-07-21
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

Features

  • Previewing information such as player name, vehicle combination, and lap splits.
  • Extracting Mii Data.
  • Converting player/downloaded ghosts to staff ghosts, or player/staff ghosts to downloaded ghosts.
  • Change the ghost slot of a downloaded ghost, or the track slot of any ghost.
  • Link a ghost to a specific custom track*
  • Poltergust stores custom track information locally. When ghost files linked to a custom track are loaded, the custom track information is automatically added to this local storage. Custom tracks can also be added manually through Poltergust's Custom Track Manager, and doing so is required when a mod author wishes to link their (staff) ghost to their custom track.

Installation

Windows users can use the executable in the provided download. Other systems (but also Windows) can run the source code:

  1. Download the latest source code (either the zip or tar.gz).
  2. Install the latest version of Python 3.10.
  3. Open up a terminal of choice, and navigate to the place where the source code was extracted.
  4. Create a new virtual environment using python -m venv venv.
  5. 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).
  6. Install the tool's dependencies using pip install -r requirements.txt.
  7. Run the tool using python poltergust.py.

Steps 3, 5 and 7 need to be repeated if the user wishes to reopen the program via source code.

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 bug fixes related to downloaded ghosts.
v2.0 2022-07-21
  • Major refactor of the internal code
  • Ghost files can be "dragged into" the Poltergust exe to open them immediately.
  • Track slots of ghost can be changed under Edit -> Change Track.
  • Ghosts can be linked to specific custom tracks on the CT Wiki or GameBanana. When a ghost file linked to a specific custom track is loaded, Poltergust automatically fetches info from these websites in order to display the track's name, author, and image. Custom tracks must be linked to ghosts manually. Custom tracks can be added to Poltergust by inserting their URL in Poltergust's Custom Track Manager.
  • Various minor bugfixes.
By the same author: Scutlet