ahli / galaxy-observer-ui

Toolset to create Observer Interfaces for StarCraft II / Heroes of the Storm. https://ahli.github.io/Galaxy-Observer-UI/#/

Galaxy-Observer-UI

This is a toolset to create Observer Interface files for StarCraft II and Heroes of the Storm.

Check out the UIs here: https://ahli.github.io/Galaxy-Observer-UI/#/

User Guide:

User Installation:

Required Software (for Windows):

• Java 21 or higher
• A text editor preferably with XML syntax support, e.g. Notepad++ with the NppExec plugin

Using the Builder:

To compile all archives, just start 'compile-spring-boot.jar' within the 'dev' folder via the .bat file. To compile a selected archive and start a replay, consult the 'ReadMe.txt' in the same folder.

Installation Steps:

1. Install the Java SDK.
2. Download and place this development environment somewhere.
3. Start the Builder via the .bat file located in the dev directory. Add your projects or create new ones in the home screen.
4. Open the Settings screen and set your game paths.
5. In the Browse screen's Manage tab, extract the base UI of your games.

Tools-Developer Installation:

Required Software (for Windows):

• Java 21 or higher
• Java IDE, for example IntelliJ or Eclipse for Java Developers
• A text editor preferably with XML syntax support, e.g. Notepad++ with optionally the NppExec plugin or alternatively VSCode with Talv's SC2Layout plugin
• Git or some of its GUI software like Sourcetree.
• NSIS to create installers for Settings Editor

Tools-Developer Installation Steps:

1. Install Java.
2. Install Git and clone this repository.
3. Install Notepad++ and its NppExec plugin. To install the plugin via Notepad's Plugin Admin dialog. Then configure the plugin with the parameters suggested in dev/ReadMe.txt. Alternatively, use VSCode and install Talv's plugin for SC2Layout files
4. Install your Java IDE
5. Install NSIS

Further Software already included:

• MPQ Editor by Ladislav Zezula. It is used to open and create MPQ files.

galaxy-observer-ui's Issues

HeroLeaderPanel's hotkey is hijacked

ConsoleUIContainer's HeroLeaderPanel hijacks the hotkey from the Frame created by the default UI.

Workaround is in place, but it has a small side effect:
You have to hit the hotkey (TAB) twice after using the close button with your mouse.

Tools Font change

The default font looks a little weird in Chinese.
If possible, please consider using Microsoft Yahei or Simsun for default.

Check if Extension mod only supporting 1vs1

Which features are working, which are not?
Modify extension mod to enable features?

BottomPanel's column titles use duplicated labels

It is a workaround to fix the engine bug with centered horizontal alignment and AutoSizeClamps' maxWidth setting.

Kill Log Panel - target portraits disappear when switching to Everyone vision

Add Cassia's trait talent progress bar on command button

Blizzard's implementation does not show to observers.

When this is possible, adding Genji's progress bar on his activateable talent can be done, too.

Unit Details Panel's buff/debuff icons visible

Problem is caused by those frames only updating after a game tick, not on selection change.

Maybe there is a way to make it appear transparent by default and blend it in instantly after a game tick somehow?

Selecting multiple units shows portrait

CountdownLabels do not work fine to show resource values

The countdown label does not animate properly.

Its CurrentValue is only displaying the first copied value in TargetValue.

See in bottompanel for details.

Add super fast MPQ-building mode for development (no compression)

Ladik's MPQ Editor's settings file needs to be replaced for that. Keep the user's default one alive, though...

Algorithm to find best compression for each file for built MPQ?

Possibly use something that tries random things and finds the best solution when you need it like Monte Carlo Tree Search.

Alert tooltips are green

Alert tooltips are green and not blue like all other tooltips.

Support armor that only works on hero attacks

e.g. Brightwing's E

PlayerIntroPanel is visible without Logos mod

It should be invisible. The system broke, it seems.

Hide Siege Damage label in unit details, if equal to Attack Damage

this would require a comparison between two frames in state groups

Disable sound of Character Sheet / Talents animation of default UI

The sound is created by animations and muting them does not seem to work.
Overriding the animation somehow fails.
last check: 17th may 2017

Add Auriel hero UI showing who got the crown buff

Showing who has the buff in Auriel's hero UI would be great, just like the default UI.

Problem is that the cutscene does not update automatically. Default UI's one seems to be updated via triggers.

Check if ExtensionMod's Production Tags still not support extended player colors

On maps for 8+ players, players can chose extended colors that the extension mod did not handle -> fallback image displayed.

Most likely this has been fixed by now. Need to check.

Create a frame browser for default UI

Figuring out everything that is inside a frame of the default UI can be a big pain.

Migrating to JMPQ3?

https://github.com/inwc3/JMPQ3
JMPQ3 is a small java library for accessing and modifying mpq (MoPaQ) archives.

Currently, none of the new C/C++ repos on github provides the write ability to write files into mpq.
Some out of dated repos could write but I don't think it could even works with early stage SC2 mpq.

I never wrote in Java and I have no Java IDE, but I could have a try with my classmate's computer, but it may take some times.

If JMPQ3 doesn't works with Heroes MPQ, I might work on StormLib this summer and ....... Even rewrite the tools in C# , maybe?

BottomPanel's Talent Tooltip's quest progress bar's max value not correctly set via propertybind

Propertybind fails to copy maxValue from the quest progress. Thus the quest progress is currently hidden.

Guldan hero UI buggy

Guldan's hero UI for Fel Flame Stacks can be broken via unit selection changes.

Murky hero UI with Egg status

That would be cool as the default UI has it.

DVa's Mech's life/energy not shown

DVa's Mech's life and energy are hidden because the top panel only reads her pilot unit's stats and they are both set when she exits her Mech.

RaceIcon stategroup has invalid state

The last state of the RaceIcon is invalid making that setting not work. The hotkey works except for that option when it is selected.

Scores panel in observer toolbar for non-1vs1

Add support for variable amount of players.

Add a Toggle Chat hotkey

Currently the chat cannot be toggled.

Engine dropped feature of Left being currently selected player outside 1vs1

"Left" used to be the player of the currently selected unit outside 1vs1. This is not the case anymore.

Figure a way to do it again or remove that feature for first release.

KillLog panel uses first slot

KillLog panel uses a first dummy entry until you change player vision.

Right click map score does not work as click is eaten by other animation

Right click on the map score label does not decrement the value as the input is eaten by the animation that should only accept left clicks.

Maybe another animation event exists to detect a right click.

Propertybinding @MaxValue from ProgressBar to ProgressBar fails

Thus, the QuestProgressBar within HeroTalentTooltipTemplate is hidden.

If this works, the label can copy the local questProgressBar's value and must not set for each player as it is done right now.

Alarak's hero UI

Progress bar is not working fine. Thus it is currently disabled.

Percentage based Anchor with "16.6667%" makes UI not work

The Frame uses a workaround to not use percentage based anchors.

The engine has a bug with pos="16.6667%" which makes the UI fail to load.

Last check: patch 2.24

BottomPanel's HighlightImage for ScoreValueLabels are hidden

The width settings are not accepted by the engine for some reason.

Valeera hero UI has problem resizing some images/animations

Some animated images are only resized correctly in one dimension. For some reason the other one is not working correctly.

Tooltips WorkersKilled, APM, ResourcesLost

Merge PlayerIntroPanels

TracerChargeContainer reads from wrong PlayerId in AI matches

Blizz sets PlayerId within UI XML and it references the wrong player in 5vs5 AI matches.

The problem occurs when Tracer is in the last slot of the red team (rightmost portrait). A Chen to her left had her PlayerId and she had his.

Overriding animations multiple times in templates does not work

exists in BottomPanel to avoid overriding an animation twice. The engine did not override an animation twice in a Layout file for some reason.

Bottom UI toggle not working, yet

Toggle to show/hide all UI at the bottom is not working.

Probius patch compatibility

• added talent icon to Talent tooltips, centered talent title (TODO clean up)
• added compatibility to Probius patch:
  • fixed top area showing talents
  • removed "VS" and role icons in bottom panel
  • TODO fixed talent icons in bottom panel
  • TODO healing fountain countdown moved slightly downwards to match position of buffs/debuffs
  • TODO ragnaros hero UI is broken, molten power thingy
  • TODO character sheet stuff (remove cooldown, add armor/spell armor)
  • removed preselection indicator from Probius' structures
  • added low Health label into Probius' health bar
  • fixed experience source labels of both teams showing no values
  • fixed ctrl+W hotkey making Blizzard's new small top bar visible
  • fixed KillLog panel not being visible
• removed preselection indicator from Lt. Morales' Medivac
• fixed "stopped" and "stasis" buffs overlapping in the unit details panel
• TODO added Zul'jin's Guiotine damage to hero UI (TODO: -> check texture in stategroup! -> set visible)

KillLog panel not visible from the start -> workaround in place

Fixed KillLog panel not being visible.
By default, it becomes visible when ctrl+w is pressed twice.
Hero unit spawns at the start of the match seems to break the ConsolePanel.

My fix is to keep ConsolePanel visible at all times and setting it visible when WorldPanel OnShown (for some reason that is required).

When Blizzard fixes the visibility, my own fix can be removed.

Buggy Hero UI - Ragnaros & Guldan

Ragnaros' und Guldan's hero UI is buggy with the release animation.

My own fix properly makes the background appear properly, but the end animation played when stacks drop to 0 is also triggered when you start selecting Ragnaros.

Guldan should have the identical problem as his code structure is similar.

Add 2.9's changes to merged version

2.9 did some changes that were not transferred, yet.

-remapped hotkeys to toggle Income and Army Supply graphs from Numpad1/2 to Shift+I and Shift+A
-Graphs will now hide and be hidden by other panels appearing in the screen's center
-added description in Message Log's controls list for these new hotkeys
-fixed player intro panels not hiding Structures Lost Panel
-widened the Scores button in the observer toolbar to remove label abbreviation at 720p resolution

Add logic to handle sponsor image in 1vs1

Although nobody ever used that feature, I believe.

Red Team's player vision makes heroleaderpanel slots swap sides

During red team's player vision, showing a heroleaderpanel will cause its sides to be swapped

Some HeroUIs cannot be moved around via the template frame

Current code might be super inefficient for these heroes, but gets the job done.

NOTE:

• Valeera hero uI shrinks her UI elements, so leave her alone.
• Lucio UI has elements moved around + animation with nuke button holder image

Zul'jin's hero UI does not show Guillotine damage UI elements

Elements are always hidden as nothing makes them visible.

Maybe it is possible to detect that this heroic was chosen and make the frames visible.

Show talents of player of selected unit

Comparing unit names might allow figuring out the player.

Program to edit settings/controls in UI files for End-User

Users cannot edit the hotkeys easily. A program could allow them to edit the settings and controls without an editor, etc.
A generic interface could be used for this, so GameHeart and AhliObs work automatically...