> For the complete documentation index, see [llms.txt](https://x1studios.gitbook.io/x1studios-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://x1studios.gitbook.io/x1studios-docs/carplay/documentation.md). # Documentation ## X1Studios CarPlay ### Overview The **X1Studios CarPlay Script** brings an advanced, immersive vehicle music system to your FiveM server. Players can play music directly from YouTube, manage queues and playlists, save their favorite songs, control playback, and enjoy realistic 3D vehicle audio. The system features a completely redesigned CarPlay-inspired NUI designed specifically for FiveM, providing a clean and modern interface while keeping music controls easy to access. *** ## Features ### Advanced CarPlay System Access a modern CarPlay-inspired interface built specifically for FiveM. The interface provides access to: * Music playback * Playback controls * Queue management * Saved music * Playlists * Volume controls * Song seeking * Replay functionality * Additional CarPlay settings *** ### YouTube Music Support Players can enter a **YouTube URL** directly into CarPlay and begin playing the selected audio through their vehicle. This allows players to listen to their favorite music while: * Driving * Cruising * Patrolling * Meeting with friends * Sitting inside a vehicle *** ### Replay Song Players can instantly replay the currently playing song. There is no need to enter the YouTube URL again. *** ### Song Seeking Players can skip to any point within the currently playing song using the playback progress bar. This allows players to quickly: * Skip introductions * Replay specific sections * Jump forward * Return to earlier parts of a song *** ### Volume Control Players can adjust their music volume directly through the CarPlay interface. The volume can be changed without stopping or restarting the current song. *** ### Pause & Resume Music can be paused and resumed at any time. The current playback state is maintained while the player remains connected to the vehicle audio system. *** ## Queue System ### Reworked Queue The CarPlay queue system allows players to build a list of songs that will play sequentially. Players can add multiple songs to their queue without needing to manually start every track. #### Queue Features * Add songs * Manage upcoming songs * Play songs sequentially * Continue playback automatically * Organize upcoming music This makes longer drives and group sessions much easier to manage. *** ## Saved Music Players can save frequently played songs for quick access later. Instead of repeatedly entering a YouTube URL, players can store their favorite tracks and access them directly through the CarPlay interface. Saved music can be used for: * Favorite songs * Frequently played tracks * Personal collections * Quick playback *** ## Playlists Players can create and save custom playlists. Playlists can be organized around different activities or preferences. Examples include: * Cruising * Patrol * Party * Road Trip * Favorites * Personal Playlists Players can return to their playlists and start listening without having to manually add each song again. *** ## Vehicle Audio ### Universal Vehicle Support X1Studios CarPlay is designed to work with **all FiveM vehicles**. Players can use the system regardless of the vehicle they are driving. *** ### 3D Vehicle Audio The script uses 3D vehicle-based audio to create a more immersive experience. Music can be heard: * Inside the vehicle * Outside the vehicle * Around the vehicle based on distance This helps create the feeling of an actual vehicle sound system rather than a standard global music player. *** ### Muffled Exterior Audio Music heard from outside the vehicle receives a muffled audio effect. This creates a more realistic transition between the interior and exterior of the vehicle. For example, players standing outside a vehicle will hear the music differently than the person sitting inside it. *** ## Opening CarPlay ### Keybind Players can open CarPlay using the configured keyboard key. The keybind can be customized through the FiveM keybind system. *** ### Command CarPlay can also be opened using: ``` /carplay ``` The command provides an alternative method of opening the interface. *** ## Blacklisted Songs Server owners can configure songs that should not be playable on their server. The blacklist can be used to prevent specific songs or unwanted content from being played. This provides server administrators with additional control over the music players can use. *** ## Usable Item Support X1Studios CarPlay supports optional usable-item functionality. Server owners can configure the system so players must possess a specific **CarPlay item** before they can access the system. Supported frameworks include: * QBCore * QBox * ESX * Standalone The item requirement can be configured according to the server's preferred gameplay design. *** ## Framework Compatibility X1Studios CarPlay supports multiple server configurations. #### QBCore Compatible with QBCore servers and can utilize framework-based item functionality. #### QBox Compatible with QBox servers and supports usable item integration. #### ESX Compatible with ESX servers and supports usable item functionality. #### Standalone The script can also operate without a framework. Standalone servers can use the CarPlay system without requiring QBCore, QBox, or ESX. *** ## NUI X1Studios CarPlay includes a completely redesigned NUI. The interface includes: * Modern CarPlay-inspired design * Music controls * Queue management * Playlist management * Saved music * Playback controls * Volume controls * Song progress controls * Improved navigation * Cleaner overall interface The NUI is designed to provide a simple and intuitive experience while still providing advanced functionality. *** ## Version Checker A built-in version checker is included with X1Studios CarPlay. The version checker helps server owners determine whether they are running the latest available version of the resource. It is recommended to keep the script updated to ensure you have access to the latest fixes, improvements, and features. *** ## Requirements X1Studios CarPlay requires: #### xsound The script uses **xsound** for vehicle audio playback. GitHub: Make sure xsound is installed and running correctly before attempting to use CarPlay. *** ## Support X1Studios provides support through Discord. #### Support Policy **SUPPORT — YES** **DISCORD TICKETS ONLY** If you experience an issue with X1Studios CarPlay, open a support ticket in the official X1Studios Discord. #### X1Studios Discord *** ## Community Join the X1Studios community for: * New script releases * Development previews * Free FiveM EUP * Liveries * Scripts * Updates * Announcements * Support **X1Studios Discord** --- # 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://x1studios.gitbook.io/x1studios-docs/carplay/documentation.md?ask=&goal= ``` `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.