We have submission instructions on the new p5.js-website
repo here: https://github.com/processing/p5.js-website/blob/main/docs/contributing_libraries.md
p5.js welcomes libraries contributed by others! Check out the libraries tutorial for more specifics about how to create one. If you have created a library and would like to have it included in the list, follow the instructions below!
- Fork the repo
- Add a file to the
libraries
folder namedyourLibraryName.yaml
(or consider copying an existing library as a starting point) - Inside it, add the following content:
name
: The name of the librarycategory
: A category that you think best fits your library. Your choices include:drawing
,color
,ui
,math
,physics
,algorithms
,3d
,ai-ml-cv
,animation
,shaders
,language
,hardware
,sound
,data
,networking
,export
, orutils
.description
: A one-sentence description of the libraryauthor
: An object containingname
, your name, andurl
, an optional link to your website. If there are multiple authors, use an array of author objects.sourceUrl
: A link to the library's source code (e.g. its repo on GitHub or GitLab)- (Optional)
websiteUrl
: A link to a website for the library - (Optional)
npm
: If applicable, the package name for the library on npm - (Optional)
npmFilePath
: A path like'dist/library.min.js'
if a specific file in the library should be used from npm. You can test this out by going tohttps://cdn.jsdelivr.net/npm/packageName
-- if that doesn't work, tryhttps://cdn.jsdelivr.net/npm/packageName/path/to/file.js
and put the path you added into this property featuredImage
: An object about the preview thumbnail for the library, withurl
, the path to the image in thesrc/content/libraries/images
folder, andaltText
, a short description of its contents for screen readers- (Optional)
license
: A string describing the software license of the library. This may be omitted if your package is on npm and has license info there
- Add a high-res colored image of 1500x1000px of your library into
libraries/images
- Submit a pull request and we'll review your submission
We add libraries that are open-source, includes some documentation and examples, and follow our code of conduct.
If you have any questions, feel free to open an issue or create a work-in-progress PR and ask us anything!