A simple way to get live Halo data straight from Halo Waypoint.
Project description
HaloInfiniteGetter
A simple way to get live Halo data straight from Halo Waypoint.
Note: This project is in a public alpha, and as such, many features are not complete.
Disclaimer:
HaloInfiniteGetter is in no way associated with, endorsed by, or otherwise affiliated with the Microsoft Corporation, Xbox Game Studios, or 343 Industries. Depending on how you use it, use of this app may or may not be considered abuse by the aforementioned parties.
About:
HaloInfiniteGetter is a GUI application written using Qt for Python that allows you to easily view data hosted on HaloWaypoint API endpoints.
You can view both Image and Text output, with these results being cached in the user's .cache/hi_data
directory,
to eliminate unnecessary API calls.
How to use:
Installation:
- First, install Python 3.10 using this link
- Then, open command prompt (Win + R -- type in "cmd") and type
pip install hi_getter
- Optionally, to install the latest unstable version, type
pip install git+https://github.com/Cubicpath/HaloInfiniteGetter.git
- Optionally, to install the latest unstable version, type
- And you are done! To launch the program simply type
py -m hi_getter
Authentication:
As this app is unofficial, you must use your own API key, which you can get by logging in to HaloWaypoint and either getting data from the authentication headers, or from the website's cookies.
Note: Auto-renewal of authentication keys is only supported in versions 0.7+.
Guide:
- Sign in to www.halowaypoint.com using your xbox account
- Navigate to the Cookies for www.halowaypoint.com
- On Firefox -- F12 > Move to the "Storage" tab > Under "Cookies" select https://www.halowaypoint.com
- Double-click the "wpauth" cookie value and copy with CTRL + C
- Open the Settings window, unlock the input by pressing the "Edit Auth Key" button, then paste the copied value.
- Press the Set button, and you should now be authenticated!
Searching:
Knowing where to search:
An example resource (Progression/file/Calendars/Seasons/SeasonCalendar.json
) is pre-filled out in the
path input section.
You may omit progression/file/
and images/file/
from searches, so long as the file extension of the resource
indicates data or media (ex: json defaults as progression/file/
, png and jpg defaults as images/file/
).
GET:
Gets the singular resource from the given path and outputs it.
SCAN:
Recursively scan a given JSON resource for paths to more resources, ignoring already scanned resources. This results in caching ALL resources that are referenced by any other resource with some tie to the original resource path.
Outputs the original resource's data.
Outputs:
Both the media and the text output can be detached and reattached from the main window. This allows greater flexibility, like viewing only the image in fullscreen.
Media Output:
The media output shows the currently loaded image to the user, scaled to fit the current window.
It has two settings:
- Aspect Ratio Mode --- Changes how the aspect-ratio is transformed to fit the window
- Ignore --- Transform the aspect ratio to meet the output's dimensions
- Keep (Default) --- Keep the aspect ratio without expanding past the output's dimensions
- Expanding --- Expand the image's size to keep its aspect ratio
- Image Transform Mode --- Changes how the image is rendered to a different size
- Fast (Default) --- Faster, looks more jagged
- Smooth --- Smooths edges, looks better in some cases
Text Output:
The text output displays any text data loaded by the given path, or an error response from the server.
Path are automatically detected and hyperlinked for ease of use, which allows you to easily browse multiple paths in succession.
It has one setting:
- Line Wrap Mode --- Changes how lines are wrapped inside the text output
- No Wrap --- No line wrapping, use the horizontal scroll wheel instead
- Widgets (Default) --- Line wrap if a word does not fit the text output's dimensions
- Fixed Pixel --- Line wrap after every space/seperator
- Fixed Column --- Line wrap after every character (excluding spaces)
Themes:
Themes are a way to style already-existing elements (Think CSS). They are held in a directory with their resources and stylesheet in the same folder level.
Theme file structure:
../
│
├───[theme_id]/
│ ├─── [icon1_name].svg
│ ├─── [icon2_name].svg
│ ├─── [icon3_name].svg
│ └─── stylesheet.qss
│
The current builtin themes are:
- Breeze Dark
- Breeze Light
- Legacy (Default PySide)
While the current breeze themes are slightly modified versions, you can view the original themes at BreezeStyleSheets.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.