1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
2
3<html>
4
5
6
7<head>
8
9<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
10
11<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
12
13<title>MUD Sound Protocol</title>
14
15<link rel="stylesheet" type="text/css" href="../common/master.css">
16
17</head>
18
19
20
21<body stylesrc="../zuggsoft/zuggsoft.htm" bgcolor="#FFFFFF" text="#000000" link="#FF0000" vlink="#0080C0" alink="#FF8080">
22
23<script language="JavaScript" SRC="/common/js_dynMenuFunctions.js">
24
25</script>
26
27<script language="JavaScript">
28
29<!--
30
31	var garyMenuData = new Array()
32
33	var garyMenuNames = new Array()
34
35	garyMenuData["News"] = new Array()
36
37	garyMenuNames.push( new Array("News", 12, 14, 95, 80) )
38
39	garyMenuData["News"].push( new Array("Privacy","/zuggsoft/privacy.htm") )
40
41	garyMenuData["News"].push( new Array("Press","/zmud/press.htm") )
42
43	garyMenuData["News"].push( new Array("About us","/zuggsoft/about.htm") )
44
45	garyMenuData["Products"] = new Array()
46
47	garyMenuNames.push( new Array("Products", 63, 65, 160, 145) )
48
49	garyMenuData["Products"].push( new Array("zMUD","/zmud/zmudinfo.htm") )
50
51	garyMenuData["Products"].push( new Array("AC Explorer","/ac/ac.asp") )
52
53	garyMenuData["Products"].push( new Array("DoctorZ","/doctorz/doctorzinfo.htm") )
54
55	garyMenuData["Products"].push( new Array("zMUD Developer's Kit","/devkit/devkitinfo.htm") )
56
57	garyMenuData["Products"].push( new Array("zChat","/zchat/zchatinfo.htm") )
58
59	garyMenuData["Buy"] = new Array()
60
61	garyMenuNames.push( new Array("Buy", 147, 149, 160, 145) )
62
63	garyMenuData["Buy"].push( new Array("zMUD","/zmud/order_zmud.htm") )
64
65	garyMenuData["Buy"].push( new Array("AC Explorer","/zmud/order_ac.htm") )
66
67	garyMenuData["Buy"].push( new Array("DoctorZ","/doctorz/register.htm") )
68
69	garyMenuData["Buy"].push( new Array("zMUD Developer's Kit","/zmud/order_devkit.htm") )
70
71	garyMenuData["Downloads"] = new Array()
72
73	garyMenuNames.push( new Array("Downloads", 224, 226, 105, 90) )
74
75	garyMenuData["Downloads"].push( new Array("zMUD","/zmud/down.asp#zMUD") )
76
77	garyMenuData["Downloads"].push( new Array("AC Explorer","/zmud/down.asp#ACX") )
78
79	garyMenuData["Downloads"].push( new Array("DoctorZ","/zmud/down.asp#DoctorZ") )
80
81	garyMenuData["Support"] = new Array()
82
83	garyMenuNames.push( new Array("Support", 322, 324, 160, 145) )
84
85	garyMenuData["Support"].push( new Array("Support Library","/library") )
86
87	garyMenuData["Support"].push( new Array("Bug reports","/zmud/bugs.htm") )
88
89	garyMenuData["Support"].push( new Array("Lost Registration code","/zuggsoft/regcode.htm") )
90
91	garyMenuData["Support"].push( new Array("Links","/links/links.cfm") )
92
93	garyMenuData["Support"].push( new Array("MUDs","/muds/links.cfm") )
94
95	garyMenuData["Forums"] = new Array()
96
97	garyMenuNames.push( new Array("Forums", 396, 398, 120, 105) )
98
99	garyMenuData["Forums"].push( new Array("zMUD General","/forum/FORUM.asp?FORUM_ID=7&CAT_ID=1&Forum_Title=zMUD+General+Discussion") )
100
101	garyMenuData["Forums"].push( new Array("zMUD Beta","/forum/FORUM.asp?FORUM_ID=8&CAT_ID=1&Forum_Title=zMUD+Beta+Forum") )
102
103	garyMenuData["Forums"].push( new Array("AC Explorer","/forum/FORUM.asp?FORUM_ID=13&CAT_ID=3&Forum_Title=AC+Explorer+Discussion") )
104
105	garyMenuData["Forums"].push( new Array("DoctorZ","/forum/FORUM.asp?FORUM_ID=12&CAT_ID=3&Forum_Title=DoctorZ+Discussion") )
106
107	garyMenuData["Forums"].push( new Array("Developers","/forum/FORUM.asp?FORUM_ID=10&CAT_ID=1&Forum_Title=zMUD+Developers") )
108
109	garyMenuData["Contact"] = new Array()
110
111	garyMenuNames.push( new Array("Contact", 400, 403, 160, 145) )
112
113	garyMenuData["Contact"].push( new Array("Feedback","/zuggsoft/feedback.htm") )
114
115	garyMenuData["Contact"].push( new Array("Bug reports","/zmud/bugs.htm") )
116
117	garyMenuData["Contact"].push( new Array("Lost Registration code","/zuggsoft/regcode.htm") )
118
119	garyMenuData["Contact"].push( new Array("Email","mailto:support@zuggsoft.com") )
120
121//-->
122
123</script>
124
125<script language="JavaScript">
126
127<!--
128
129	var gstrBrowserType = null
130
131	if( document.layers )   gstrBrowserType="Netscape";
132
133	else if( document.all )	gstrBrowserType="IE";
134
135	gstrMenuColor = "#F3E9EF"
136
137	gstrMenuColorOn = "#D2AEC4"
138
139	gstrBorderColor = "#993366"
140
141	var strAlignment = "left"
142
143	if( gstrBrowserType == "Netscape" )
144
145	{
146
147		for (var intCnt=0; intCnt<garyMenuNames.length; intCnt++) {
148
149			if( intCnt == (garyMenuNames.length - 1) ){
150
151				//All menus are left-aligned except the last menu
152
153				strAlignment = "right"
154
155			}
156
157			//Pass the menu name, the menu left position Netscape, the Netscape width, and the alignment of text in the menu
158
159			createNetscapeMenu(garyMenuNames[intCnt][0], garyMenuNames[intCnt][1], garyMenuNames[intCnt][3], strAlignment)
160
161		}
162
163	}
164
165	else if( gstrBrowserType == "IE" )
166
167	{
168
169		for (var intCnt=0; intCnt<garyMenuNames.length; intCnt++) {
170
171			if( intCnt == (garyMenuNames.length - 1) ){
172
173				//All menus are left-aligned except the last menu
174
175				strAlignment = "right"
176
177			}
178
179			//Pass the menu name, the menu left position for IE, the IE width, and the alignment of text in the menu
180
181			createIEMenu(garyMenuNames[intCnt][0], garyMenuNames[intCnt][2], garyMenuNames[intCnt][4], strAlignment)
182
183		}
184
185	}
186
187//-->
188
189</script>
190
191
192
193<table width="100%" border="0" cellpadding="0">
194
195  <tr>
196
197    <td>
198
199      <table border="0" cellpadding="0" width="100%" background="/common/background.gif">
200
201        <tr>
202
203          <td width="260"><a href="/zuggsoft/zuggsoft.htm" target="_top"><img border="0" src="/common/zs.gif" width="130" height="53"></a> <img border="0" src="/common/flag.gif" width="100" height="55"></td>
204
205          <td>
206
207            <font face="Verdana" size="2" color="#0000FF"><b>Customer&nbsp;driven&nbsp;Internet&nbsp;Software<br>
208
209            Upgrades&nbsp;are&nbsp;always&nbsp;FREE,&nbsp;FOREVER!</b></font>
210
211          </td>
212
213          <td valign="middle" align="right"><font size="-2" face="Arial">
214
215            [<a href="http://www.mudconnector.com/" target="_blank">The&nbsp;MUD&nbsp;Connector</a>]<br>
216
217            [<a href="http://www.themudjournal.com/" target="_blank">The&nbsp;MUD&nbsp;Journal</a>]<br>
218
219            [<a href="http://www.mudcompanion.com/" target="_blank">The&nbsp;MUD&nbsp;Companion</a>]</font></td>
220
221        </tr>
222
223      </table>
224
225    </td>
226
227  </tr>
228
229  <tr>
230
231    <td>
232
233      <table border="0" width="100%" cellpadding="0">
234
235        <tr>
236
237          <td width="48" valign="top">
238
239            <a href="/zuggsoft/whatsnew.htm" onmouseover="showMenu('News')" onmouseout="hideMenu('News')">
240
241            <img src="/common/newsbutton.gif" width="49" height="21" alt="" border="0"></a></td>
242
243          <td width="81" valign="top">
244
245            <a href="/zuggsoft/product.htm" onmouseover="showMenu('Products')" onmouseout="hideMenu('Products')">
246
247            <img src="/common/productbutton.gif" width="82" height="21" alt="" border="0"></a></td>
248
249          <td width="74" valign="top">
250
251            <a href="/zmud/register.htm" onmouseover="showMenu('Buy')" onmouseout="hideMenu('Buy')">
252
253            <img src="/common/buybutton.gif" width="75" height="21" alt="" border="0"></a></td>
254
255          <td width="95" valign="top">
256
257            <a href="/zmud/down.htm" onmouseover="showMenu('Downloads')" onmouseout="hideMenu('Downloads')">
258
259            <img src="/common/downloadbutton.gif" width="96" height="21" alt="" border="0"></a></td>
260
261          <td width="71" valign="top">
262
263            <a href="/library" onmouseover="showMenu('Support')" onmouseout="hideMenu('Support')">
264
265            <img src="/common/supportbutton.gif" width="72" height="21" alt="" border="0"></a></td>
266
267          <td width="67" valign="top">
268
269            <a href="/forum/default.asp" onmouseover="showMenu('Forums')" onmouseout="hideMenu('Forums')">
270
271            <img src="/common/forumbutton.gif" width="68" height="21" alt="" border="0"></a></td>
272
273          <td width="93" valign="top">
274
275            <a href="/zuggsoft/feedback.htm" onmouseover="showMenu('Contact')" onmouseout="hideMenu('Contact')">
276
277            <img src="/common/contactbutton.gif" width="94" height="21" alt="" border="0"></a></td>
278
279          <td width="9999" bgcolor="#9C3163" align="right">
280
281            <font size="-2" face="Arial" color="#FFFFDE">�&nbsp;2001&nbsp;Zugg&nbsp;Software&nbsp;</font>
282
283          </td>
284
285        </tr>
286
287        <noscript>
288
289          <tr>
290
291          <td bgcolor="#F5F5F5" width="48">
292
293            <table border="0" cellpadding="0">
294
295              <tr><td><font size="1"><a href="/zuggsoft/privacy.htm">Privacy</a></font></td></tr>
296
297              <tr><td><font size="1"><a href="/zmud/press.htm">Press</a></font></td></tr>
298
299              <tr><td><font size="1"><a href="/zuggsoft/about.htm">About&nbsp;us</a></font></td></tr>
300
301              <tr><td><font size="1">&nbsp;</font></td></tr>
302
303              <tr><td><font size="1">&nbsp;</font></td></tr>
304
305            </table></td>
306
307          <td bgcolor="#F5F5F5" width="81">
308
309            <table border="0" cellpadding="0">
310
311              <tr><td><font size="1"><a href="/zmud/zmudinfo.htm">zMUD</a></font></td></tr>
312
313              <tr><td><font size="1"><a href="/ac/ac.asp">AC&nbsp;Explorer</a></font></td></tr>
314
315              <tr><td><font size="1"><a href="/doctorz/doctorzinfo.htm">DoctorZ</a></font></td></tr>
316
317              <tr><td><font size="1"><a href="/devkit/devkitinfo.htm">Developer's&nbsp;Kit</a></font></td></tr>
318
319              <tr><td><font size="1"><a href="/zchat/zchatinfo.htm">zChat</a></font></td></tr>
320
321            </table></td>
322
323          <td bgcolor="#F5F5F5" width="74">
324
325            <table border="0" cellpadding="0">
326
327              <tr><td><font size="1"><a href="/zmud/order_zmud.htm">zMUD</a></font></td></tr>
328
329              <tr><td><font size="1"><a href="/zmud/order_ac.htm">AC&nbsp;Explorer</a></font></td></tr>
330
331              <tr><td><font size="1"><a href="/doctorz/register.htm">DoctorZ</a></font></td></tr>
332
333              <tr><td><font size="1"><a href="/zmud/order_devkit.htm">Developer's&nbsp;Kit</a></font></td></tr>
334
335              <tr><td><font size="1">&nbsp;</font></td></tr>
336
337            </table></td>
338
339          <td bgcolor="#F5F5F5" width="95">
340
341            <table border="0" cellpadding="0">
342
343              <tr><td><font size="1"><a href="/zmud/down.asp#zMUD">zMUD</a></font></td></tr>
344
345              <tr><td><font size="1"><a href="/zmud/down.asp#ACX">AC&nbsp;Explorer</a></font></td></tr>
346
347              <tr><td><font size="1"><a href="/zmud/down.asp#DoctorZ">DoctorZ</a></font></td></tr>
348
349              <tr><td><font size="1">&nbsp;</font></td></tr>
350
351              <tr><td><font size="1">&nbsp;</font></td></tr>
352
353            </table></td>
354
355          <td bgcolor="#F5F5F5" width="71">
356
357            <table border="0" cellpadding="0">
358
359              <tr><td><font size="1"><a href="/library">Library</a></font></td></tr>
360
361              <tr><td><font size="1"><a href="/links/links.cfm">Links</a></font></td></tr>
362
363              <tr><td><font size="1"><a href="/muds/links.cfm">MUDs</a></font></td></tr>
364
365              <tr><td><font size="1">&nbsp;</font></td></tr>
366
367              <tr><td><font size="1">&nbsp;</font></td></tr>
368
369            </table></td>
370
371          <td bgcolor="#F5F5F5" width="67">
372
373            <table border="0" cellpadding="0">
374
375              <tr><td><font size="1"><a href="/forum/FORUM.asp?FORUM_ID=7&amp;CAT_ID=1&amp;Forum_Title=zMUD+General+Discussion">zMUD&nbsp;General</a></font></td></tr>
376
377              <tr><td><font size="1"><a href="/forum/FORUM.asp?FORUM_ID=8&amp;CAT_ID=1&amp;Forum_Title=zMUD+Beta+Forum">zMUD&nbsp;Beta</a></font></td></tr>
378
379              <tr><td><font size="1"><a href="/forum/FORUM.asp?FORUM_ID=13&amp;CAT_ID=3&amp;Forum_Title=AC+Explorer+Discussion">AC&nbsp;Explorer</a></font></td></tr>
380
381              <tr><td><font size="1"><a href="/forum/FORUM.asp?FORUM_ID=12&amp;CAT_ID=3&amp;Forum_Title=DoctorZ+Discussion">DoctorZ</a></font></td></tr>
382
383              <tr><td><font size="1"><a href="/forum/FORUM.asp?FORUM_ID=10&amp;CAT_ID=1&amp;Forum_Title=zMUD+Developers">Developers</a></font></td></tr>
384
385            </table></td>
386
387          <td bgcolor="#F5F5F5" width="93">
388
389            <table border="0" cellpadding="0">
390
391              <tr><td><font size="1"><a href="/zuggsoft/suggest.cfm">Feedback</a></font></td></tr>
392
393              <tr><td><font size="1"><a href="/zmud/bugs.cfm">Bug&nbsp;reports</a></font></td></tr>
394
395              <tr><td><font size="1"><a href="mailto:support@zuggsoft.com">Email</a></font></td></tr>
396
397              <tr><td><font size="1">&nbsp;</font></td></tr>
398
399              <tr><td><font size="1">&nbsp;</font></td></tr>
400
401            </table></td>
402
403          <td width="9999" bgcolor="#F5F5F5">&nbsp;</td>
404
405          </tr>
406
407        </noscript>
408
409      </table>
410
411    </td>
412
413  </tr>
414
415  <tr>
416
417    <td bgcolor="808080" height="2"><img border="0" src="/common/1x1.gif" width="1" height="2"></td>
418
419  </tr>
420
421</table>
422
423
424
425
426
427<h1>MUD Sound Protocol (MSP)</h1>
428
429
430
431<p>The MUD Sound Protocol (MSP) was developed jointly between many
432
433people, including implementers of various MUDs and MUD clients. Leading the MSP design
434
435effort was&nbsp; <a href="msplist.htm#Medievia">Medievia MUD</a> and the zMUD and MUD Master MUD
436
437clients.&nbsp; This document provides the complete MSP specification, as well as zMUD
438
439implementation notes.
440
441
442
443<dl>
444
445  <dd><img border="0" src="../common/diamond.gif" align="bottom" width="14" height="14">
446
447    <a href="msplist.htm">List of MUDs with MSP support</a></dd>
448
449  <dd><img border="0" src="../common/diamond.gif" align="bottom" width="14" height="14">
450
451    <a href="msplist.htm#MUD Clients that support MSP">List of MUD Clients with
452
453    MSP support</a></dd>
454
455  <dd><img border="0" src="../common/diamond.gif" align="bottom" width="14" height="14">
456
457    <a href="#MSP Specification">MSP specification</a></dd>
458
459  <dd><img border="0" src="../common/diamond.gif" align="bottom" width="14" height="14">
460
461    <a href="mspzmud.htm">zMUD Implementation notes</a></dd>
462
463</dl>
464
465
466
467<h3><img src="../common/red_bar.gif" width="100%" height="2"><br>
468
469<a name="MSP Specification">MSP Specification</a> v0.3</h3>
470
471
472
473<dl>
474
475  <dt>Changes from v0.2:</dt>
476
477  <dd>Added U=URL optional parameter for !!SOUND and !!MUSIC to download
478
479    sounds via the web</dd>
480
481</dl>
482
483
484
485<h4>!!SOUND:</h4>
486
487
488
489<dl>
490
491  <dt>Syntax:</dt>
492
493  <dd>!!SOUND(fname V=vol L=repeats P=priority T=type U=URL)</dd>
494
495  <dt>Where:</dt>
496
497  <dd>&quot;fname&quot; is the name of the sound file to be played</dd>
498
499  <dd>&quot;vol&quot; is the volume level to play the sound at</dd>
500
501  <dd>&quot;repeats&quot; is the number of times to play the sound</dd>
502
503  <dd>&quot;priority&quot; is the priority of the sound</dd>
504
505  <dd>&quot;type&quot; is the sound class</dd>
506
507  <dd>&quot;URL&quot; is the optional download URL for the sound file</dd>
508
509</dl>
510
511
512
513<p>Parameters:
514
515
516
517<dl>
518
519  <dt>fname:</dt>
520
521  <dd>&quot;fname&quot; may contain relative path information and
522
523    wildcards, but may not contain absolute path information. Any directory information should
524
525    be specified using &quot;/&quot; rather than &quot;\&quot;, since this avoids all of those
526
527    nasty problems with escape characters. If multiple wave files match a wildcard, one of
528
529    them should be chosen at random. Wildcards should work just like DOS wildcards; * should
530
531    match the remainder of the file name, and ? should match exactly one character. If no
532
533    extension is specified, &quot;.wav&quot; should be assumed.</dd>
534
535  <dd>Following are some valid fname values:<dl>
536
537      <dd>weather/thund*</dd>
538
539      <dd>lightning.wav</dd>
540
541      <dd>zone231/room22.wav</dd>
542
543    </dl>
544
545  </dd>
546
547  <dd>And some invalid ones:<dl>
548
549      <dd>weather\lightning.wav # uses \ rather than /</dd>
550
551      <dd>*x*.wav # wildcards stop after the first *</dd>
552
553      <dd>c:\sounds\m.wav # no absolute paths</dd>
554
555    </dl>
556
557  </dd>
558
559  <dt>vol:</dt>
560
561  <dd>&quot;vol&quot; may range from 0 (0%, off) to 100 (100%, full). This
562
563    parameter may be omitted, in which case it defaults to 100.</dd>
564
565  <dt>repeats:</dt>
566
567  <dd>&quot;repeats&quot; controls the number of times to play the sound.
568
569    It may be omitted, in which case it defaults to 1. It may also be set to -1, which causes
570
571    sounds to be looped until otherwise instructed.</dd>
572
573  <dt>priority:</dt>
574
575  <dd>&quot;priority&quot; is the priority of the sound. If a sound is
576
577    requested while another sound is being played, whichever sound has the higher priority
578
579    wins. In the case of a tie, the sound that is already playing wins. This is to prevent
580
581    combat sounds from degenerating into a mishmash of sound fragments. Priority may range
582
583    from 0 to 100, and defaults to 50 if not set.</dd>
584
585  <dt>type:</dt>
586
587  <dd>The class of the sound. This is mud specific. Some example classes
588
589    might be combat, zone, death, clan. This parameter may be omitted, but if a MUD opts to
590
591    use it, it's recommended that it be used everywhere. The actual type is a string, and
592
593    should be case insensitive.&nbsp; If this parameter is omitted, the subdirectory of the
594
595    fName is used as the class.</dd>
596
597  <dt>URL:</dt>
598
599  <dd>The URL is used to download the sound if it does not exist on the
600
601    local system.&nbsp; If can be a full URL for the file, or a URL path to which the fname is
602
603    appended.&nbsp; Using a global path and putting the subdirectory information into the
604
605    fName is a good way to maintain a directory structure on both the web server and the local
606
607    disk.&nbsp;</dd>
608
609</dl>
610
611
612
613<p>Notes:
614
615
616
617<ol>
618
619  <li>If a wildcard pattern is requested for multiple repeats, the actual
620
621    sound played should be picked randomly for each iteration.</li>
622
623  <li>The sound name Off is reserved, and should cause all wave files to
624
625    stop playing.</li>
626
627</ol>
628
629
630
631<p>Examples:
632
633
634
635<dl>
636
637  <dd>!!SOUND(thunder V=100 L=1 P=30 T=weather)</dd>
638
639  <dd>!!SOUND(weather/rain.wav V=80 P=20 T=weather)</dd>
640
641  <dd>!!SOUND(alarm P=100 T=utility)</dd>
642
643  <dd>!!SOUND(Off)</dd>
644
645</dl>
646
647
648
649<h4>!!MUSIC:</h4>
650
651
652
653<dl>
654
655  <dt>Syntax:</dt>
656
657  <dd>!!MUSIC(fname V=vol L=repeats C=continue T=type U=URL)</dd>
658
659  <dt>Where:</dt>
660
661  <dd>&quot;fname&quot; is the name of the music file to be played</dd>
662
663  <dd>&quot;vol&quot; is the volume level to play the music at
664
665    &quot;repeats&quot; is the number of times to play the music file</dd>
666
667  <dd>&quot;continue&quot; specifies whether the file should be restarted
668
669    if requested again</dd>
670
671  <dd>&quot;type&quot; is the sound class</dd>
672
673  <dd>&quot;URL&quot; is the optional download URL for the sound file</dd>
674
675</dl>
676
677
678
679<p>Parameters:
680
681
682
683<dl>
684
685  <dt>fname:</dt>
686
687  <dd>&quot;fname&quot; may contain relative path information and
688
689    wildcards, but may not contain absolute path information. Any directory information should
690
691    be specified using &quot;/&quot; rather than &quot;\&quot;, since this avoids all of those
692
693    nasty problems with escape characters. If multiple music files match a wildcard, one of
694
695    them should be chosen at random. Wildcards should work just like DOS wildcards; * should
696
697    match the remainder of the file name, and ? should match exactly one character. If no
698
699    extension is specified, &quot;.mid&quot; should be assumed.</dd>
700
701  <dd>Following are some valid fname values:<dl>
702
703      <dd>bach/fugue*.mid</dd>
704
705      <dd>zone231/room22.mid</dd>
706
707    </dl>
708
709  </dd>
710
711  <dd>And some invalid ones:<dl>
712
713      <dd>tchai\1812.mid # uses \ rather than /</dd>
714
715      <dd>*x*.mid # wildcards stop after the first *</dd>
716
717      <dd>c:\midi\m.mid # no absolute paths</dd>
718
719    </dl>
720
721  </dd>
722
723  <dt>vol:</dt>
724
725  <dd>&quot;vol&quot; may range from 0 (0%, off) to 100 (100%, full). This
726
727    parameter may be omitted, in which case it defaults to 100.</dd>
728
729  <dt>repeats:</dt>
730
731  <dd>&quot;repeats&quot; controls the number of times to play the sound.
732
733    It may be omitted, in which case it defaults to 1. It may also be set to -1, which causes
734
735    the midi file to be looped continuously until otherwise instructed.</dd>
736
737  <dt>continue:</dt>
738
739  <dd>&quot;continue&quot; specifies whether the file should simply
740
741    continue playing if requested again (1), or if it should restart (0). In either case, the
742
743    new repeat count should take precedence over the old one, and the &quot;number of plays
744
745    thus far&quot; counter should be reset to 0. By way of illustration, assume two rooms,
746
747    room 110, and room 111. Room 110 is set to play bach/fugue.mid 3 times, while room 111 is
748
749    set to play bach/fugue.mid 5 times. If a character enters room 110, fugue starts playing;
750
751    if during halfway through the second refrain the character moves to room 111, fugue would
752
753    either continue or restart based on the continue setting. fugue should play either 4.5
754
755    times (if continue was 1) or 5 times (if continue was 0). Similarly, the volume of the
756
757    most recent MUSIC escape should be used. If &quot;continue&quot; isn't specified, it
758
759    defaults to 1.</dd>
760
761  <dt>type:</dt>
762
763  <dd>The class of the sound. This is mud specific. Some example classes
764
765    might be combat, zone, death, clan. This parameter may be omitted, but if a MUD opts to
766
767    use it, it's recommended that it be used everywhere. The actual type is a string, and
768
769    should be case insensitive. If this parameter is omitted, the subdirectory of the fName is
770
771    used as the class.</dd>
772
773  <dt>URL:</dt>
774
775  <dd>The URL is used to download the sound if it does not exist on the
776
777    local system.&nbsp; If can be a full URL for the file, or a URL path to which the fname is
778
779    appended.&nbsp; Using a global path and putting the subdirectory information into the
780
781    fName is a good way to maintain a directory structure on both the web server and the local
782
783    disk.&nbsp;</dd>
784
785</dl>
786
787
788
789<p>Notes:
790
791
792
793<ol>
794
795  <li>If a wildcard pattern is requested for multiple repeats, the actual
796
797    music file played should be picked randomly for each iteration.</li>
798
799  <li>The music name Off is reserved, and should cause all midi files to
800
801    stop playing.</li>
802
803</ol>
804
805
806
807<p>Examples:
808
809
810
811<dl>
812
813  <dd>!!MUSIC(fugue.mid V=100 L=1 C=1 T=music)</dd>
814
815  <dd>!!MUSIC(berlioz/fantas1 V=80 L=-1 C=1 T=music)</dd>
816
817  <dd>!!MUSIC(Off)</dd>
818
819</dl>
820
821
822
823<p align="right"><img src="../common/red_bar.gif" width="100%" height="2"><br>
824
825<font size="2" face="Arial">This page last updated on <!--webbot bot="Timestamp"
826
827S-Type="EDITED" S-Format="%B %d, %Y" startspan -->July 25, 2001<!--webbot bot="Timestamp" endspan i-checksum="14336" -->
828
829</font> </p>
830
831</body>
832
833</html>
834
835