K-YOU 1.0 for GTA V, by LiorMods
Your music as a real station on the GTA V radio wheel.
==========================================================================================

K-YOU turns GTA V's "Self Radio" into K-YOU, a live radio station for the music player
already running on your PC: Spotify, YouTube Music, a browser tab and others.

  * Get in a car, pick K-YOU on the radio wheel, and your music plays.
  * It pauses when you leave the car, change station, open the pause menu or Alt+Tab,
    and resumes at the same second.
  * The song name appears on screen when it changes, in any language.
  * The music drops during phone calls and while characters talk.
  * The next car you get into stays on K-YOU.
  * Next / previous song on the game's own radio-track keys; play / pause and your own
    volume for the music, separate from the game's sound.
  * Its own name and logo on the radio wheel.

No account, no login, no extra program.

Made and tested on GTA V Legacy 1.0.3889 (Steam) with Script Hook V, ScriptHookVDotNet
v3.7.0-nightly.193 and Lenny's Mod Loader 0.4, on Windows 11, with Spotify.
GTA V Enhanced is not supported.


REQUIREMENTS
------------------------------------------------------------------------------------------
  * GTA V PC, Legacy edition, Story Mode. Never use mods in GTA Online.
  * Script Hook V (runs scripts in the game). Step-by-step guide:
       https://liormods.com/guides/script-hook-v
  * ScriptHookVDotNet, a NIGHTLY version (v3.7.0-nightly.193 or newer). The "stable" 3.6.0
    does not work on current game versions. Step-by-step guide:
       https://liormods.com/guides/scripthookvdotnet
  * Lenny's Mod Loader (LML), for K-YOU's name and logo on the wheel. Guide:
       https://liormods.com/guides/lennys-mod-loader
    Without LML, K-YOU still plays your music; the station is then called "Self Radio".
  * A music player. Spotify is best. Anything that shows in Windows' media controls works.


INSTALL
------------------------------------------------------------------------------------------
1. Copy the two folders "scripts" and "lml" from this zip into your GTA V folder (the one
   with GTA5.exe). If Windows says a folder already exists, let it merge.
   Result:   Grand Theft Auto V\scripts\K-YOU.dll
             Grand Theft Auto V\lml\K-YOU\
2. Start the game. LML adds K-YOU by itself, and K-YOU puts 3 short silent tracks into your
   GTA V "User Music" folder (Documents\Rockstar Games\GTA V\User Music). Self Radio needs
   them to appear on the wheel.
3. K-YOU is on the radio wheel. Not there yet? That can happen on the very first start,
   before the game has seen the new tracks: Settings > Audio > "Perform Quick Scan for
   Music" (or start the game again). K-YOU tells you with a message when this is needed.

Already had your own songs in "User Music"? K-YOU takes over Self Radio, so move them out
of that folder, or the game plays them under your music.


PLAY
------------------------------------------------------------------------------------------
  1. Open your music player. Paused is fine.
  2. Start the game. A few seconds in, a message says "K-YOU is ready".
  3. In a car, hold Q for the radio wheel and pick K-YOU. Your music starts.

  Keys (only while on K-YOU, in a vehicle):
     =   next song           -   previous song      (the game's own radio-track keys)
     '   play / pause
     ;   volume down         \   volume up

  ' ; and \ are not used by the game at all (checked against GTA V's own key bindings).
  = and - are the game's own "Next / Previous Radio Track" controls, so if you changed those
  in the game's key bindings, K-YOU follows yours. K-YOU never blocks a key: the game still
  gets every press.


SETTINGS
------------------------------------------------------------------------------------------
After the first run: Grand Theft Auto V\scripts\K-YOU.ini (edit with the game closed).
  * PlayPause, VolumeDown, VolumeUp    any letter, digit, F1-F24, NumPad0-9, ' ; \ / [ ] , .
                                       - = ` and more, or None
  * TuneInDelayMs      how long the radio rests on K-YOU before the music starts (default 600)
  * ShowSongNames      song name on screen, 1 = on
  * PauseOnAltTab      pause while the game is in the background, 1 = on
  * AutoTuneOnEnter    0 = the game picks the station, 1 = stay on K-YOU if you were on it
                       (default), 2 = always start on K-YOU
  * DuckDuringDialogue lower the music during phone calls and while characters talk, 1 = on
  * Volume             K-YOU volume, in percent of your player's own volume (default 100).
                       The ; and \ keys change it in game and it is saved here.


TROUBLESHOOTING
------------------------------------------------------------------------------------------
  * No "K-YOU is ready" message and no music: ScriptHookVDotNet isn't loading K-YOU. Open
    ScriptHookVDotNet.log in the GTA V folder: it should say "Started script KYou". No log
    at all = ScriptHookVDotNet or Script Hook V isn't installed (see REQUIREMENTS).
  * K-YOU is on the wheel but no music plays, and ScriptHookVDotNet.log says "An
    Application Control policy has blocked this file": Windows 11's Smart App Control
    blocked K-YOU.dll. It does that to new files it doesn't know yet. Start the game once
    more; if it stays blocked, see https://liormods.com/guides/smart-app-control
  * K-YOU isn't on the radio wheel: do INSTALL step 3 (Quick Scan). Still missing? Check
    that "K-YOU silence 1.mp3" (and 2, 3) are in Documents\Rockstar Games\GTA V\User Music.
  * The wheel shows "Self Radio" with Rockstar's logo, but the music works: LML isn't loading.
    On Windows 11 this can be Smart App Control blocking LML's vfs.dll, and then your other
    LML mods are missing too. Start the game once more first; if it stays blocked, see
       https://liormods.com/guides/smart-app-control
  * You use another mod that changes the radio wheel icons (hud.ytd), like a colored radio
    wheel: only one of them can show. To keep the other one, open LML's Mod Manager
    (ModManager.UI.exe, in the "ModManager" folder of the LML download) and turn off
    "K-YOU - wheel logo" under K-YOU. The name K-YOU stays.
  * Skips feel slow: YouTube in a browser tab loads each video. Spotify and YouTube Music
    are instant.
  * Rockstar Editor clips have no K-YOU music: it plays outside the game, so the editor
    can't record it.
  * If the game crashes, your music keeps playing. Pause it in your player.


UNINSTALL
------------------------------------------------------------------------------------------
Delete from the GTA V folder: scripts\K-YOU.dll, scripts\K-YOU.ini, scripts\K-YOU.log,
the folder scripts\K-YOU, and the folder lml\K-YOU.
Delete "K-YOU silence 1.mp3", "K-YOU silence 2.mp3" and "K-YOU silence 3.mp3" from
Documents\Rockstar Games\GTA V\User Music, then do a Quick Scan. No game file is changed.


LICENSE
------------------------------------------------------------------------------------------
K-YOU (c) LiorMods. Free to download and use. Do not reupload, modify for redistribution,
or sell without permission. Videos and streams showing the mod are welcome. See LICENSE.txt.

CONTACT
------------------------------------------------------------------------------------------
Website and news:                         https://liormods.com/mods/k-you-gta-5
Questions, bugs, or just want to say hey?  hey@liormods.com
Like it? Buy me a coffee (optional):       https://buymeacoffee.com/liormods

CREDITS
------------------------------------------------------------------------------------------
Script Hook V (c) Alexander Blade, http://www.dev-c.com/gtav/scripthookv/
ScriptHookVDotNet (c) crosire and contributors, https://github.com/scripthookvdotnet
Lenny's Mod Loader (c) LMS, https://www.lcpdfr.com/
Spotify, YouTube and other names belong to their owners. K-YOU is not affiliated with
them, or with Rockstar Games or Take-Two Interactive.
