diff --git a/README.md b/README.md index 2e00cb6..d1876ce 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,19 @@ This repo contains sources for the last public NicePack release. -It is a haphazard bunch of changes that were made to customize ScrN for ourselves. It is unfinished, but due to some reasons I don't want to release it publicly anymore. +It is a haphazard bunch of changes that were made to customize [ScrN](https://github.com/poosh/KF-ScrnBalance) for ourselves. It is unfinished, but due to some reasons I don't want to release it publicly anymore. -The link to the compiled NicePack, along with all necessary files, is here: +## Documentation -## Config Files - -Only 1 file atm: [NicePack.ini](Configs/NicePack.ini) - -## Changelog - -Complete changelog lies [here](Docs/CHANGELOG.md). +- [Config file](Configs/NicePack.ini). +- [Changelog](Docs/CHANGELOG.md). ## Build Info > N.B. `NiceNameHack` is required for scrn testmap only! +You can use this [bat file](Docs/Compile%20Scripts/Compilation.bat) for basic compilation. + ```ini EditPackages=ServerPerks EditPackages=ServerPerksMut @@ -31,4 +28,51 @@ EditPackages=NicePack EditPackages=NiceNameHack ``` -You can use [this](Docs/Compile%20Scripts/Compilation.bat) bat file for basic compilation. +## Installation + +The link to the compiled NicePack, along with all necessary files, is here: + +```text +NicePack Assets: +├── Animations +│ └── NicePackA.ukx +├── Sounds +│ └── NicePackSnd.uax +├── StaticMeshes +│ └── NicePackSM.usx +└── Textures + ├── MeanZedSkins.utx + └── NicePackT.utx +``` + +```text +Requirements Assets +|-- Animations +| |-- HMG_A.ukx.ukx +| |-- HTec_A.ukx +| |-- ScrnAnims.ukx +| |-- ScrnWeaponPack_A.ukx +| `-- ScrnZedPack_A.ukx +|-- Maps +| |-- KFO-Foundry-SE.rom +| `-- KF-ScrnTestGrounds.rom +|-- Sounds +| |-- HMG_S.uax +| |-- ScrNFoundry.uax +| |-- ScrnSnd.uax +| |-- ScrnWeaponPack_SND.uax +| `-- ScrnZedPack_S.uax +|-- StaticMeshes +| |-- ScrnWeaponPack_SM.usx +| `-- ScrnZedPack_SM.usx +`-- Textures + |-- BDFonts.utx + |-- CountryFlagsTex.utx + |-- GunSkins_T.utx + |-- HMG_T.utx + |-- ScrnAch_T.utx + |-- ScrnTex.utx + |-- ScrnWeaponPack_T.utx + |-- ScrnZedPack_T.utx + `-- TSC_T.utx +```