Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme for PC users #135

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

rominator1983
Copy link

@rominator1983 rominator1983 commented Jun 7, 2023

Describing user data in readme for PC users.
Fixes mod-audio/mod-host#59

@rominator1983
Copy link
Author

I was not sure about the $ signs. But I think it is better to ditch them because they are showing up in the readme on the github page of the repository.
If you don't like it I can change it back of course.

@rominator1983
Copy link
Author

Also I have a full description on how to setup MOD on a fresh ubuntu lunar lobster: https://github.com/rominator1983/completeModInstallationManual

I do get that this could be against the interests of your company but since this is open source I thought there could as well be a good description on how to get it working on the PC too. I don't know if you want to point to this repository somewhere in the documentation?

@falkTX
Copy link
Member

falkTX commented Jun 7, 2023

the $ is intended as such instructions are not meant to be blindly copy&pasted, best to understand what it is doing before running random commands.

the thing that really needs fixing is changing git:// url type to https://, rest is mostly fine.
having the user-data files in some visible dir is not a bad idea, but your syntax in this PR is badly formed and does not work. ~/modUserData is a very odd folder name to use too...

mod-plugin-builder uses ~/mod-workdir, so I think might be best to place the files there, then the home dir only gets 1 MOD related dir instead of 2.

in any case, for running mod-ui and host stuff it is best to use https://github.com/moddevices/mod-panel as that sets up virtualenv and other bits all automatically, if the intention is to run it on desktop.
we can add the user-data file setup in there too, which makes more sense vs doing it here.

regarding your installation manual, had a quick look and it is everything but simple... also using mod-host together with pipewire is likely to not work very well, pipewire tends to bind things per client and mod-host creates 1 client per plugin. Carla was in a similar situation and only somewhat recently it began to work proper, IIRC needing some hardcoded hints in pipewire directly so its jack layer works more similar to original jack2 for Carla (mainly for having all clients with the same clock, sample rate and buffersize, which is not always a guarantee under pipewire)

@rominator1983
Copy link
Author

Thanks for your quick response.
I addressed all your mentioned issues in the PR.
By badly formatted you meant the backslashes for the spaces? That's "normal" bash but I changed that to something more readable anyways.
Directory would now be $HOME/mod-workdir/user-data which indeed makes more sense.

As to my manual.
I do not know so much about pipewire under the hood of course. I just badly wanted to stick to Ubuntu without throwing out pipewire as Ubuntu will switch to that in the next LTS. And of course therefor I wanted to know if pipewire-jack works with MOD. And the answer to that is not trivial I know. But at least it is possible (with some adaptions) and works quite well for me and that's good to know for all ubuntu users.

@rominator1983
Copy link
Author

If you gave me a hint on where to put the creation of directories in mod-panel I might provide you a PR. I saw some similar TODOs in mod-ui.sh and mod-sdk.sh and I'm a bit confused.

Creation should there obviously only happen if the directories are not already created.

@falkTX
Copy link
Member

falkTX commented Jun 15, 2023

I added the creation and start of the file-manager in mod-audio/mod-panel@a2d7883 so it goes into the mod-panel repo.
Also added browsepy directly as submodule, though mod-panel GUI does not start it up automatically just yet, the script can be run separately for having that tab inside mod-ui web gui working, just not a priority at all for now.

I am not keen on adding info for creating these local dirs on the mod-ui side to be honest, it relies on the "mod-workdir" concept created in mod-plugin-builder project, which is related to mod-ui due to MOD but something best left aside.
but I also don't know the best place to have these dirs created, perhaps mod-ui should automatically create them as needed and we just mention on the readme the default location for them?

@rominator1983
Copy link
Author

OK for me. I adapted the PR to only mention the possible export and the default directory and the GIT-URI.
Mentioning of the directory only makes sense if the directories are created by MOD-UI though. So that should be added in the same PR to not completely misdirect users as this part just does not work when following the instructions.

I might look into the directory creation to finish this PR but not today. Python is not my primary language and the directories should obviously be created automatically based on a list of file types so new files type directories get created automatically.

I do understand that other things might be more important right now too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

IR-files don't get loaded
2 participants