teamscaleform/scaleform

A cross-platform, hackable and future-proof reimplementation of In-Game Scaleform HUD in CS:GO using Panorama. Written using C, C++ and JS.

Join us on Discord!

scaleform

A hackable and future-proof reimplementation of In-Game Scaleform HUD in CS:GO using Panorama. Written using C, C++ and JS.

Disclaimer

We're not responsible for any potential VAC bans from using our project. Do not use this on any account you care about, unless you use -insecure, or respectively sv_lan 1 on local servers.

Features

• NEW: Cross-platform support!;
• JavaScript loader (load changes at run-time, on bind);
• Toggle Scaleform at run-time, without restarting game (on keybind - you're currently required to disconnect after toggling off, not when toggling on);
• Hot-swappable Win Panels (on keybind);
• Toggle Weapon Selection "show rarity" on/off (on keybind);
• Fully supports (almost) every HUD command (including cl_hud_color, cl_hud_background_alpha, cl_hud_healthammo_style, etc...);
• -insecure is not enforced;
• No performance drawbacks (unlike with HLAE+MIGI);
• Fully standalone (you only have to inject one DLL);
• Future proof (does not require to be updated for code.pbin updates - unless it breaks any of the JavaScript itself);
• Customizable (you can modify the CSS to your desires, and you can change keybinds and default states in config.hpp).

Known Issues

Check the Issues tab.

Main Menu

If there's interest, and support, we're willing to kickstart progress towards replicating the Scaleform main-menu(s). Anyhow, before we divert any attention to that, there's much work left on the In-Game HUD.

Contributing

Even if you don't know C++, you can write your changes in JavaScript (relating to the schema itself), and we will help implement the necessary boiler-plate for your change. If you're interested in doing such things, please join our Discord and see the #contributing channel. Thank you for your interest!

NOTE: Once you open your game, you'll be told where your custom JavaScript file is expected. If it is not found, and you press the Load JavaScript keybind, you'll be announced in the console.

Building - Windows

To build this project, you must install CMake (>=3.21), Ninja and Visual Studio 2022 Developer Tools, then, open up Developer Command Prompt for Visual Studio 2022, go to the respective directory where your clone of this project is located (quick-tip: if your clone is located on a disk other than your start disk, you can modify the Developer Command Prompt 'Start In' flag, in properties), then write:

./build_release.bat for release builds, or;

./build_debug.bat for debug builds (includes Debug logs).

Then, a build should start, and when it's done, your command prompt will be moved to the output directory, which should contain a TeamSCALEFORM.dll binary.

Ports

We support ports of the boilerplate to software's APIs. If you developed a port of the scaleform boilerplate, open a pull request that links your repository under this comment.

Alternatives

If you're a movie-maker, and you want something better suited for that purpose, please refer to this.

Licensing

This project is licensed under the AGPL-3.0 license. For a TLDR, refer to this. Please respect this.

Scams

If some are blind to the "Licensing" section, they're going to be 'advertised' here, so you know who to avoid. We encourage people to make pull requests, if they ever notice a project using this against our firm licensing terms, which name and link said project.

scaleform's Issues

Already cached icons need to be updated if Scaleform is turned on in game

Already addressed in old-votepanel branch, will port

Linux Support ...when?

Realistically how difficult/feasible would porting this project to Linux be?
Being able to use this without dual-booting would be really nice.

Weapon Selection doesn't properly update in spectator mode.

Weapon Selection boilerplate does not support weapon switches when spectating someone (this includes POV demos)

Weapon Selection background is hackily implemented

Like Team Count Avatars, has hardcoded delay.

New weapon icons need to be replaced

There's progress being done on this in the old-weapon-icons branch

HudHealthArmor low health warning

Look into this, currently it's the new one.

Win Panel fun fact not animated

Will be shortly addressed

does this still work on cs2?

Images for HUD do not load.

When I inject the ScaleForm.dll to csgo.exe with the -insecure parameter it doesn't load the images at all.
Not sure if its on my end, Due to me having poor coding skills in general or following instructions.

Issue:

Buy Cart is embed into Money BG

This is because we do the buyzone.js hack due to issues that occur if we try to move the actual respective responsible buycart object.
The issue here is that it follows cl_hud_background_alpha.

Weapon Selection background too tall, not long enough

@smevold look into implementing with weapon-row-background

Defuse Panel still is the new one

Weapon Selection background image doesn't animate out with cl_showloadout 0

Possible solutions:
A) Handling the transition ourselves
B) Moving row properties to a class that already handles this.

Zeus image improperly being rendered

System Information

OS: Microsoft Windows 10 x64 LTSC 21H2
DE: explorer.exe
WM: dwm.exe
ScaleForm Ver. latest git commit from Jul 30, 2022, 02:29 AM

Description

The Zeus X27 image is not properly being rendered, it gets cut whenever you wear it or not.

Steps to reproduce

Inject ScaleForm, go onto a CS:GO match and purchase the Zeus X27

Image

Voting Panel is still new one

Win Panels do not have the background white flash

Spectator Hud is not modified

Linux build instructions

M9 icon is Karambit

Hint Priority Label is pushed to the right upon text overflow

GitHub actions

Implementing GitHub actions would be real fancy, and having a release page using the artifacts produced would be great (I plan to start versioning Scaleform on GitHub). On Windows it should be pretty simple - ./buld_release.bat, but the current Linux build system is kind of integrated in the CMakeLists.txt, therefore moving it away from there (note: does anyone know the Linux support for CMakePresets? It'd be great to be able to exactly replicate the build process) would help our case (an alternative would be just shipping the build type as release, but that's horribly hacky... and also what's being done currently).

Local killfeeds are only 5s due to issues with animations

TODO: Look into hacking in the translation property.

Support more gamemodes

Gamemode support is currently lackluster and it's just expected for everything to harmonically work (example: in Deathmatch, or, oh God, I didn't even consider Danger Zone...)

Win Panels do not account for music kits

Winpanel fun fact different behaviour based on event delay (affecting context)

Will be addressed shortly

Icons change even when Scaleform is off

Event delays

Event firing is delayed by the game. Changing this could be a potentially controversial choice. It should be considered and tested.

Radar images

Radar images were different in Scaleform time, but they're also innacurate to map updates. Therefore, they should be toggle-able.

Team Counter Avatars white outline is hackily implemented

Therefore there's small delays on equip bot/swap team (necessary so it doesn't 'lag' behind). This is hacked into the JS itself.

Team Counter does not support the bottom option

It goes like 1/4 down

DeathNotices improper with new icons

Prettify JS

The JavaScript is not particularly elegant, so it'd be worth to look into improving it.