Hpl2:HPL2/Tutorials/CustomSounds - Revision history

Darkfire: fix header error

2024-04-13T15:03:43Z

fix header error

Mrbehemo at 17:33, 5 January 2024

2024-01-05T17:33:01Z

Mrbehemo at 12:17, 5 January 2024

2024-01-05T12:17:51Z

Mrbehemo: Mrbehemo moved page Hpl2:Tutorials:script:CustomSounds to Hpl2:HPL2/Tutorials/CustomSounds: Correct path format

2024-01-05T12:14:43Z

Mrbehemo moved page Hpl2:Tutorials:script:CustomSounds to Hpl2:HPL2/Tutorials/CustomSounds: Correct path format

Mrbehemo: Improved .snt properties descriptions. Created a "basics" and "advanced" section.

2024-01-05T12:13:04Z

Improved .snt properties descriptions. Created a "basics" and "advanced" section.

Mrbehemo: Changed details of "Random" property.

2024-01-05T11:12:16Z

Changed details of "Random" property.

Darkfire: /* Preparing the sounds */ link fix

2020-11-02T17:09:13Z

Preparing the sounds: link fix

Darkfire: Some rewrites

2020-11-02T17:06:38Z

Some rewrites

Darkfire: Some clean up

2020-07-24T13:23:29Z

Some clean up

Darkfire: Darkfire moved page Hpl2:Tutorials:script:page to Hpl2:Tutorials:script:CustomSounds without leaving a redirect: Generic location

2020-07-24T12:40:09Z

Darkfire moved page Hpl2:Tutorials:script:page to Hpl2:Tutorials:script:CustomSounds without leaving a redirect: Generic location

← Older revision		Revision as of 15:03, 13 April 2024
Line 95:		Line 95:


−	=Adding custom music==	+	==Adding custom music==

	Custom music only needs to be a file in the '''.ogg''' format. It won't need an '''.snt''' file to be played with <code>PlayMusic();</code> or at the credits, but you won't be able to use <code>PlaySoundAtEntity();</code> with this file.		Custom music only needs to be a file in the '''.ogg''' format. It won't need an '''.snt''' file to be played with <code>PlayMusic();</code> or at the credits, but you won't be able to use <code>PlaySoundAtEntity();</code> with this file.

← Older revision		Revision as of 17:33, 5 January 2024
Line 88:		Line 88:

	* '''FadeEnd''' and '''FadeStart''', if true, will cause looping sounds to fade in or out on their first or last repetition.		* '''FadeEnd''' and '''FadeStart''', if true, will cause looping sounds to fade in or out on their first or last repetition.
−
−	* '''Blockable''' and '''BlockVolumeMul''' were probably intended to define how the sound can interact with world geometry, but they do not seem to be implemented in the engine.

	* '''Blockable''', '''BlockVolumeMul''', and '''Priority''' do not seem to be implemented in the engine. ''('''Blockable''' and '''BlockVolumeMul''' may have been intended to define how the sounds are muffled by world geometry, and '''Priority''' may have been intended to be used when culling sounds. Although all three properties are read from the .snt file, they do not seem to be referenced in any other code.)'' {{confirm}}		* '''Blockable''', '''BlockVolumeMul''', and '''Priority''' do not seem to be implemented in the engine. ''('''Blockable''' and '''BlockVolumeMul''' may have been intended to define how the sounds are muffled by world geometry, and '''Priority''' may have been intended to be used when culling sounds. Although all three properties are read from the .snt file, they do not seem to be referenced in any other code.)'' {{confirm}}

@@ Line 81: / Line 81: @@
 <syntaxhighlight lang="xml">Random="0.25" Interval="15" Loop="true"</syntaxhighlight>
-* '''Random''' does 'not' affect the random variant sounds listed in the .snt file. Those each have an equal chance of playing, although the engine will try to stop them from playing twice in a row if possible.
+* '''Random''' does ''not'' affect the random variant sounds listed in the .snt file. Those each have an equal chance of playing, although the engine will try to stop them from playing twice in a row if possible.
 * '''Use3D''' causes the sound to originate from a point in space, and move between the left and right stereo channels, but it is also required for attenuation. If '''Use3D''' is false, then the sound will have no stereo separation but it will also not fade over distance. Only mono sounds can be used as 3D. Stereo sounds retain the the left/right channel in the sound file and always behave as '''Use3d="false"'''.

@@ Line 50: / Line 50: @@
 <'''SOUNDS'''> indicates the sound list
-<'''Main'''> is the list of sounds the file will play. It is unsure if other categories exist.
+<'''Main'''> is the list of sounds the file will play.
 <'''Sound File'''="''YourFileName''.ogg" /> is the way to add a file to the sound. Adding multiple files will play them randomly.
-<'''PROPERTIES'''> Are all the options you may use to decide how the sound will behave in-game. Most important ones are:
+<'''PROPERTIES'''> Are all the options you may use to decide how the sound will behave in-game.
-*'''MinDistance''' is what distance you have to be in to hear it, since 1 is the players exact size, You will hear the sound perfectly if you stand on it. The sound will be heard with less and less volume until getting further than the distance specified in '''MaxDistance'''.
-*'''Random''' is used for looping sounds that have a random chance of repeating or not. Looping sounds with a Random value greater than 1 will always loop; 0.5 means they have a 50% chance of stopping. (This property is ''not'' connected to the list of random ".ogg" files - those all have an equal chance of playing, but the engine will try to stop them from being randomly selected multiple times in a row.)
-*'''Loop="False"''' - Make sure to change this to true if your sound should loop.
+==Properties==
-*'''Use3D="false"''' - Setting this as true will make the sound fade if the player rotates right and left from the sound origin. Using false will only use the distance to fade the sound.{{confirm}}
-{{warning|Stereo files will never work with this! The file needs to be mixed into a mono track to use this parameter. Also keep in minds stereo doesn't fade with distance.}}
+===The basics===
 Well thats it! You now created your very own sound! Place it in the map with the Level Editor or use it with <code>PlaySoundAtEntity();</code> in your level script (check [http://wiki.frictionalgames.com/hpl2/amnesia/script_functions Engine scripts] for details).
 = Adding custom music =
 Custom music only needs to be a file in the '''.ogg''' format. It won't need an '''.snt''' file to be played with <code>PlayMusic();</code> or at the credits, but you won't be able to use <code>PlaySoundAtEntity();</code> with this file.

@@ Line 56: / Line 56: @@
 <'''PROPERTIES'''> Are all the options you may use to decide how the sound will behave in-game. Most important ones are:
 *'''MinDistance''' is what distance you have to be in to hear it, since 1 is the players exact size, You will hear the sound perfectly if you stand on it. The sound will be heard with less and less volume until getting further than the distance specified in '''MaxDistance'''.
-*If you have multiple sounds, changing the '''Random="0"''' parameter to the number of sound files might be needed.{{confirm}}
+*'''Random''' is used for looping sounds that have a random chance of repeating or not. Looping sounds with a Random value greater than 1 will always loop; 0.5 means they have a 50% chance of stopping. (This property is ''not'' connected to the list of random ".ogg" files - those all have an equal chance of playing, but the engine will try to stop them from being randomly selected multiple times in a row.)
 *'''Loop="False"''' - Make sure to change this to true if your sound should loop.
 *'''Use3D="false"''' - Setting this as true will make the sound fade if the player rotates right and left from the sound origin. Using false will only use the distance to fade the sound.{{confirm}}

@@ Line 2: / Line 2: @@
 == Preparing the sounds ==
-First you'll need a sound-editting program; [https://www.audacityteam.org/ | Audacity] is a common choice - it is free and will suit most needs.
+First you'll need a sound-editting program; [https://www.audacityteam.org/ Audacity] is a common choice - it is free and will suit most needs.
 The sounds need to be in '''.ogg ''' format. If your sound files are formatted as '''.MP3''', '''.WAV''' or anything else, you need to use one your audio editing software of choice to convert your sound file to an '''.ogg''' file format. In Audacity, you just need to drag the file into the program and then export as '''.ogg'''.

@@ Line 1: / Line 1: @@
-{{cleanup|This article uses personal language and has poorly explained fragments and broken links.}}
+= Adding custom sounds =
 == Preparing the sounds ==
-First you'll need a sound-editting program, you can do this by using [http://www.erightsoft.com/S6Kg1.html|SUPER]] (Recommended) [http://audacity.sourceforge.net/download/|Audacity] or [[http://www.sonycreativesoftware.com/download/trials/vegaspro Sony Vegas] (Not free)
+First you'll need a sound-editting program; [https://www.audacityteam.org/ | Audacity] is a common choice - it is free and will suit most needs.
-The sounds need to be in '''.ogg ''' format, If your soundfiles are formatted as '''.MP3''', '''.WAV''' or anything else, you may use one of the said above programs to convert your soundfile of choice to an '''.ogg''' file format.
+The sounds need to be in '''.ogg ''' format. If your sound files are formatted as '''.MP3''', '''.WAV''' or anything else, you need to use one your audio editing software of choice to convert your sound file to an '''.ogg''' file format. In Audacity, you just need to drag the file into the program and then export as '''.ogg'''.
-For my example, my script file is called '''tutorial.txt''', and the sound is '''door.ogg'''.
+{{tip|It is recommended to use mono files. Stereo should only be used for music and ambient tracks, because it will play directly at the player rather than play in 3D.}}
-{{tip|It is recommended to use mono files. Stereo should only be used (but is not required) for music and ambient tracks.}}
+If you only want to play this sound as music, you can skip the next few steps and jump right to the custom music section.
 == Managing sound files ==
@@ Line 21: / Line 20: @@
 == Creating the sound entity file ==
-Create a '''.txt''' file and name it the name of your sound's Script, open it with any Text Editor you use. I use [http://wiki.frictionalgames.com/hpl2/third_party_tools/text/notepad?s[]=notepad Notepad++]. I named my file '''tutorial.txt'''.
+The behaviour of the sound in the game is determined by a "sound entity" file. These files have a '''.snt''' extension.
-{{tip|.txt might work, but it is recommended to give sound files the .snt extension used by the main game. This will allow your sound to be placed in a level without scripting. If using Notepad++, right-click them and pick Notepad++ to edit these files.}}
+For the fastest workflow, copy an existing sound file that works similarly to how you want and change its name. Then alter the contents of that file rather than writing them from scratch.
 In the file, you can edit quite a few things, and among them is..''Adding your sound-file into the script!'' And since my sound file is <u>'''door'''</u>'''.ogg''', It shall go to the '''MAIN''' section. Random soundfiles will be covered later on.
@@ Line 54: / Line 61: @@
 {{warning|Stereo files will never work with this! The file needs to be mixed into a mono track to use this parameter. Also keep in minds stereo doesn't fade with distance.}}
-Well thats it! You now created your very own sound! Use it with <code>PlaySoundAtEntity();</code> in your level script (check [http://wiki.frictionalgames.com/hpl2/amnesia/script_functions Engine scripts] for details).
+Well thats it! You now created your very own sound! Place it in the map with the Level Editor or use it with <code>PlaySoundAtEntity();</code> in your level script (check [http://wiki.frictionalgames.com/hpl2/amnesia/script_functions Engine scripts] for details).
 = Adding custom music =
-Custom music needs exactly the same steps as the custom sounds. However, they won't need an .snt file to be created as long as the music is to be played with <code>PlayMusic();</code> or at the credits.
+Custom music only needs to be a file in the '''.ogg''' format. It won't need an '''.snt''' file to be played with <code>PlayMusic();</code> or at the credits, but you won't be able to use <code>PlaySoundAtEntity();</code> with this file.
 Just like with sounds, it is good to create a folder for music in the mod's main folder, e.g. '''music'''. Put the '''.ogg''' file there.
-Now, use <code>PlayMusic();</code> in a script. (check [http://wiki.frictionalgames.com/hpl2/amnesia/script_functions Engine scripts] to know what syntax to use)
+See [http://wiki.frictionalgames.com/hpl2/amnesia/script_functions Engine scripts] to learn how to use <code>PlayMusic();</code>.
-Keep in mind that only one music file can play at a time. For ambients, it is better to create a sound file (like described earlier).
+Keep in mind that only one music file can play at a time. For ambient sound, it is better to create a sound file (like described earlier). That way you can layer ambient sound with actual music when needed.

@@ Line 1: / Line 1: @@
-= How to add Custom Sounds? =
+{{cleanup|This article uses personal language and has poorly explained fragments and broken links.}}
-Hello! Stepper321 (And friends) here, i'm gonna teach you how to add custom sounds!
+The sounds need to be in '''.ogg ''' format, If your soundfiles are formatted as '''.MP3''', '''.WAV''' or anything else, you may use one of the said above programs to convert your soundfile of choice to an '''.ogg''' file format.
-== Having the sounds ==
+{{tip|It is recommended to use mono files. Stereo should only be used (but is not required) for music and ambient tracks.}}
-The sounds need to be in '''.ogg ''' format, If your soundfiles are formatted as '''.MP3''', '''.WAV''' or anything else, you may use one of the said above programs to convert your soundfile of choice to an '''''.'' ogg''' file format.
+== Managing sound files ==
-For my example, my script file is called '''tutorial.txt''', and the sound is '''door.ogg'''.
+{{tip|If your mod has a lot of custom sounds, make sure to organise them into subfolders!}}
-== Placing the sounds in the right folder ==
+Place the tutorial.ogg file in the created (sub)folder.
-You need to go to your custom story folder and create a new folder called: “sounds” and in that folder an: “extrasounds” folder. In there you place the tutorial.ogg file.<br />
+Create a '''.txt''' file and name it the name of your sound's Script, open it with any Text Editor you use. I use [http://wiki.frictionalgames.com/hpl2/third_party_tools/text/notepad?s[]=notepad Notepad++]. I named my file '''tutorial.txt'''.
-Create a '''.txt''' file and name it the name of your sound's Script, open it with any Text Editor you use. I use [http://wiki.frictionalgames.com/hpl2/third_party_tools/text/notepad?s[]=notepad Notepad++]. I named my file <u>'''tutorial'''</u>'''.txt'''.
+{{tip|.txt might work, but it is recommended to give sound files the .snt extension used by the main game. This will allow your sound to be placed in a level without scripting. If using Notepad++, right-click them and pick Notepad++ to edit these files.}}
 In the file, you can edit quite a few things, and among them is..''Adding your sound-file into the script!'' And since my sound file is <u>'''door'''</u>'''.ogg''', It shall go to the '''MAIN''' section. Random soundfiles will be covered later on.
-<syntaxhighlight lang="">
+<syntaxhighlight lang="xml">
 <SOUNDENTITY>
   <SOUNDS>
@@ Line 37: / Line 37: @@
 </syntaxhighlight>
-Maybe you're asking, what the hell is all of this? I will explain :
+Format explanation:
-<'''Main''' > is the main sound it will play, i don't know if there exist other categories for that. But use it
+<'''SOUNDENTITY'''> is the start marker of the sound file
-<'''Sound File''' =" ''YourFileName''.ogg" /> is the sound file it will play, if you add multiple sound files, it will play the sounds randomly.
+<'''SOUNDS'''> indicates the sound list
-<'''PROPERTIES''' > Are all the options you may use to decide how the sound will behave in-game, like '''MinDistance''' is what distance you have to be in to hear it, since 1 is the players exact size, You will hear the sound perfectly if you stand on it. Beyond that, you will be able to hear the sound until the distance specified in '''MaxDistance''', I don't know exactly but I think that "1" distance is a meter, excuse me if i'm wrong :). (Probably an inch, a person 1 meter in width? '''Needs to be confirmed''')
+<'''Main'''> is the list of sounds the file will play. It is unsure if other categories exist.
-Well thats it! You now created your very own sound! Use it with PlaySoundAtEntity(syntax) in your custom level-script; (check [http://wiki.frictionalgames.com/hpl2/amnesia/script_functions Engine scripts] to know what syntax to use)
+<'''Sound File'''="''YourFileName''.ogg" /> is the way to add a file to the sound. Adding multiple files will play them randomly.
-= Custom Music =
+<'''PROPERTIES'''> Are all the options you may use to decide how the sound will behave in-game. Most important ones are:
-Custom musics are exactly the same steps as the custom sounds. But you won't need an .snt file created as long as you do it with PlayMusic(syntax); or at the credits.
+= Adding custom music =
 Prepare your .ogg file with the same steps as the Custom Sounds.
-Create a new folder called "music" and in the 'music' folder one that's called "extramusic" put it in there. ('''Again, you may name it whatevas you want''')
+Now, use <code>PlayMusic();</code> in a script. (check [http://wiki.frictionalgames.com/hpl2/amnesia/script_functions Engine scripts] to know what syntax to use)
-<br />
+Keep in mind that only one music file can play at a time. For ambients, it is better to create a sound file (like described earlier).