Difference between revisions of "Hyperradio js OXP"

From Elite Wiki
m (Test results updated)
m
Line 10: Line 10:
 
===HANDLING===
 
===HANDLING===
 
----
 
----
Just place your soundfiles (.ogg or .wav) in the OXPs Sounds-folder.<br\>
+
- Step 1: Just place your soundfiles (.ogg or .wav -> see list of formats) in the OXPs Sounds-folder.<br\>
Open descriptions.plist in the Config-folder (you can use a simple text-editor)
+
- Step 2: Open descriptions.plist in the Config-folder (you can use a simple text-editor)
 
and add your filenames to the array.
 
and add your filenames to the array.
  
Example:<br>
+
Example (old form):<br>
 
   <key>hyperradio_songlist</key>
 
   <key>hyperradio_songlist</key>
 
     <array>
 
     <array>
Line 23: Line 23:
 
       <string>my_second_music.ogg</string>
 
       <string>my_second_music.ogg</string>
 
     </array>
 
     </array>
 +
 +
Example2 (new form):<br>
 +
  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.
 +
 
Save your additions. That's it. Totaly easy.
 
Save your additions. That's it. Totaly easy.
  
Step to the game. Buy the Hyperradio, launch from the station and press F7 (SYSTEM_DATA_SCREEN)<br>
+
- 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,...
and step back to the cockpit view (F1). When the song is over... F7, back to F1,...
 
  
 
!!!! Because of the handling of variables in Java-Script don't use filenames with a leading zero or other numerics.<br>
 
!!!! Because of the handling of variables in Java-Script don't use filenames with a leading zero or other numerics.<br>
Line 43: Line 54:
 
Don't use them together, because they are using the same namespaces and variables.
 
Don't use them together, because they are using the same namespaces and variables.
  
[[Media:Hyperradio_js_1_02.zip | Hyperradio_js_1_02.zip]] (406 KB)<br>
+
[[Media:Hyperradio_1_03.zip | Hyperradio_1_03.zip]] (405 KB)<br>
 
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.
 
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.
  

Revision as of 21:38, 27 March 2008

OVERVIEW


I've often missed some background music while playing Oolite. Yes, it was possible to use other software
for this (like Winamp, iTunes,...), but that's not the way it should be. Oolite was a little bit 'incomplete'.

That was yesterday.

HANDLING


- 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):

 <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):

 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.

Save your additions. That's it. Totaly easy.

- 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,...

!!!! Because of the handling of variables in Java-Script don't use filenames with a leading zero or other numerics.

Example:

   01.ogg -> interpreted as 1 (without 0 and .ogg)	does not work
   a0.ogg -> interpreted as a0.ogg			works
   So the best would be to use a syntax like:
   artist-songname.ogg
   Tchaikovsky-Swan_Lake_Act_II_Scene_Moderato.ogg
   Leon_Willett-Dreamfall.ogg

DOWNLOAD


There are 2 different version available:
Don't use them together, because they are using the same namespaces and variables.

Hyperradio_1_03.zip (405 KB)
This version runs ONLY under Oolite v1.70!
It uses Java-Script and has some functionallity that can't be done with the old legacy scripting method.

Hyperradio_legacy_1_00.zip (405 KB)
This version runs on Oolite v1.65 - v1.70.
top

TESTED FORMATS


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.
Thanks to all users who have sent in reports.

22.05KHz - 96KHz, Mono and Stereo
Format Header WIN MAC LINUX
ogg Ogg-vorbis YES YES YES
raw headerless A-Law no no no
raw headerless U-Law no no no
raw headerless 16-Bit DWVW no no no
raw headerless 24-Bit DWVW no no no
raw Signed 16-Bit PCM no no no
raw Signed 24-Bit PCM no no no
raw Signed 32-Bit PCM no no no
raw 32-Bit Float no no no
raw 64-Bit Float no no no
wav MS Signed 16-Bit PCM YES no YES
wav MS 4-Bit ADPCM YES no YES
wav MS 4-Bit IMA ADPCM YES no YES
wav MS 32-Bit Float no no no
wav MS 64-Bit Float no no no
wav MS U-Law no no no
wav MS A-Law no no no
wav MS Signed 24-Bit PCM no no no
wav MS Signed 32-Bit PCM no no no
wav MS 32kbs G721 ADPCM no no no
wav MS GSM 6.10 no no no
wav NIST A-Law no no no
wav NIST U-Law no no no
wav NIST Signed 16-Bit PCM no no no
wav NIST Signed 24-Bit PCM no no no
wav NIST Signed 32-Bit PCM no no no
flac 16-Bit L5 no no no
flac 24-Bit L5 no no no

Tested Systems: LINUX UBUNTU, MAC OS X, WIN 2000 and WIN XP.

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
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.

Creating background music:
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.
top