search

kyzfrintin / Godot-Mixing-Desk

A complete audio solution for Godot 3.3.x, making procedural sound and adaptive/procedural music possible with a few nodes and a couple lines of code.
MIT License
636 stars 32 forks source link

API documentation #12

Open rezgi opened 4 years ago

rezgi commented 4 years ago

I have a bit of trouble finding the methods available to use the add-on like init_song() or play(song). It would be nice to have the list of all methods available and in what scopes ($MixingDeskMusic ? $Song ?...)

MJacred commented 3 years ago

Hi, I wrote some API docs for Mixing Desk Music in my fork, but I already renamed some of the funcs and did some cleanup. It might still help you: https://github.com/MJacred/Godot-Mixing-Desk/blob/cleanup/addons/mixing-desk/music/docs/api.md

I'll keep expanding/updating it, but my fork is very much still work-in-progress

Hope it helps, cheers!

kyzfrintin commented 3 years ago

@MJacred that is one robust API doc. Would you mind if I used your doc as a basis for an API doc in my original repo?

MJacred commented 3 years ago

@kyzfrintin thank you! I was planning on doing a pull request once I got it all cleaned up (not sure I'll find time in May, but June should be fine).

The only thing missing should be applying song modifications before next loop run (I think you fixed that in this repo). And then rename some variables (not entirely happy yet).

Would you merge the fork if I made a pull request? I tried to adhere to your design. Although I would probably put all currently playing AudioStreamPlayers into the overlay, for consistency. Then the API doc could be added the same way and the code would have better readability.