3D-Stream-Radio/README.md
Grocel 7959186671 Updated help texts, changed whitelist logic
- Updated help and description texts to reflect the latest changes. Spelling and grammar fixes.
- Added info buttons and new options to admin panel
- Updated help links in whitelisting errors
- CFC Whitelist and built-in whitelist logic are completely separated now
- Added ConVar `sv_streamradio_url_whitelist_enable_on_cfcwhitelist`. Built-in whitelist is disabled by default if CFC Whitelist is installed to improve radio usability. Use added ConVar to change this behavior. It's safe to change.
2023-10-30 00:40:04 +01:00

69 lines
3.4 KiB
Markdown

# 3D Stream Radio
The 3D Stream Radio is an spawnable scripted entity for [Garry's Mod][] that allows you to play streams from the internet and local files in 3D world sound. You spawn it with the toolgun, which allows you to change the its settings aswell.
<a href="http://www.youtube.com/watch?feature=player_embedded&v=P1avmNyiIYc
" target="_blank"><img src="http://img.youtube.com/vi/P1avmNyiIYc/maxresdefault.jpg"
alt="[GMOD] 3D Stream Radio - GUI and Wiremod" width="640" height="360" border="10" /></a>
# Workshop Installation
The 3D Stream Radio is available on the Steam Workshop! Go to [its Workshop page][workshop] and press `Subscribe`, and it will automatically appear in Garry's Mod.
## Requirements
1. Up to date [Garry's Mod][] Server/Client.
## Recommended addons
1. [Wiremod][] for Wiremod functionalities.
2. [GM_BASS3][] for loader sound and Wiremod spectrum output (Advanced Outputs).
2. [\[NM\] Prop Pack][NM Prop Pack] for additional speaker models.
# Features
- Serverside playlists
- Playlist browser built into the entity
- Playlist support for *.pls, *.m3u, *.json and *.vdf
- Playlist support for these addons:
- [Web Radio][]
- Model support for these addons:
- [\[NM\] Prop Pack][NM Prop Pack]
- [Fallout 3 Jukebox Model][]
- [Minecraft SWEP][]
- [KanKan Radio II & Kresopolski Radio][]
- [ZENITH Trans-Oceanic H500][]
- Build-in playlist editor
- [Wiremod][] support (inputs and outputs, advanced wiremod support when the optional [gm_bass3][GM_BASS3] is installed on the server.)
- 3D world sound, which can be turned off
- Customizable GUI colors
- Multiple radio models
- FFT Spectrum visualizer and music animated models
- [CPPI][] support
- Duplicator support
- Supports local files (inside the ".../garrysmod/sound/" folder)
- Clientside performance settings
- Server settings for admins
- [Serverside URL Whitelist][]
- [CFC Client HTTP Whitelist][] support
- An API for developers
# Credits
- Code: Grocel
- Models: SligWolf
# License
<a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International License</a>.
[Garry's Mod]: <http://garrysmod.com/>
[Wiremod]: <https://github.com/wiremod/wire>
[GM_BASS3]: <https://github.com/Grocel/GMod_Modules/tree/master/gm_bass3>
[workshop]: <https://steamcommunity.com/sharedfiles/filedetails/?id=246756300>
[Web Radio]: <https://steamcommunity.com/sharedfiles/filedetails/?id=314470705>
[NM Prop Pack]: <https://steamcommunity.com/sharedfiles/filedetails/?id=605223544>
[Fallout 3 Jukebox Model]: <https://steamcommunity.com/sharedfiles/filedetails/?id=529954000>
[Minecraft SWEP]: <https://steamcommunity.com/sharedfiles/filedetails/?id=116592647>
[KanKan Radio II & Kresopolski Radio]: <https://steamcommunity.com/sharedfiles/filedetails/?id=246756300>
[ZENITH Trans-Oceanic H500]: <https://steamcommunity.com/sharedfiles/filedetails/?id=1652510511>
[CPPI]: <http://ulyssesmod.net/archive/CPPI_v1-3.pdf>
[Serverside URL Whitelist]: <https://github.com/Grocel/3D-Stream-Radio/wiki/Whitelisting-of-online-content>
[CFC Client HTTP Whitelist]: <https://github.com/Grocel/3D-Stream-Radio/wiki/CFC-Client-HTTP-Whitelist-integration>