Difference between revisions of "Hyperradio js OXP"

From Elite Wiki
m
m (→‎Download: Tweak!)
 
(64 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
===OVERVIEW===
  
  +
{{Infobox EquipStats Oolite| title = Hyperradio
  +
|image = [[Image:Hyperradio.png|80px]]
  +
|equipName = EQ_HYPER_RADIO
  +
|equipCost = 1.200
  +
|equipTL = 7
  +
}}
  +
==Overview==
  +
{{OXPNote|This AddOn is deprecated. Please use [[Library]] for new AddOns}}
  +
Trading goods between worlds is an extremely dangerous and hard job and a commander will need some relaxing moments. Listen to your radio station and enjoy Jazz, Folk, Rock or whatever you like. Use one station for all systems or expand it, so you will get different programs in different systems. You can even add your own music to the playlist. So rip your CDs, download songs, or install one or more of the available [[Hyperradio_Musicpacks|musicpacks]]. Everything is possible - and travelling will be much more fun - even 'milkruns' won't be boring business anymore. And with the capacity to be expanded by other users creating their own musicpacks it will always be the right investment.
   
−
----
  
  +
Additionally Frame has created a nice oxp for [[Random_Docking_Music_OXP|random docking music]].
   
−
I've often missed some background music while playing Oolite. Yes, it was possible to use other software<br>
  
  +
==Handling==
−
for this (like Winamp, iTunes,...), but that's not the way it should be. Oolite was a little bit 'incomplete'.
  
  +
Adding own songs to the main playlist of the Hyperradio is simple. Please note that only ogg-vorbis is supported by Oolite.
   
−
That was yesterday.
  
  +
1. Just place your soundfiles in the OXPs Music-folder.<br>
  +
2. Open hyperradio.js in the Scripts-folder (you can use a simple text-editor) and add your filenames to the array.<br>
  +
Example:
  +
this.hyperradio_playListOriginal = [
  +
"Rage-Back_in_time.ogg",
  +
"Stevie_Ray_Vaughan-Voodoo_Child.ogg"
  +
];
  +
Save your additions. That's it.
   
−
Note:
  
  +
3. Fire up Oolite and buy the Hyperradio license (it is not everywhere available).
−
Oolite v1.71 has some new sound/music functionality, so the Hyperradio will get some new features.<br>
  
  +
* Launch from the station and select it via priming key (Shift + N).
−
The latest version v1.04 is just a compatibility version with Oolite v1.71, because the engine has changed<br>
  
  +
* Select the station via activation key (n). You can cycle through the available stations.
−
a little bit. So stay tuned...
  
  +
* To start playing a station press the mode key (b).
   
−
===HANDLING===
  
  +
To get some more complexity it is possible to use different 'stations' with different playlists. There are a few [[Hyperradio_Musicpacks|musicpacks]] already available for you.
−
----
  
−
- Step 1: Just place your soundfiles (.ogg or .wav -> see list of formats) in the OXPs Sounds-folder.<br\>
  
−
- Step 2: Open descriptions.plist in the Config-folder (you can use a simple text-editor)
  
−
and add your filenames to the array.
  
   
−
Example (old form):<br>
  
  +
If you are using one or more of the available musicpacks the Hyperradio preselects one of them or the main list.
−
<key>hyperradio_songlist</key>
  
−
<array>
  
−
<string>example.ogg</string>
  
−
<string>my_first_sound.ogg</string>
  
−
<string>my_second_sound.ogg</string>
  
−
<string>My_first_music.ogg</string>
  
−
<string>my_second_music.ogg</string>
  
−
</array>
  
   
−
Example2 (new form):<br>
  
  +
Documentation about creating own stations is available at the [[Hyperradio_Howto_Musicpacks|HowTo make a own station]] page.
−
hyperradio_songlist =
  
−
(
  
−
"example.ogg",
  
−
"example2.ogg",
  
−
"my_song.ogg",
  
−
"my_next_song.ogg" // Note that the last entry does not have a commata at the end
  
−
);
  
   
−
Please note that the OpenStep-Architecture (example2) is used in all new versions.
  
  +
==Infos==
  +
{{OXPConfig-small}}
  +
The Hyperradio is your personal tool for playing music in the game. Before it was a bit tedious to run other applications (like Winamp) for this case, because these music-players are not really connected to Oolite and the user doesn't have control about it (or has to switch to this application). The Hyperradio jumps in here to play your songs and reacts on changes in Oolite.
   
−
Save your additions. That's it. Totaly easy.
  
  +
Additionally it is compatible and configurable via [[OXPConfig|OXPConfig2]] and [[Repair_Bots|Repair Bots]].
   
−
- Step 3: Fire up Oolite. Buy the Hyperradio (if you can), launch from the station and press F7 (SYSTEM_DATA_SCREEN) and step back to the cockpit view (F1). When the song is over... F7, back to F1,...
  
  +
Hyperradio can be configured (OXPConfig2 or editing):
  +
* '''logging''': en/disables the extended logging. Default false.
  +
* '''mergePacks''': en/disables copying musicpacks in mainlist. Default true.
  +
* '''podMusic''': en/disables playing a short sample when player ejects. Default true.
  +
* '''onlyMain''': en/disables using only the main playlist. Default false.
   
−
!!!! Because of the handling of variables in Java-Script don't use filenames with a leading zero or other numerics.<br>
  
  +
* Extended features - if [[Snoopers|Snoopers2.4]] is installed
   
−
Example:<br>
  
  +
==Requirements==
−
01.ogg -> interpreted as 1 (without 0 and .ogg) does not work
  
  +
* The latest version needs Oolite v1.77.
−
a0.ogg -> interpreted as a0.ogg works
  
  +
* [[Cabal_Common_Library|Cabal_Common_Library1.7]]
−
So the best would be to use a syntax like:
  
  +
* [[Snoopers|Snoopers2.4]] or [[Hyperradio_Musicpacks|musicpacks]] to enable extra functions.
−
artist-songname.ogg
  
−
Tchaikovsky-Swan_Lake_Act_II_Scene_Moderato.ogg
  
−
Leon_Willett-Dreamfall.ogg
  
   
−
===DOWNLOAD===
 +
==Download==
−
----
 +
* Downloadable through the in-game [[Expansions Manager]]
−
There are 3 different version available:<br>
 +
* [http://deephorizonindustries.com/Downloads/Hyperradio1.26.1.zip Hyperradio1.26.1.zip] (741 KB).
−
Don't use them together, because they are using the same namespaces and variables.
 +
* Download in OXZ format [[Media:Hyperradio_1.26.1.oxz|here]] for Oolite 1.79 or later (downloaded {{#downloads:Hyperradio_1.26.1.oxz}} times).
   
−
[[Media:Hyperradio_1_04.zip | Hyperradio_1_04.zip]] (405 KB)<br>
  
  +
For Oolite v1.76.1:
−
This version runs ONLY under Oolite v1.71!<br> It uses Java-Script and has some functionallity that can't be done with the old legacy scripting method.
  
  +
* [http://deephorizonindustries.com/Downloads/Hyperradio1.25.zip Hyperradio1.25.zip] (742 KB).
   
−
[[Media:Hyperradio_1_03.zip | Hyperradio_1_03.zip]] (405 KB)<br>
  
  +
==See Also==
−
This version runs ONLY under Oolite v1.70!<br> It uses Java-Script and has some functionallity that can't be done with the old legacy scripting method.
  
  +
[[Hyperradio_Musicpacks]]<br>
  +
[[Hyperradio_Howto_Musicpacks]]<br>
  +
[[Random_Docking_Music_OXP|Random docking music]]
   
−
[[Media:Hyperradio_legacy_1_00.zip | Hyperradio_legacy_1_00.zip]] (405 KB)<br>
  
  +
==Quick Facts==
−
This version runs on Oolite v1.65 - v1.70.<br>
  
  +
{{OXPLevel|0}}{{IconOXP
−
[[#top | top]]
  
  +
|ooVersion = "1.77"
  +
|oxpCPU = "Average"
  +
|oxpMEM = "Average"
  +
|oxpGPU = "Low"
  +
|oxpIsParent = true
  +
|oxpIsChild = true
  +
|oxpIsAPI =
  +
|oxpIsDocumented = true
  +
|oxpIsConfigurable = true
  +
}}
  +
{{Infobox OXPb| title = Hyperradio
  +
|image = [[Image:Hyperradio.png|220px]]
  +
|version = 1.26.1
  +
|release = 2013-01-22
  +
|license = CC-by-nc-sa-3.0
  +
|features = Equipment, Music
  +
|category = Equipment OXPs
  +
|author = Svengali
  +
|download = [[#Download|See Download]]
  +
|feedback = [http://aegidian.org/bb/viewtopic.php?f=4&t=4067 BB-Link]
  +
}}
   
−
===TESTED FORMATS===
  
  +
{{Required OXP|Cabal Common Library}}
−
----
  
  +
{{Required OXP|Snoopers}}
−
This is a list of all formats that have been tested for the Hyperradio. Working formats are marked with YES, not working formats as no.<br>Thanks to all users who have sent in reports.
  
   
−
{| width="100%" style="border: .5px solid #cfcfbf; padding: 1em 1em 1em; color: #000000; background-color: #f7f7f7; vertical-align: top; text-align: left;"
  
  +
[[Category:Deprecated OXPs]]
−
|+ '''22.05KHz - 96KHz, Mono and Stereo'''
  
−
! Format !! Header !! WIN !! MAC !! LINUX
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| ogg
  
−
| Ogg-vorbis
  
−
| YES
  
−
| YES
  
−
| YES
  
−
|-valign="top"
  
−
| raw
  
−
| headerless A-Law
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| raw
  
−
| headerless U-Law
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| raw
  
−
| headerless 16-Bit DWVW
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| raw
  
−
| headerless 24-Bit DWVW
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| raw
  
−
| Signed 16-Bit PCM
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| raw
  
−
| Signed 24-Bit PCM
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| raw
  
−
| Signed 32-Bit PCM
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| raw
  
−
| 32-Bit Float
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| raw
  
−
| 64-Bit Float
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| wav
  
−
| MS Signed 16-Bit PCM
  
−
| YES
  
−
| no
  
−
| YES
  
−
|-valign="top"
  
−
| wav
  
−
| MS 4-Bit ADPCM
  
−
| YES
  
−
| no
  
−
| YES
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| wav
  
−
| MS 4-Bit IMA ADPCM
  
−
| YES
  
−
| no
  
−
| YES
  
−
|-valign="top"
  
−
| wav
  
−
| MS 32-Bit Float
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| wav
  
−
| MS 64-Bit Float
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| wav
  
−
| MS U-Law
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| wav
  
−
| MS A-Law
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| wav
  
−
| MS Signed 24-Bit PCM
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| wav
  
−
| MS Signed 32-Bit PCM
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| wav
  
−
| MS 32kbs G721 ADPCM
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| wav
  
−
| MS GSM 6.10
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| wav
  
−
| NIST A-Law
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| wav
  
−
| NIST U-Law
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| wav
  
−
| NIST Signed 16-Bit PCM
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top" bgcolor="#e7e7ff"
  
−
| wav
  
−
| NIST Signed 24-Bit PCM
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top"
  
−
| wav
  
−
| NIST Signed 32-Bit PCM
  
−
| no
  
−
| no
  
−
| no
  
−
|-valign="top" bgcolor="#e7e7ff"
  
−
| flac
  
−
| 16-Bit L5
  
−
| no
  
−
| no
  
−
| no
  
−
|--valign="top"
  
−
| flac
  
−
| 24-Bit L5
  
−
| no
  
−
| no
  
−
| no
  
−
|}
  
−  
−
Tested Systems: LINUX UBUNTU, MAC OS X, WIN 2000 and WIN XP.<br><br>
  
−
Not included formats:
  
−
AIFF, AU, AVR, CAF, HTK, IFF, MAT4, MAT5, MP3, OKI, PAF, PVF, SD2, SDS, SF, VOC, W64, WAVEX, XI and MS 8-Bit PCM.wav<br>
  
−
[[#top | top]]
  
−  
−
===NOTES===
  
−
----
  
−
Using IN_GAME_MUSIC is a special thing. Currently it is possible to use the Ogg-Vorbis (.ogg) and Wave (.wav) -format. This file should not contain more than two channels, because Oolite does not support any surround-audio-files. It seems that Oolite reduces these files to stereo. And various kbps are handled by using a average kbps-rate.<br><br>
  
−
Creating background music:<br>
  
−
The background music '''max''' db should be between -12 and -8 db, because a lot of players are using customsound-OXPs and the player should hear if something happens. And the new functionallity of Oolite will cause that more and more OXPs will use their own sounds. That means that sounds (like laser fire) should be between -6 and -3 db at a max. Higher values can result in digital clipping, but if you are familiar with mastering you can use higher values, but better not.<br>
  
−
[[#top| top]]
  

Latest revision as of 11:22, 3 June 2021

Hyperradio
Hyperradio.png
Name EQ_HYPER_RADIO
Cost 1.200
TL Availability 7

Overview

Mr Gimlet.png

Please note:   This AddOn is deprecated. Please use Library for new AddOns.

Trading goods between worlds is an extremely dangerous and hard job and a commander will need some relaxing moments. Listen to your radio station and enjoy Jazz, Folk, Rock or whatever you like. Use one station for all systems or expand it, so you will get different programs in different systems. You can even add your own music to the playlist. So rip your CDs, download songs, or install one or more of the available musicpacks. Everything is possible - and travelling will be much more fun - even 'milkruns' won't be boring business anymore. And with the capacity to be expanded by other users creating their own musicpacks it will always be the right investment.

Additionally Frame has created a nice oxp for random docking music.

Handling

Adding own songs to the main playlist of the Hyperradio is simple. Please note that only ogg-vorbis is supported by Oolite.

1. Just place your soundfiles in the OXPs Music-folder.
2. Open hyperradio.js in the Scripts-folder (you can use a simple text-editor) and add your filenames to the array.
Example: 

 this.hyperradio_playListOriginal = [
   "Rage-Back_in_time.ogg",
   "Stevie_Ray_Vaughan-Voodoo_Child.ogg"
 ];

Save your additions. That's it.

3. Fire up Oolite and buy the Hyperradio license (it is not everywhere available).

  • Launch from the station and select it via priming key (Shift + N).
  • Select the station via activation key (n). You can cycle through the available stations.
  • To start playing a station press the mode key (b).

To get some more complexity it is possible to use different 'stations' with different playlists. There are a few musicpacks already available for you.

If you are using one or more of the available musicpacks the Hyperradio preselects one of them or the main list.

Documentation about creating own stations is available at the HowTo make a own station page.

Infos

OXPConfig compatible.png

The Hyperradio is your personal tool for playing music in the game. Before it was a bit tedious to run other applications (like Winamp) for this case, because these music-players are not really connected to Oolite and the user doesn't have control about it (or has to switch to this application). The Hyperradio jumps in here to play your songs and reacts on changes in Oolite.

Additionally it is compatible and configurable via OXPConfig2 and Repair Bots.

Hyperradio can be configured (OXPConfig2 or editing):

  • logging: en/disables the extended logging. Default false.
  • mergePacks: en/disables copying musicpacks in mainlist. Default true.
  • podMusic: en/disables playing a short sample when player ejects. Default true.
  • onlyMain: en/disables using only the main playlist. Default false.

Requirements

Download

For Oolite v1.76.1:

See Also

Hyperradio_Musicpacks
Hyperradio_Howto_Musicpacks
Random docking music

Quick Facts

Levelindicator0.png
0-{{{2}}}

Minimum Oolite versionCPU usage averageMemory usage averageGPU usage lowisParentisChildisDocumentedisConfigurable

Version Released License Features Category Author(s) Feedback
1.26.1 2013-01-22 CC-by-nc-sa-3.0 Equipment, Music Equipment OXPs Svengali BB-Link
Retrieved from "http://backup.witchspacewiki.org/index.php?title=Hyperradio_js_OXP&oldid=65952"