# CodeRanch - cLoadingscreen

## Installation

1. Place `cLoadingscreen` folder into your server's `resources` directory.
2. Add `ensure cLoadingscreen` to your `server.cfg`.
3. Remove or disable any other loading screen resource.

## Configuration (config.js)

### Server Icon

Replace `server-icon.png` in the root folder with your own logo.

### Max Volume

```js
maxVolume: 0.008  // Maximum audio volume (0.0 - 1.0)
```

### Locales

All UI texts are customizable:

```js
locales: {
    welcome: "WELCOME,",
    subtitle: "Your server description here",
    pleaseWait: "Please wait!",
    changelogs: "Changelogs!",
    releasedBy: "Released by",
    releaseDate: "Release Date",
    gameLoading: "Game is loading.",
    mapLoading: "Map & textures loading...",
    characterLoading: "Your character is loading...",
    scriptsAnalyzing: "Scripts analyzing...",
    gameLoaded: "Game loaded!",
}
```

### Social Links

Set a link to show the button. Leave empty `""` to hide it.

```js
links: {
    website: "https://yoursite.com",
    tiktok: "https://tiktok.com/@you",
    youtube: "https://youtube.com/@you",
    discord: "https://discord.gg/invite",
}
```

### Music

Add `.mp3` files to the `music/` folder, then add entries to the config:

```js
music: [
    {
        name: "Song Title",
        author: "Artist Name",
        file: "../music/filename.mp3"
    },
]
```

* File path must start with `../music/`.
* Players can skip tracks with prev/next buttons.
* Selected track and volume are saved per player (localStorage).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://coderanch-redm-store.gitbook.io/coderanch-redm-store-docs/coderanch-cloadingscreen.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.