-
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Documentation Update:Webgl - .lib files not supported #7454
base: main
Are you sure you want to change the base?
Conversation
🎉 Thanks for opening this pull request! Please check out our contributing guidelines if you haven't already. And be sure to add yourself to the list of contributors on the readme page! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making these changes! I just left a few comments about how we might make the text a bit more easily understandable to users.
src/webgl/loading.js
Outdated
@@ -26,6 +26,8 @@ import './p5.Geometry'; | |||
* `loadModel('assets/model.obj')`. URLs such as | |||
* `'https://example.com/model.obj'` may be blocked due to browser security. | |||
* | |||
* Note: Currently there is no support for `.lib` files. Only `.mtl` files are supported for defining materials. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rather than just mentioning formats we don't support that users may not have heard of, maybe we can phrase this like, "if you are loading a .obj file that references materials stored in .mtl
files, p5.js will try to load those materials." and maybe mention something about making sure you upload them alongside your obj if you want them to be read.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@davepagurek Thankyou for the feedback!
I have made the required changes. Let me know if any further modifications are required.
@@ -143,5 +143,8 @@ | |||
"hooks": { | |||
"pre-commit": "lint-staged" | |||
} | |||
}, | |||
"dependencies": { | |||
"p5": "file:" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we don't need these changes just to change the documentation. You can reset them with git checkout main -- package-lock.json package.json
and then commit the results.
Resolves #7381
Changes:
.lib
files not being supported for WebGL.Screenshots of the change:
PR Checklist
npm run lint
passes