Sound - Revision history

DeamonHunter: Add new properties and update formatting.

2017-11-17T06:01:23Z

Add new properties and update formatting.

DeamonHunter: Visually space slightly more

2017-07-19T02:44:20Z

Visually space slightly more

DeamonHunter: Remove ambience component. Update formatiing and use more up to date sets.

2017-07-19T02:20:19Z

Remove ambience component. Update formatiing and use more up to date sets.

Show changes

DeamonHunter: Another change to random pitch

2017-02-10T10:05:38Z

Another change to random pitch

DeamonHunter: /* "randomVolume" */

2017-02-10T09:56:52Z

‎"randomVolume"

DeamonHunter: Added clarifications and missing variable

2017-02-10T09:56:10Z

Added clarifications and missing variable

DeamonHunter: /* Compressing Sounds */ Readibility and clarification

2017-02-10T09:33:04Z

‎Compressing Sounds: Readibility and clarification

DeamonHunter: Add ambience.

2017-02-10T09:20:24Z

Add ambience.

DeamonHunter: /* "ambience" */

2017-02-10T08:57:56Z

‎"ambience"

DeamonHunter: Complete more of the basic config options

2017-02-10T08:15:32Z

Complete more of the basic config options

@@ Line 69: / Line 69: @@
 = Config Options =
 == "code" ==
-'''Valid options (String): <code>A unique string which sound what this object is.</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A unique string which sound what this object is.</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 93: / Line 93: @@
 Each set contains the values below.
 === "file" ===
-'''Valid options (String): <code>A string which contains the path to an audio file. Do not include ".wav", ".ogg" or ".wav.csr".</code>'''
+'''Valid options ([[Modding_Key_Terms#String|String]]): <code>A string which contains the path to an audio file. Do not include ".wav", ".ogg" or ".wav.csr".</code>'''
 '''Default Value:''' No default value is specified. Always need to provide your own.
@@ Line 107: / Line 119: @@
 === "randomPitch" ===
-'''Valid options (Vector 2 - Float): <code>{"x":-1.0, "y":1.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 2|Vector 2]] - [[Modding_Key_Terms#Float|Float]]): <code>{"x":-1.0, "y":1.0}</code>'''
-'''Default Value:''' Can be omitted. If not specified, then pitch will not vary.
+'''Default Value:''' If not specified, then pitch will not vary.
 This option tells the game exactly to play the sound at a random pitch between two points, x (min) and y (max).
@@ Line 115: / Line 127: @@
 === "randomVolume" ===
-'''Valid options (Vector 2 - Float): <code>{"x":0.0, "y":1.0}</code>'''
+'''Valid options ([[Modding_Key_Terms#Vector 2|Vector 2]] - [[Modding_Key_Terms#Float|Float]]): <code>{"x":0.0, "y":1.0}</code>'''
 '''Default Value:''' If this is specified, "volume" cannot be used. Only one of the two can, and must, be specified.
@@ Line 123: / Line 135: @@
 === "volume" ===
-'''Valid options (Float): <code>A value between 0.0 and 1.0.</code>'''
+'''Valid options ([[Modding_Key_Terms#Float|Float]]): <code>A value between 0.0 and 1.0.</code>'''
 '''Default Value:''' If "randomVolume" is specified, this cannot be used. Only one of the two can, and must, be specified.

← Older revision		Revision as of 02:44, 19 July 2017
Line 54:		Line 54:

	You can compress your file by simply heading to <code>gamedata/bin/</code> and start up '''<code>Staxel.ContentBuilder.exe</code>'''. When this has started up, click '''<tt>Compress .wav assests</tt>''', wait a moment and then click '''<tt>Validate Resources</tt>''' and wait until the progress bar has done. Now all the sound assests you added are compressed and will still run in staxel.		You can compress your file by simply heading to <code>gamedata/bin/</code> and start up '''<code>Staxel.ContentBuilder.exe</code>'''. When this has started up, click '''<tt>Compress .wav assests</tt>''', wait a moment and then click '''<tt>Validate Resources</tt>''' and wait until the progress bar has done. Now all the sound assests you added are compressed and will still run in staxel.
		+


Line 63:		Line 64:

	For more information on how to use the ambience component, head to [[Ambience Component#When and How to use]].		For more information on how to use the ambience component, head to [[Ambience Component#When and How to use]].
		+

@@ Line 97: / Line 97: @@
 Each set contains the values below.
 === "file" ===
@@ Line 104: / Line 105: @@
 For example: Having the file name <code> "mods/testsound/sound1"</code> look for an object that is either "mods/testsound/sound1.wav", "mods/testsound/sound1.ogg" or "mods/testsound/sound1.wav.csr" depending on context.
 === "volume" ===
@@ Line 111: / Line 113: @@
 This option tells the game exactly how loud to play the sound.
 === "randomVolume" ===
-'''Valid options (vector): <code>A vector set with two values between 0.0 and 1.0.</code>'''
+'''Valid options (vector 2D): <code>A vector set with two values that are between 0.0 and 1.0.</code>'''
 '''Mutally exlusive from "volume" option. Cannot have volume and randomVolume at the same time for a single file.'''
@@ Line 124: / Line 127: @@
+}
 </pre>
 === "randomPitch" ===
-'''Valid options (float): <code>A value to multiply base value that is between 0.0 and 1.0.</code>'''
+'''Valid options (vector 2D): <code>A vector set with two values that are between -1.0 and 1.0.</code>'''
 == "ambience" ==

@@ Line 115: / Line 115: @@
 '''Valid options (vector): <code>A vector set with two values between 0.0 and 1.0.</code>'''
-'''Mutally exlusive from "randomVolume" option. Cannot have volume and randomVolume at the same time for a single file.'''
+'''Mutally exlusive from "volume" option. Cannot have volume and randomVolume at the same time for a single file.'''
 This option tells the game exactly to play the sound at a random volume between two points, x (min) and y (max). The vector can be created as so;

@@ Line 108: / Line 108: @@
 '''Valid options (float): <code>A value between 0.0 and 1.0.</code>'''
-'''Mutally exlusive from "randomVolume" option. Do not include both in the same set'''
+'''Mutally exlusive from "randomVolume" option. Cannot have volume and randomVolume at the same time for a single file.'''
 This option tells the game exactly how loud to play the sound.
@@ Line 115: / Line 115: @@
 '''Valid options (vector): <code>A vector set with two values between 0.0 and 1.0.</code>'''
-'''Mutally exlusive from "randomVolume" option. Do not include both in the same set'''
+'''Mutally exlusive from "randomVolume" option. Cannot have volume and randomVolume at the same time for a single file.'''
 This option tells the game exactly to play the sound at a random volume between two points, x (min) and y (max). The vector can be created as so;
@@ Line 124: / Line 124: @@
+}
 </pre>
 == "ambience" ==
@@ Line 170: / Line 175: @@
 === "distance" ===
-'''Valid options (float): <code>A value of distance from the player to the sound</code>'''
+'''Valid options (float): <code>A value of distance from the player to the sound.</code>'''
 The amount of space between the player and the sound. This will end up changing volume and other things.
 === "distanceVariance" ===
-'''Valid options (float): <code>A value to add to base value.</code>'''
+'''Valid options (float): <code>A value for the variance of the distance.</code>'''
-The amount the played sounds pitch will change between plays of the sound.
+The range of distance, -"distanceVariance" to "distanceVariance", around the distance that the sound is emitted

@@ Line 49: / Line 49: @@
 = Compressing Sounds =
-Staxel also has the option to compress these files to save space but not lose quality. Before doing this, you will want to make sure you have a backup of the sound file, as it will be overwritten. You can compress your file by simply heading to <code>gamedata/bin/</code> and start up '''<code>Staxel.ContentBuilder.exe</code>'''.  When this has started up, click '''<tt>Compress .wav assests</tt>''', wait a moment and then click '''<tt>Validate Resources</tt>''' and wait until the progress bar has done. Now all the sound assests you added are compressed and will still run in staxel.
+Staxel also has the option to compress these files to save space but not lose quality. These files will be played back the same as any normal '''<tt>*.wav</tt>''' file, but will take up much less space than even a zipped file.
 = Config Options =

@@ Line 123: / Line 123: @@
 == "ambience" ==
-Will need to get information on how exactly it is used.
+Ambience is used when a weather file specifies what set of sounds to be used during day or night. Specifing this is the file, will allow you to control what these values are rather than using the default values.
 <pre>
 "ambience" : {
@@ Line 139: / Line 140: @@
 === "frequency" ===
-'''Valid options (Int): <code>A valid interger number for the number of milliseconds between plays./code>'''
+'''Valid options (Int): <code>A valid interger number for the number of milliseconds between plays.</code>'''
-This is the amount of time between two plays of the soundgroup.
+This is the amount of time between two plays of the sounds in the group.
 === "freqVariance" ===
-'''Valid options (Int): <code>A valid interger number for the variance of the number of milliseconds between plays./code>'''
+'''Valid options (Int): <code>A valid interger number for the variance of the number of milliseconds between plays.</code>'''
 This is the range, -"freqVariance" to "freqVariance", around the base frequency that the sound will be played at.
 === "volume" ===

← Older revision		Revision as of 08:57, 10 February 2017
Line 123:		Line 123:

	== "ambience" ==		== "ambience" ==
−	~~Currently getting~~ information	+	Will need to get information on how exactly it is used.
		+
		+	Ambience is a single set of values which are then passed on to player to create a new sound based certain settings. It can be made as:
		+	<pre>
		+	"ambience" : {
		+	"frequency" : 800,
		+	"volume" : 1.0,
		+	"volumeVariance" : 0.0,
		+	"freqVariance" : 400,
		+	"pitchVariance" : 0.5,
		+	"distance" : 10.0,
		+	"distanceVariance" : 20.0
		+	}
		+	</pre>
		+
		+	=== "frequency" ===
		+	'''Valid options (Int): <code>A valid interger number for the number of milliseconds between plays./code>'''
		+
		+	This is the amount of time between two plays of the soundgroup.
		+
		+	=== "freqVariance" ===
		+	'''Valid options (Int): <code>A valid interger number for the variance of the number of milliseconds between plays./code>'''
		+
		+	This is the range, -"freqVariance" to "freqVariance", around the base frequency that the sound will be played at.
		+
		+	=== "volume" ===

@@ Line 46: / Line 46: @@
 Once this line is added in, head to <code>gamedata/bin/</code> and start up '''<code>Staxel.ContentBuilder.exe</code>'''. When this has started up, click '''<tt>Validate Resources</tt>''' and wait until the progress bar has done. Now you can load up and hear your sound whenever you walk over your object.
 = Compressing Sounds =
 Staxel also has the option to compress these files to save space but not lose quality. Before doing this, you will want to make sure you have a backup of the sound file, as it will be overwritten. You can compress your file by simply heading to <code>gamedata/bin/</code> and start up '''<code>Staxel.ContentBuilder.exe</code>'''.  When this has started up, click '''<tt>Compress .wav assests</tt>''', wait a moment and then click '''<tt>Validate Resources</tt>''' and wait until the progress bar has done. Now all the sound assests you added are compressed and will still run in staxel.
 = Config Options =
@@ Line 68: / Line 70: @@
 And then have the line <code> "_inherit" : "FilePathHere/file.config"</code> in your file, it will automatically pull any data from the inherited file, but then replace values in that file with the values above.
 == "code" ==
@@ Line 76: / Line 79: @@
 For example: Having the code <code> "mods.testsound.soundgroup1"</code> creates an object that has the handle "mods.testsound.soundgroup1"
 == "sound" ==