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

STK Doc Improvements #338

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

tdug
Copy link
Contributor

@tdug tdug commented Sep 12, 2022

More changes to come on this, mostly filling out more docs.

I haven't yet gotten a working version of StkBowed... I think there's a glitch in the .cpp to sort out.

Platform.userExtensionDir ++ "/SC3Plugins/StkInst/rawwaves",
Platform.systemExtensionDir ++ "/SC3plugins/StkInst/rawwaves",
Platform.systemExtensionDir ++ "/SC3plugins/StkInst/rawwaves"
].select({ |possiblePath| File.exists(possiblePath) }).first;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's probably a more pragmatic way to handle this.

Also, I think the folder got renamed at some point in the history of these plugins.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the lines 35 and 36 as well as 37 and 37 seem to be the same?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@telephon - They're extremely similar. The only difference is the case of p/P.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've seen these paths declared in multiple ways and I'm wondering if the path has changed over time with the codebase. Is there a "correct" version of this filepath for the most updated version of SC?

Copy link
Member

@dyfer dyfer Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure it's "correct", but previously I used the ".filenameSymbol" method to get the path of the class file, which allowed me to get a reference to where the class is installed, without any assumptions as to where the extension is installed.

Here we could do

var path = StkInst.filenameSymbol.asString.dirname.dirname +/+ "rawwaves";

@sonoro1234
Copy link
Contributor

I haven't yet gotten a working version of StkBowed... I think there's a glitch in the .cpp to sort out.

StkInst is a different wrapping than StkUGens (It was done because of StkUGens failures) . In StkInst help you should get a working Bowed instrument example

@dyfer
Copy link
Member

dyfer commented Nov 14, 2022

Is this ready to be reviewed or are you still working on this @tdug ?

@tdug
Copy link
Contributor Author

tdug commented Jan 22, 2023

Is this ready to be reviewed or are you still working on this @tdug ?

I've pushed one more change to this, but don't plan to contribute these docs further in the near future.. Sorry for the forever-taking reply, I've been quite busy.

I'm happy with this being reviewed as-is, as I believe it's a net contribution.

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.

None yet

4 participants