SFX Documentation

#1 So nothing on this?

#2 I *think* Michael is working on this, maybe he just didn't see the thread.

#3 Just a note, I recently was struggling with getting sound working properly in TGB and the end game was that it will not play sounds that are named as numbers...

Such as 1.wav, etc.

I don't know if the limitation will carry over to TGEA, but it was frustrating to figure out.

'Patrick

#4 Protip: Most people in the western world are on vacation on Christmas day (Dec 25). Worst case you might have to wait until after Jan 1...

#5 Nod, i understand but i figured it was important enough of a issue to warrent a post that does require a response. I was flipping through some of the books, i have. It seems that audio is taken so lightly be many programmers and artists. Books about game design are written with those 2 themes as a focus with a tiny chapter on audio 400 pages of book with less then 20 pages divoted to audio. (my exact count in on was 12 pages, including the title, and consisted mostly of a interview with a pair of sound directors).

I know Micheal is working hard on Documentation, and i hope that whoever did the implimentation of the SFX system would actual start the notes. There is nothing like having the documentation written 2nd hand. I mean really, No offense, but trying to run back and document something thats already in and coded 2nd hand is like asking some to walk up to a car and tell me how its engine was built after the fact. "heres the car, i need a repair manual for the engine, we forgot to make one while it was being made." Sorry to sound synical, but GG knows documentation was a issue, they have Micheal on hand. But yet, after how long of development, this is still a issue?

Now i dont underestimate Mikes enthusism and i enjoy what has been documented so far. But its a long road. And this needs to be done. In fact, if i was the boss, id make this next development cycle a bug and documentation cycle instead of a growth cycle.

I dont mind waiting till the 1st( or so) I understand holidays. I just hope this gets fixed in a reasonable amount of time as its frustrating to have to sit down with the sound engineer and so, sorry, the engines doesnt come with documentation on sound, and since we only have a few examples to work with, we just will have to wait 3-6 months before they get around to it. Yes i forecasted at least that until the other "more important documentation" is completed. I say that with quotation becuase again from each side of the tables point of view its all important, the shaders guys, the ai guys, the level design guys and so forth. We all have our gripes, This one is just happens to be in response to a huge gap for one of my team members. The things i do for my team. :)

#6 @Edward - This is my fault... i wrote SFX and i've not been quick with writing docs for it.

The API reference can be found in the headers and is fairly extensive and worth a look. I hope to see that exported and in TDN soon as basic reference is always useful.

Still nothing beats having some overviews and articles on specific problems and solutions. I'm doing some work on those now.

#7 @Patrick

Quote:I recently was struggling with getting sound working properly in TGB and the end game was that it will not play sounds that are named as numbers

That sounds like a bug to me... if you notice this issue with SFX be sure to report it.

#8 Thanks Tom, this is what I wanted to hear, I had just hoped to take time over the holidays to catch, up but its the holidays and i do understand that. But thank you for stepping forward and being aware of the problem.

#9 Just thought i would bump this issue.

#10 Why bump this issue? O_o

I said I was writing the docs for crying out loud. Do you want me to do a live video feed as I'm writing them?

#11 Im getting a "Only SFX owners can access this content." error under Audio-SFX- Docs Category in TDN. (ref)

Just curious if there is any content there? Im trying to get some reading for the sound designer of the project Im currently working on.

Till now I got some outdated articles from the TGE section of TDN, and the SFX Overview page that Eduard posted here. Someone found anything else?

#12 Michael,

I just had to chime in and say thanks for the laugh I needed it. I can't help but picture being able to watch you typing the docs on a web cast :P

#13 Tom & Michael where is the documentation for the SFX system? I don't think this is funny.

#14 SFX docs can now be found in the Torque 3D documentation.