在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):Roll20/roll20-api-scripts开源软件地址(OpenSource Url):https://github.com/Roll20/roll20-api-scripts开源编程语言(OpenSource Language):JavaScript 93.3%开源软件介绍(OpenSource Introduction):Roll20 API ScriptsThis repository is the collection of all the community-contributed API Scripts that are available for use on Roll20. ContributingIf you want to help improve an existing API script, just clone this repository, make your changes, and submit a pull request. If you would like to contribute a new script for the community to use, just clone this repository and create a new folder with the name of the script which matches the name in your API Documentation:
If you aren't familiar with Github or Git in general, see Beginner's Guide to GitHub and/or Git Guide on the Community Wiki. If you still need help, post a question on the Roll20 API forums contact contact Roll20 and we can help you get set up. Creating a script.json FileWhen you are ready to submit your script for public use, create a
Validating script.jsonAs of January 29, 2021, pull requests must pass validation of the If you want a web-based JSON Schema validator, this one works well. Paste
the schema on the left, your Post-validationAfter we have reviewed your script and approve it, we will merge in your changes which will make them available to everyone. If we reject your script, we will comment on your Github commit and let you know what changes need to be made before it can be accepted. Accepted File TypesThe following are the only file types we typically accept in a pull request:
If you have a file type in your pull request that is not in this list, please leave a comment as to why and we will review on a case-by-case basis. Update the WikiAfter making any changes to a script or adding a new one, it's great if those changes are updated on the Roll20 Community Wiki's API:Script Index. If you're making updates to an existing script, please find that script from the list and update:
If you're contributing a new script that has been accepted and merged in, it helps to create Wiki page for it. The naming convention for scripts is "https://wiki.roll20.net/Script:Script_Name". Please format your listing from the existing style. You can find an example at (https://wiki.roll20.net/Script:Example). Useful things to document for an API Wiki page:
After you've added the page, please go to the API Script Index and add a link to your listing in the appropriate category. GuidelinesHere are a few guidelines that you should follow when contributing API scripts for the community: Be Clear and Concise Community API scripts should be built from the ground up with the intention of sharing with others. The script's name should be a good indicator of what the script does and how it should be used. A script named Try to use short and descriptive function and variable names. Problematic names like Make Your Script Accessible Please take every effort to format your code in a traditional manner and present the script in a legible state. Leaving comments on the intended use of functions and code blocks can be very useful to future contributors. Near the top of your script should be a comment providing the script's name, version number, the last time it was updated, and a short breakdown of the scripts intended use. In the breakdown should be included the script's description, syntax, and configuration options. It is important to add configurable elements near the top of the script in an easily demarcated area with comments on how those elements can or should be customized. If your API is complex, it might be useful for the API to create an in-game handut containing User instructions. Having a command like Limit Your Script's Footprint Include namespaces for your functions and variables, to avoid potential conflicts with other authors. Placing your functions and variables inside a unique namespace to your script protects both it, the user, and other community scripts. Do your best to limit what your script is manipulating at any given moment to achieve it's desired result. Add API It's also smart to make it possible to enable/disable whether the API can be used partially,fully, or not at all by the players. LicenseAll of the code of the API scripts in this repository is released under the MIT license (see LICENSE for details). If you contribute a new script or help improve an existing script, you agree that your contribution is released under the MIT License as well. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论