loonghao / photoshop-python-api

Python API for Photoshop.
https://loonghao.github.io/photoshop-python-api/
MIT License
625 stars 71 forks source link

About the bottomed API reference #333

Open zhougeAI opened 7 months ago

zhougeAI commented 7 months ago

Hello author! Thank you very much for your efforts in using Python to automate Photoshop creation. I need to use Photoshop scripts to create high-definition datasets recently, and combine some features in Python, so I learned about the Photoshop Python API. But when I checked the official documentation, I felt very confused. The examples and API references inside only provided some simple introductions, and many functions were not clear about their specific usage and sources, which caused me to encounter obstacles in implementing my functions. Through searching for solutions and gaining insights from multiple sources, I discovered the usage of many functions in Photoshop VB Script Reference ( https://community.adobe.com/havfw69955/attachments/havfw69955/photoshop/556207/1/photoshop-vbs-ref-2020_unlocked.pdf ), which helped me solve my application problem. Therefore, I would like to make a suggestion. Can you mention the Photoshop VB Script Reference in the official documentation so that users can easily refer to the manual, or use it to improve the documentation and clarify the meaning and usage of parameters in more methods? This is very important to users. Thank you very much!

loonghao commented 7 months ago

@zhougeAI Thank you for your feedback. I have also thought about improving the documentation, but since this is just an amateur project, I don't have much energy to support it full-time. Moreover, the existing documentation for Photoshop is not sufficient, and it is in PDF format, which is not convenient for detailed reading and referencing.

I initially referred to this resource and then wrote the code based on the official JavaScript API for Photoshop: https://theiviaxx.github.io/photoshop-docs/Photoshop/

If you have the time and interest, you are welcome to contribute code to this project.