Frequently Asked Questions
- General
- What is the BPyC?
- Who is in charge of the BPyC?
- Who can contribute scripts to the repository?
- How will such a potentially large database be maintained?
- Some authors already have a website for their scripts, how do they interact with the BPyC?
- Scripts
General
Q: What is the BPyC?
A: The main job of the BPyC will be the maintenance of a script database. The script database will enable authors to upload their scripts to a central, permanent place of storage accessible to all users. In addition, the BPyC will provide an integrated solution to enable users to download and update scripts from the database.
Q: Who is in charge of the BPyC?
A: Levi Schooley (reD_Fox) is currently the only person "in charge" of the BPyC. Hopefully, in the near future, a committee of people proficient in Blender Python programming and documentation will be chosen. They will have managerial control over the scripts and content within the BPyC. It is hoped that enough people will be willing to donate their time so that the tasks are not too heavy for each member of the committee to handle.
Q: Who can contribute scripts to the repository?
A: Anyone! That's the important part. All an author needs to do is create an identity with the BPyC, upload the script(s), supply the necessary metadata infomation about the script, and the script will be immediately available for download to the entire world.
Q: How will such a potentially large database be maintained?
A: Unlike most previous systems, the BPyC is centered on the authors. It depends on a "self maintaining" web system where the authors independantly maintain their own scripts with little or no intervention from the developers or organizing members (committee) of the BPyC. The committee is there only to maintain order should someone decide to do something stupid.
Q: Some authors already have a website for their scripts, how do they interact with the BPyC?
A: The BPyC cannot "link" to external scripts (the web is too transient). If an author wants to use the BPyC to host a script, it will have to be uploaded as a separate entity. If the author creates a new version of that script, it will be their responsibility to update the script in the BPyC database as well.
Scripts
Q: How do I create a script?
A: First, you must create an account and log in. Then, go to your profile (should appear as "Manage your scripts/profile" in the navigation bar on the left). Towards the bottom, you should see a link titled "Add new script." Add a new script and fill out the script information, then add a new version and fill out the version information (including release notes, chages from previous versions, etc.), and finally, edit the version and add the necessary files. A script must have at least one valid version containing at least one valid file before it will be displayed in the repository.
Q: How do I add files to my script?
A: In the BPyC script repository, the script itself does not contain the script files. The script's versions do. This enables users to discover if an updated version of a particular script is available for download, while still having access to earlier versions and files. After you have created a script, add a version to it. Then, edit the version to upload the necessary files.
Q: Why isn't my script showing up in the repository?
A: A script must have at least one valid version containing at least one valid file before it will be displayed in the repository. See How do I create a script? and How do I add files to my script?. If you've done all this, contact us, you've probably found a bug.
Q: Are there any special guidelines for scripts stored in the repository?
A: Yes. The BPyC repository attempts to make installing scripts a transparent process to the user. It is the goal that every script in the repository, after being downloaded using the BPyMan script manager, will be immediately accessible via the scripts menu. This means that if your script requires a special environment, you should attempt to make it self-installing, or at least provide a message to the user if it is executed incorrectly. At a bare minimum, your script should consist of at least one .py file with the appropriate BPy headers to be recognized by Blender. Provision has also been made for multiple files and directories, if your script requires them.
Ways you should not store your scripts:
- Packaged in a .blend
If you need a special Blender environment, it is best to either use the script itself to create it, or to inform the user before-hand how to properly execute the script. You may provide links, images, documentation etc. in your script description, if that will help. Also, scripts in .blend files will not be displayed in Blender's script menus. - Packaged in an archive
Files in archives will not be accessed by Blender or the BPyMan script manager, and hence will not be available in the script menus.
Currently, you can store your scripts in any form in the repository, and just use it like a web host. However, this will probably change in the future to prevent abuse, so it would be best to stick with .py files with BPy menu headers.