KF2-YetAnotherScoreboard/README.md
2021-06-20 08:41:06 +03:00

3.4 KiB

YetAnotherScoreboard

Steam Workshop Steam Subscriptions Steam Favorites Steam Update Date GitHub tag (latest by date) GitHub

Description

Yet another scoreboard... Based on the scoreboard from ClassicHUD and heavily modified.

Features

  • Doesn't block the view with the mouse when active;
  • Correctly displayed in all available resolutions;
  • Close to KF2 interface style;
  • Displays a large number of players;
  • The scoreboard adjusts to the size of the content;
  • Customizing the appearance and elements of the scoreboard;
  • Dynamically changing colors for some elements (depending on their value);
  • Player ranks.

Usage

See steam workshop page


Note: If you want to build/test/brew/publish a mutator without git-bash and/or scripts, follow these instructions instead of what is described here.

Build

  1. Install Killing Floor 2, Killing Floor 2 - SDK and git for windows;
  2. Open git-bash in the folder: C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame
  3. Clone this repository and go to the source folder:
    git clone https://github.com/GenZmeY/KF2-YetAnotherScoreboard && cd KF2-YetAnotherScoreboard
  4. Run make.sh script: ./make.sh --compile
  5. The compiled files will be here:
    C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Unpublished\BrewedPC\Script\

Testing

You can check your build using the make.sh script.
Open git-bash in the source folder and run the script:
./make.sh --test
On first launch, the script will create testing.ini file and launch the game with the settings from it. Edit this file if you need to test the mutator with different parameters.

Bug reports

If you find a bug, go to the issue page and check if there is a description of your bug. If not, create a new issue.
Describe what the bug looks like and how reproduce it.
Attach screenshots if you think it might help.

If it's a crash issue, be sure to include the Launch.log and Launch_2.log files. You can find them here:
C:\Users\<USERNAME>\Documents\My Games\KillingFloor2\KFGame\Logs\
Please note that these files are overwritten every time you start the game/server. Therefore, you must take these files immediately after the game crashes in order not to lose information.

License

GNU GPLv3