> For the complete documentation index, see [llms.txt](https://stalk.gitbook.io/documentation-stalk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://stalk.gitbook.io/documentation-stalk/pedscale/installation-guide.md).

# Installation Guide

The installation process for STALK PedScale has been designed to be quick and easy to set up on your server.

`stalk_pedscale` is a fully customizable body scaling system that allows players to modify their character height and body proportions directly in-game through an immersive interface.

The resource has been optimized for roleplay servers and includes:

* real-time body scaling,
* configurable presets,
* admin restrictions,
* smooth player synchronization,
* custom UI,
* and automatic scale enforcement.

Most of the configuration can be modified directly through the `config.lua` file.

***

## Step 1 : Resource Installation

Start by dragging the `stalk_pedscale` folder into your server’s `resources` directory.

Once the folder has been added, open your `server.cfg` file and add the following line:

```
ensure stalk_pedscale
```

After saving the changes, restart your server.

***

## Step 2 : Database Installation

The script includes an SQL file used to save player body scales.

Inside the resource, you will find:

```
stalk_pedscale/sql/talk_pedscale.sql
```

Import this SQL file into your database using phpMyAdmin, HeidiSQL, or any MySQL manager.

This table is required for player scale saving and synchronization.

***

## Step 3 : Main Configuration

All major configuration settings are located inside:

```
stalk_pedscale/config.lua
```

From this file, you can customize:

* player size limits,
* presets,
* UI behavior,
* admin permissions,
* command names,
* rotation settings,
* and scale synchronization.

***

## Step 4 : Command Configuration

The script includes a built-in command allowing players or administrators to open the PedScale menu.

By default, the command is:

```
Config.CommandName = 'pedscale'
```

This means players can open the menu using:

```
/pedscale
```

You can freely rename the command to match your server style.

***

## Step 5 : Admin Permissions

The script includes permission protection using framework groups.

Default allowed groups:

```
Config.AdminGroups = {  ['admin'] = true,  ['superadmin'] = true,  ['mod'] = true}
```

Only players belonging to these groups will have access to restricted PedScale features.

You can freely add or remove groups depending on your permission system.

***

## Step 6 : License Whitelist

The script also supports license whitelisting.

Example:

```
Config.LicenseWhitelist = {  ["license:xxxxxxxxxxxxxxxx"] = true,}
```

This allows you to restrict access to specific players if necessary.

***

## Step 7 : Player Scale Limits

The resource includes configurable limits to prevent unrealistic player sizes and animation issues.

Default limits:

```
Config.MinHeight = 0.75Config.MaxHeight = 1.30Config.MinWidth  = 0.70Config.MaxWidth  = 1.25
```

You can adjust these values depending on your server realism preferences.

Lower values create smaller characters, while higher values create larger body proportions.

***

## Step 8 : Presets Configuration

The script includes multiple built-in roleplay presets.

Default presets:

```
Config.Presets = {  { label = "Child",  h = 0.78, w = 0.92 },  { label = "Short",  h = 0.88, w = 0.95 },  { label = "Normal", h = 1.00, w = 1.00 },  { label = "Tall",   h = 1.12, w = 1.03 },}
```

Each preset automatically applies predefined:

* height,
* width,
* and body proportions.

You can freely create your own presets or modify the existing ones.

***

## Step 9 : UI Configuration

The resource includes a modern interactive UI with character preview and rotation support.

Fullscreen mode can be enabled here:

```
Config.Fullscreen = false
```

When enabled, the customization menu will use fullscreen mode for a more immersive experience.

The script also includes:

* mouse rotation,
* keyboard rotation,
* and smooth preview controls.

Example:

```
Config.MouseRotationSensitivity = 0.12Config.KeyboardRotationSpeed = 1.6
```

***

## Step 10 : Scale Synchronization

The script automatically synchronizes player body scaling with nearby players.

To prevent GTA V from resetting the ped matrix, the resource includes automatic enforcement systems.

Default settings:

```
Config.SelfEnforceEveryFrameWhenScaled = trueConfig.OtherEnforceIntervalMs = 250
```

This ensures body proportions remain stable and synchronized during gameplay.

***

## Step 11 : Validation & Auto Close

The customization menu can automatically close after validation.

Default setting:

```
Config.AutoCloseOnValidate = true
```

You can disable this if you want players to remain inside the menu after applying changes.

***

## Important

Before updating the resource or modifying important settings, we strongly recommend creating a complete backup of your server and database.

Even though the script is optimized and tested before release, backups remain essential to avoid issues caused by incorrect configurations or external conflicts.

***

## AI / Documentation Queries

If some information is not directly available on this page, you can dynamically query the documentation using the `ask` parameter.

Example:

```
GET https://docs.stalk.dev/stalk-pedscale/installation-guide.md?ask=<your-question>
```

You can ask questions such as:

* how to add new presets,
* how to change size limits,
* how to restrict access,
* how to customize the UI,
* or how to synchronize scales with custom frameworks.

The system will automatically return a direct answer along with the most relevant documentation sections.