diff --git a/PublicationContent/description.txt b/PublicationContent/description.txt index a7a5992..51efe8a 100644 --- a/PublicationContent/description.txt +++ b/PublicationContent/description.txt @@ -29,11 +29,11 @@ No. This mod is not whitelisted and will unrank your server. Any XP gained will 1. Open your PCServer-KFEngine.ini / LinuxServer-KFEngine.ini; 2. Add the following string to the [b][OnlineSubsystemSteamworks.KFWorkshopSteamworks][/b] section: -[code]ServerSubscribedWorkshopItems=[/code] +[code]ServerSubscribedWorkshopItems=2521826524[/code] 3. Start the server and wait while the mutator is downloading; 4. Stop the server; 5. Add mutator to server start line: [b]?Mutator=YAS.YASMut[/b] -7. Start the server. +6. Start the server. [h1]Setup[/h1] All settings are here: diff --git a/PublicationContent/preview.png b/PublicationContent/preview.png index c421a55..2a3d4a3 100644 Binary files a/PublicationContent/preview.png and b/PublicationContent/preview.png differ diff --git a/README.md b/README.md index 2e39a7f..eb19503 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,57 @@ # YetAnotherScoreboard +[![Steam Workshop](https://img.shields.io/static/v1?message=workshop&logo=steam&labelColor=gray&color=blue&logoColor=white&label=steam%20)](https://steamcommunity.com/sharedfiles/filedetails/?id=2521826524) +[![Steam Subscriptions](https://img.shields.io/steam/subscriptions/2521826524)](https://steamcommunity.com/sharedfiles/filedetails/?id=2521826524) +[![Steam Favorites](https://img.shields.io/steam/favorites/2521826524)](https://steamcommunity.com/sharedfiles/filedetails/?id=2521826524) +[![Steam Update Date](https://img.shields.io/steam/update-date/2521826524)](https://steamcommunity.com/sharedfiles/filedetails/?id=2521826524) +[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/GenZmeY/KF2-YetAnotherScoreboard)](https://github.com/GenZmeY/KF2-YetAnotherScoreboard/tags) +[![GitHub](https://img.shields.io/github/license/GenZmeY/KF2-YetAnotherScoreboard)](LICENSE) + +# Description +Yet another scoreboard... +Based on the scoreboard from [ClassicHUD](https://steamcommunity.com/sharedfiles/filedetails/?id=1963099942) 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](https://steamcommunity.com/sharedfiles/filedetails/?id=2521826524) + +*** + +**Note:** If you want to build/test/brew/publish a mutator without git-bash and/or scripts, follow [these instructions](https://tripwireinteractive.atlassian.net/wiki/spaces/KF2SW/pages/26247172/KF2+Code+Modding+How-to) instead of what is described here. + +# Build +1. Install [Killing Floor 2](https://store.steampowered.com/app/232090/Killing_Floor_2/), Killing Floor 2 - SDK and [git for windows](https://git-scm.com/download/win); +2. Open git-bash in the folder: `C:\Users\\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\\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](https://github.com/GenZmeY/KF2-YetAnotherScoreboard/issues) 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\\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](LICENSE) \ No newline at end of file