godot-fmod-integration icon indicating copy to clipboard operation
godot-fmod-integration copied to clipboard

Include Demo Project in the releases tab

Open DeerTears opened this issue 5 years ago • 3 comments

Is your feature request related to a problem? Please describe. In short: I'd like this repository to show newer users the demo so the FMOD code is a lot more tangible (instead of copy/pasting into unprepared/empty projects). It'd also be nice to be redirected/shown how to retrieve banks from an FMOD Studio project.

The long of it: I couldn't figure out how to get the bank files described in the lines of Basic Usage code that initialize the banks and I've been stuck for a day. I understood them as part of any project using FMOD but as an FMOD beginner I had no idea how to export/obtain banks from FMOD Studio, thinking it was a dependency like the .dlls. I just went off of what I had downloaded from the releases tab since I'm not normally a programmer who downloads unbuilt code.

Describe the solution you'd like In the releases tab, add a separate download segment for the demo project with a description that goes over the fact that it's a Godot project with its own banks from an FMOD Studio project.

Describe alternatives you've considered A description in the README that points out the demo and its usefulness, perhaps even a tutorial (a link or otherwise) on how to create/utilize banks in FMOD that can be used in this utility.

Additional context Mostly personal frustration from being a new coder who's never stepped outside the usual GDScript boundaries.

I went as far as downloading VS2019, Python and Scons, cloning Godot to my hard drive, adding this module and building Godot only to realize I already had the .exe and some banks ready to go. The big "ohhhh" moment was seeing the FMOD integration demo pop up on the project list after I threw everything into one folder for the heck of it.

This is probably a fantastic tool for musicians like myself who are new to software dev (I'm already incredibly grateful to you and the contributors for giving me another option for audio) but this extra step in documentation would make it so much more approachable for people like myself.

DeerTears avatar Aug 03 '19 04:08 DeerTears

Hi there ! Having demo project in release seems a good idea to me. We plan do it on fmod addon side when unit testing will be done. If @alexfonseka is ok, I will modify travis ci to include it in release, when it's done on our side, so both repos keeps same features. You should be aware that we cannot make this demo project runnable without any action from yourself. We cannot include fmod librairies in it as fmod is not open source.

piiertho avatar Aug 03 '19 08:08 piiertho

Ah yeah that is true, although obtaining the .dlls is already made nice and clear and seems like a fair-enough extra step to load the demo project.

DeerTears avatar Aug 03 '19 15:08 DeerTears

Including the demo project with the release certainly sounds like a good idea, specially for newcomers. However, as @piiertho already mentioned, the project cannot be made runnable without some manual intervention. The FMOD library files should only be obtained directly from the official website (as per the terms of service).

If @alexfonseka is ok, I will modify travis ci to include it in release

@piiertho That's fine by me. Feel free to PR this later.

It'd also be nice to be redirected/shown how to retrieve banks from an FMOD Studio project.

@DeerTears Ideally we expect you to have a basic understanding of how FMOD Studio works before jumping into scripting. There's plenty of resources available on FMOD's docs pages that'll teach you the basic concepts. Here's one on building bank files.

Also, I understand the frustration. One of the goals of the project is to make FMOD Studio accessible to Godot users with a limited programming background. Working with the GDScript syntax and the various helper functions is a much pleasant experience for beginners than working with C++ 😅.

I would also like the demo project to be a bit more fledged out. So perhaps this is an area where you could chip in a contribution.

heraldofgargos avatar Aug 06 '19 02:08 heraldofgargos