samyycX / CS2-PlayerModelChanger

A lightweighted counterstrikesharp plugin to change player model.
GNU General Public License v3.0
66 stars 8 forks source link
counter-strike-2 counter-strike-sharp cs-model-changer cs2 cs2-model-changer cs2-server-addon player-model-changer

CS2-PlayerModelChanger

✨ A CounterStrikeSharp plugin that allows players to customize their models, with features like a model selection menu, permission restrictions, setting default models, and other advanced options.

[!CAUTION] This plugin can cause a GSLT ban, please use at your own risk.

Custom model parts:

πŸš€ Features

πŸ“₯ Installation Guide

Download the plugin from latest Release, then put it into your counterstrikesharp plugin folder.

πŸ“¦ Optional Dependencies

  1. MultiAddonManager (for workshop model)

πŸ› οΈ Commands

Menu commands (Recommended!)

βš™οΈ Configuration

When you install the plugin successfully, it will generate counterstrikesharp/configs/plugins/PlayerModelChanger/PlayerModelChanger.json.

See Wiki to config it.

πŸ“š How to add default or workshop model

Step 1: Locate the Model Path

  1. Open the workshop .vpk (or pak01.vpk) file using Source2Viewer or GCFScape.
  2. Navigate to find the .vmdl_c file. Copy its path.
  3. Replace .vmdl_c in the path with .vmdl.

The path should look like this:

characters/.../xxx.vmdl

[!IMPORTANT] replace .vmdl_c in the path with .vmdl

Step 2: Setup MultiAddonManager (Workshop Model Only)

  1. Add your workshop ID to MultiAddonManager.
  2. Follow the instructions provided on the MultiAddonManager GitHub page.
  3. After adding the ID, switch the map once to initiate the download of the addon by MultiAddonManager.

Step 3: Config PlayerModelChanger

See the Configuration

🐞 Common Issues

πŸ™ Credits

🀝 Contribution

To build this plugin, run dotnet build.

Feel free to create Pull Requests or issues.

How to pack a model into steam workshop item

Requirements:

Step 1. Open your cs2 directory, find game/csgo/gameinfo.gi, go to the end of the file, find AddonConfig -> VpkDirectories . Then add the directory you want to put in the vpk like the following example:

example:

AddonConfig 
    {
        "VpkDirectories"
        {
            "exclude"       "maps/content_examples"
            "include"       "maps"
            "include"       "characters" // this is the directory you want to add to the vpk
            "include"       "cfg/maps"
            "include"       "materials"
            "include"       "models"
            "include"       "panorama/images/overheadmaps"
            "include"       "panorama/images/map_icons"
            "include"       "particles"
            "include"       "resource/overviews"
            "include"       "scripts/vscripts"
            "include"       "sounds"
            "include"       "soundevents"
            "include"       "lighting/postprocessing"
            "include"       "postprocess"
            "include"       "addoninfo.txt"
        } 
        "AllowAddonDownload" "1"
        "AllowAddonDownloadForDemos" "1"
        "DisableAddonValidationForDemos" "1"
    }

Step 2. Launch Counter-Strike 2 Workshop Tools, then click Create New Addon

Step 3. Go to folder ./game/csgo_addons/<your addon name>/ and paste your characters folder to here.

Step 4. Open Asset Browser, then click the Tools button on the top-right corner, open Counter-Strike 2 Workshop Manager

Step 5. Click New button in the Counter-Strike 2 Workshop Manager, fill in all the information, and publish it.

Step 6. After verification, you should be able to use the workshop item.