> For the complete documentation index, see [llms.txt](https://theobsidianstudio-1.gitbook.io/theobsidianstudio-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://theobsidianstudio-1.gitbook.io/theobsidianstudio-docs/assets/obs_loadingscreen/faq.md).

# FAQ

Here you will find answers to the most common questions regarding the OBS Loading Screen. If your issue isn't listed here, feel free to reach out to our support team on Discord!

***

### 📦 Installation & Setup

**Q: How do I install this?** **A:** Just drag the `obs_loadingscreen` folder into your server's resources folder and add `ensure obs_loadingscreen` to your `server.cfg`. That's it!

**Q: Does this work on any server?** **A:** Yes! It works flawlessly on ESX, QBCore, vRP, Standalone, and any other custom framework.

**Q: Why isn't my logo showing?** **A:** There are three possible reasons:

1. You didn't add your logo to `img/logo.png`.
2. The file name has incorrect capitalization (Remember: `logo.png` ≠ `Logo.png`).
3. The path in your config is wrong (it should exactly say `img/logo.png`).

**Q: The loading screen doesn't show at all?** **A:** Check these common mistakes:

* Ensure the folder name matches the `resourceName` setting in your `config.js`.
* Verify the resource is successfully starting in your server console without errors.

**Q: Can I change the folder name?** **A:** Yes, but you MUST update the `resourceName` in `config.js` to match the new folder name exactly.

***

### 🎨 Customization

**Q: How do I change the theme colors?** **A:** Edit the themes section in your `config.js`:

```javascript
themes: { 
    purple: { name: "My Custom Theme", primary: "#yourcolor", secondary: "#yoursecondcolor" } 
}
```

**Q: Can I add more navigation tabs?** **A:** Yes! Just add a new entry to the `navigation.items` array in your config:

```javascript
items: [ 
    { label: "HOME", section: "home", default: true }, 
    { label: "MY TAB", section: "custom", default: false }, 
]
```

**Q: How do I add my own music?** **A:** Place your MP3 files in the `audio/` folder, then add them to the playlist in your config:

```javascript
playlist: [ 
    { label: "Song Name", author: "Artist", src: "audio/yourmusic.mp3", cover: "img/cover.jpg" } 
]
```

**Q: Can I remove the music player completely?** **A:** Yes, just set `enabled: false` inside the music section of your config.

**Q: How do I change the loading bar position?** **A:** Edit the loadingBar section in your config:

```javascript
loadingBar: { 
    style: "vertical", // Options: "vertical" | "horizontal" 
    position: "right", // Options: "right" | "left" 
}
```

***

### 🎮 Features & Integration

**Q: Why doesn't the Discord member count work?** **A:** Due to FiveM browser security limitations, live Discord API calls often fail in-game. Here is the solution:

1. Enable the **Discord Widget** in your Discord Server Settings.
2. Add your `discordGuildId` to the config.
3. Always set `fakeMemberCount` to your actual server population as a fallback.

**Q: Why does the Server Uptime show "NOT SET"?** **A:** You haven't configured your server IP in the config. Update it like this:

```javascript
status: { 
    server: { ip: "your.server.ip:30120" } // Add your IP and port here!
}
```

**Q: Why doesn't the music autoplay?** **A:** Standard browser security requires user interaction before audio can play. Players must click anywhere on the screen first.

**Q: Why is the audio visualizer not working?** **A:** Similar to music autoplay, the visualizer requires a user click to initialize the audio engine. Clicking anywhere on the loading screen or pressing play will fix this.

***

### ⚡ Performance

**Q: The loading screen feels laggy, how do I fix it?** **A:** You can optimize it by reducing heavy visual elements in your `config.js` or enabling the built-in low-end mode:

```javascript
general: { performanceMode: "low_end" } // Turns off blur & heavy shadows
orbs: { count: 15 } // Reduce from 25
visualizer: { enabled: false } // Turn off visualizer
background: { type: "image" } // Use a static image instead of a video
```

**Q: Will this affect my actual server performance?** **A:** No! The loading screen is entirely client-side and only runs while players are connecting. Once they are fully in-game, it stops completely and consumes 0.00ms.

***

### 🐛 Troubleshooting

**Q: I see "window\.obsConfig is not defined" in the F8 console?** **A:** This means your `config.js` is failing to load. Check that:

* There are no syntax errors (missing commas are the #1 cause!).
* The file still exists in the `script/` folder.

**Q: My images aren't showing?** **A:** Double-check that the file path is correct and remember that it is case-sensitive. Files must be placed in the `img/` folder (Supported: PNG, JPG, WEBP, GIF).

**Q: The Rules modal shows up every time I join!** **A:** Ensure `rememberAccepted: true` is set in your config, and verify that the player isn't actively clearing their FiveM browser cache.

**Q: How do I see error messages?** **A:**

* **Server errors:** Check your Server Console / TxAdmin.
* **Client errors:** Press F8 in-game.
* **NUI errors:** Press F8 in-game, then type `client`.

***

### 🔧 Advanced Configuration

**Q: Can I add custom HTML/CSS?** **A:** Yes! You can edit `index.html` and `style/main.css`. Please back up your original files before making heavy modifications.

**Q: Can I use YouTube videos as the background?** **A:** Yes, just change the background `type` to `"youtube"` and set your `youtubeVideoId`.

**Q: Can I use this without a logo?** **A:** Yes, but you will see a broken image icon if the path points to nowhere. You should either upload a blank, transparent logo or hide the element entirely using CSS.

***

### 🛒 Tebex, Updates & Support

**Q: How do I get updates?** **A:** Download the latest version from your Tebex account and replace the old files. Always backup your `config.js` before overwriting!

**Q: I lost my download link, what do I do?** **A:** Log into your Tebex account → Purchases → Find Obsidian Loading Screen → Download again.

**Q: Are updates free?** **A:** Yes! All future updates are free for existing customers.

**Q: Where do I get support?** **A:** Open a ticket on our Discord with your Order Number, the Server Artifact Version, any Error Messages, and a brief explanation of the issue. Support is completely free!

***

### 📋 Quick Problem Solver

| Problem                  | Most Likely Fix                                             |
| ------------------------ | ----------------------------------------------------------- |
| **Nothing shows up**     | Check `ensure obs_loadingscreen` in `server.cfg`            |
| **No Logo**              | Add your file to `img/logo.png`                             |
| **Discord count wrong**  | Set `fakeMemberCount` in the config                         |
| **Music won't play**     | Click anywhere on the screen first                          |
| **Images are broken**    | Check file path case-sensitivity                            |
| **Heavy lag**            | Reduce orb count, disable visualizer, or use `low_end` mode |
| **Rules keep showing**   | Set `rememberAccepted: true`                                |
| **Server uptime broken** | Add your server IP/Port to the config                       |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://theobsidianstudio-1.gitbook.io/theobsidianstudio-docs/assets/obs_loadingscreen/faq.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.