Difference between revisions of "Poltergust"

From MK8
Jump to navigation Jump to search
(Initial version)
 
m (Hrmrmrmm)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{Software-Info
+
{| class="textbox float-right grid width:30%"
−
|name=Poltergust
+
|+ {{PAGENAME}}
−
|creator=[[Scutlet]]
+
! Author:
−
|console=Wii U <!-- Not supported by the template; might be nice to add -->
+
| [[Scutlet]]
−
|fileformat1=Ghost Data
+
|-
−
|fileformat2=
+
! Operating systems:
−
|version=v1.0.0
+
| Any
−
|date of release=2022-06-27
+
|-
−
|download=https://github.com/Scutlet/mk8-poltergust/releases
+
! Programming language:
−
}}
+
| Python 3
−
[[File:Poltergust-tool-preview.png|270px|thumb|right|Visualization of the staff ghost for [[Wii U Sunshine Airport|Sunshine Airport]].]]
+
|-
 +
! Software type:
 +
| Viewer
 +
|-
 +
! Console:
 +
| [[Wii U]]
 +
|-
 +
! File Formats:
 +
| [[Ghost Data (File Format)|DAT (Ghost Data)]]
 +
|-
 +
! Version:
 +
| v2.0
 +
|-
 +
! Date of latest version:
 +
| 2022-07-21
 +
|-
 +
! Download:
 +
| [https://github.com/Scutlet/mk8-poltergust/releases GitHub]
 +
|}
  
−
'''Poltergust''' is a Python 3 application for visualizing and extracting 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 [[Mario Kart 8]] for [[Wii U]].
+
== Overview ==
 +
'''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 ==
 +
<gallery>
 +
Poltergust v2.0 UI Custom Track Preview.png|A preview of a custom staff ghost linked to [[Wii Dry Dry Ruins (Scutlet)|<small>Wii</small> Dry Dry Ruins]]
 +
Poltergust v2.0 UI Preview.png|A preview of the UI viewing the staff ghost of [[Wii U Sunshine Airport|Sunshine Airport]]
 +
Poltergust v2.0 UI Track Changer Preview.png|A preview of changing the track slot and custom track of a ghost
 +
Poltergust v2.0 UI Search Preview.png|A preview of selecting and searching a track slot
 +
Poltergust v2.0 UI Custom Track Selector Preview.png|A preview of selecting a custom track to link to a ghost
 +
Poltergust v2.0 UI Downloader Preview.png|A preview of 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, or lap splits.
+
* Extracting [[Mii]] Data.
−
* Extracting Mii Data.
+
* Converting player/downloaded ghosts to staff ghosts, or player/staff ghosts to downloaded ghosts.
−
* Converting player/downloaded ghosts to staff ghosts.
+
* Change the ghost slot of a downloaded ghost, or the track slot of any ghost.
−
* Converting player/staff ghosts to downloaded ghosts.
+
* Link a ghost to a specific custom track.
 +
** This program 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 the program's Custom Track Manager, and doing so is required when a mod author wishes to link their (staff) ghost to their custom track.
 +
** When a ghost file linked to a specific custom track is loaded, information is automatically fetched from either the [[Main Page|Custom Mario Kart 8 Wiki]] or [https://gamebanana.com GameBanana] in order to display the track's name, author, and image. Custom tracks must be linked to ghosts manually and can be added by inserting their URL in the Custom Track Manager.
  
 
== Installation ==
 
== Installation ==
−
First, grab the latest source code. To run, any recent version of Python 3 (Python 3.10 definitely suffices) is needed. Open up a terminal of choice, navigate to the place where the source code was extracted, and install the dependencies using "pip install -r requirements.txt" (possibly inside a Virtual Environment if preferred). The tool can then be run through Python using "python poltergust.py".
+
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>).
 +
# 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 the source code was extracted.
 +
# 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}}.
 +
Steps 3, 5 and 7 need to be repeated if the user wishes to reopen the program via source code.
  
−
An executable that packages everything together will be provided in a later version.
+
== Version History ==
 +
{|class="wikitable"
 +
! 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 code resctructure.
 +
* Ghost files can now be "dragged into" the .exe file to open them immediately.
 +
* Track slots of ghosts can be changed under "Edit -> Change Track".
 +
* Ghosts can now be linked to specific custom tracks from the [[Main Page|Custom Mario Kart 8 Wiki]] or [https://gamebanana.com GameBanana].
 +
* Various minor bug fixes.
 +
|}
  
 +
{{User-Scutlet-Link}}
 
[[Category:Software]]
 
[[Category:Software]]

Latest revision as of 06:30, 23 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

  • A preview of a custom staff ghost linked to Wii Dry Dry Ruins

  • A preview of the UI viewing the staff ghost of Sunshine Airport

  • A preview of changing the track slot and custom track of a ghost

  • A preview of selecting and searching a track slot

  • A preview of selecting a custom track to link to a ghost

  • A preview of downloading custom track information

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.
    • This program 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 the program's Custom Track Manager, and doing so is required when a mod author wishes to link their (staff) ghost to their custom track.
    • When a ghost file linked to a specific custom track is loaded, information is automatically fetched from either the Custom Mario Kart 8 Wiki or GameBanana in order to display the track's name, author, and image. Custom tracks must be linked to ghosts manually and can be added by inserting their URL in the Custom Track Manager.

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 code resctructure.
  • Ghost files can now be "dragged into" the .exe file to open them immediately.
  • Track slots of ghosts can be changed under "Edit -> Change Track".
  • Ghosts can now be linked to specific custom tracks from the Custom Mario Kart 8 Wiki or GameBanana.
  • Various minor bug fixes.
By the same author: Scutlet

Retro Tracks:
Wii Dry Dry Ruins – SMG2 Tall Trunk's Big Slide

Software:
Poltergust – Character Roster Swapper

Retrieved from "https://mk8.tockdom.com/w/index.php?title=Poltergust&oldid=9107"