Package: hi-getter
HaloInfiniteGetterA 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.Other Documents:ChangelogLicenseTable of ContentsAboutHow to UseInstallationAuthenticationSearchingKnowing Where to SearchGETSCANCache ExplorerImporting and Exporting Cached RequestsOutputsMedia OutputText OutputThemesTheme File StructureAbout:HaloInfiniteGetter is a GUI application written usingQt for Pythonthat allows you to easily view data
hosted onHaloWaypointAPI endpoints.You can view both Image and Text output, with these results being cached in the user's.cache/hi_getter/cached_requestsdirectory,
to eliminate unnecessary API calls.How to Use:Installation:First, install Python 3.10 usingthis linkThen, open command prompt (Win + R -- type in "cmd") and typepip install hi_getterOptionally, to install the latest unstable version, typepip install git+https://github.com/Cubicpath/HaloInfiniteGetter.gitAnd you are done! To launch the program simply typehi_getterOnce launched, you can create a desktop shortcut by using theCreate Desktop Shortcuttool
under theToolscontext menuAuthentication:As this app is unofficial, you must use your own API key, which you can get by logging in toHaloWaypointand either getting
data from the authentication headers, or from the website's cookies.Guide:Sign in towww.halowaypoint.comusing your xbox accountNavigate to the Cookies forwww.halowaypoint.comOn Firefox -- F12 > Move to the "Storage" tab > Under "Cookies" selecthttps://www.halowaypoint.comDouble-click the "wpauth" cookie value and copy with CTRL + COpen 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:When you access a resource and are properly authenticated, it is cached to your~/.cache/hi_getter/cached_requestsdirectory.By default, when you access an already-cached resource, HaloInfiniteGetter checks for a new
version of said resource on HaloWaypoint servers. The old version is stored in~/.cache/hi_getter/old_filesalong with its version identifier.You can disable this behaviour by unchecking theUpdate Cached Resourcescheckbox in Settings.Knowing Where to Search:An example resource (Progression/file/Calendars/Seasons/SeasonCalendar.json) is pre-filled out in the
path input section.You may omitprogression/file/andimages/file/from searches, so long as the file extension of the resource
indicates data or media (ex: json defaults asprogression/file/, png and jpg defaults asimages/file/).GET:Gets the singular resource from the given path and outputs it.SCAN:Warning: This may display various flashing images in quick succession.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.If you want to scan your own json file(s) for resource paths, you can use theScan Files...tool in theToolscontext menu.Cache Explorer:You can view all cached files using the Cache Explorer, which is on the left-hand side of the main window.It has 1 setting:Icon Mode--- Changes how the file/folder icons are renderedNo Icons--- Removes all icons in the viewDefault (Default)--- Renders icons normally (like explorer)Preview Images--- Use image previews as icons for images.
This can use upwards of ~2GB of memory if you have a lot of image filesContext Menu actions:Open in View--- Open the cached file's contents in one of the output viewsOpen in Default App--- Open the cached file in its extension's default appFoldingExpand--- Expand the selected directoryExpand Recursively--- Expand this directory and any subdirectoriesExpand All--- Expand all directoriesCollapse--- Collapse the selected directoryCollapse All--- Collapse all directoriesCopy Full Path--- Copy the cached file's pathCopy Endpoint Path--- Copy the path, translated into it's associated endpointCopy File Contents--- Copy the contents of the file onto your clipboard.Importing and Exporting Cached RequestsYou can use theFilecontext menu to easily import and export archive files containing cached requests.
Once imported, you can view the data in theCache Explorer.Supported archive types are:7Zip Archives (*.7z)ZIP Files (*.zip&*.piz)TAR Files (*.tar,*.tar.gz,*.tgz,*.tar.bz2,*.tbz2,*.tar.xz,*.txz)gzip,bzip2, andxzare the supported compression algorithmsOutputs: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 windowIgnore--- Transform the aspect ratio to meet the output's dimensionsKeep (Default)--- Keep the aspect ratio without expanding past the output's dimensionsExpanding--- Expand the image's size to keep its aspect ratioImage Transform Mode--- Changes how the image is rendered to a different sizeFast (Default)--- Faster, looks more jaggedSmooth--- Smooths edges, looks better in some casesText 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 outputNo Wrap--- No line wrapping, use the horizontal scroll wheel insteadWidgets (Default)--- Line wrap if a word does not fit the text output's dimensionsFixed Pixel--- Line wrap after every space/seperatorFixed 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 DarkBreeze LightLegacy (Default Qt)While the current breeze themes are slightly modified versions, you can view the original themes atBreezeStyleSheets.