Issue when using GitHub with FMOD Studio Project collaboratively and a possible solution?

Hello!

I’m a lecturer at a University that uses FMOD integrated with Unity. At our University we have courses where several students work within a shared FMOD-project with the help of GitHub source control. Though, our students repeatedly encounter problems with the source control of the Workspace.xml file (I’m guessing they use different build paths and/or asset folder paths, or similar differences in settings). To solve the problem we’ve found that once everyone has cloned the project, and everything works properly, we can simply delete this file completely from the source control (but keep it in each user’s local folder) as well as add it to our .gitignore. I hope this helps anyone struggling with this. And if anyone has a better solution or if there are any issues I don’t know about with this solution, please don’t hesitate to correct me and explain the proper way of working.

/Sebastian

1 Like

Hi Sebastian,

Thank you for sharing the solution here!

Your approach of keeping this file out of source control sounds reasonable based on the behaviour you described.

If you haven’t already, It might also be worth reviewing the recommended .gitignore setup here, as we suggests excluding user/local data such as .cache, .user, and .unsaved from source control:

Hope this helps!

Hi,
Thanks for the response and glad to know that our solution is reasonable. Those folders you mention are already in our recommended .gitignore setup as well, but thanks for the info anyway.

We simply recommend writing this, which I think should result in the same behaviour (not to source control folders with a dot before their names) :slight_smile:
#Ignore these FMOD-files
.*/
!.gitignore

/ Sebastian

1 Like

I too have had this issue, but I’ve found that removing the workspace.xml file from source control is only a good solution if only one person is building banks.

It resolves the issue of needing to have identical asset and build paths on each person’s computer, but if you want to use anything other than default settings for bank building, you now need to synchronise these settings manually between everyone who wants to build the banks, or designate one person to be the bank builder.

I wish these could be stored in separate files, so that the asset and bank paths could be ignored in source control, but the bank build settings be maintained and synchronised for all users. The best solution I have found so far is to make sure everyone has an identical folder structure between the game project and FMOD project, so that the relative file path stored in workspace.xml can stay the same for everyone.

My other qualm with this is that it fails silently — if someone has modified the workspace.xml file to a new build path that doesn’t exist on my machine, when I go to build the banks FMOD doesn’t tell me, and instead goes ahead and makes that new directory, populating it with the banks. When I try to test my changes in the game engine, the old banks are still there, and it can take a little while to realise that these are not being replaced when rebuilding the banks.

2 Likes