CoyoteMIDI

View Categories

Script Submission Guidelines

1 min read

Scripts submitted to the official CoyoteMIDI script hub are expected to adhere to a high standard. Scripts may be edited or removed without notice to protect the users of CoyoteMIDI. Make sure to store a copy of your script and its description locally. When posting a script, make sure to follow the requirements and guidelines thoroughly.

 

Requirements

1. General

  • Do not submit your script with a script title that is intentionally hard to distinguish from another script.
  • Do not submit your script under an account name that is intentionally hard to distinguish from authors of other scripts.
  • Increment your script version by one integer number every time a functional change to your script is made.
  • always update the ‘Minimum CoyoteMIDI Build’ to the version that you last tested your script on whenever a change is made.

 

2. Conventions

  • When using global variables, use long, distinct, unique, and easily identifiable variable names. The snake case naming convention is preferred. Example: ‘%my_script_title_my_variable_name’
  • Do not hardcode references to your script name. Users can freely choose the name they store your script under. Use the ‘default’ script command argument in commands to reference your script, or the scriptcontext script command instead.

 

3. Security & privacy

  • Do not track or otherwise remotely store user information without their explicit and informed consent. This also applies for anonymous data.
  • Do not attempt any third party authorization or authentication on behalf of the user without their explicit and informed consent.
  • When storing any sensitive user data, even locally, make sure to use the encrypt script command to encrypt the data.

 

Recommended Guidelines

1. Script Information

  • Try to ensure your script title describes your script effectively with only a few words.
  • Make sure your script description explains clearly how to use your script, which translation parameters it introduces, and what they do.

 

2. User Experience

  • Do not use the print command to display information to the user. This command is for debugging. Use the messagebox script command to display information to the user instead.
  • Do not use the error script command to display information to the user. This command is used for scripts that are designed as an API to inform other script developers about an invalid usage of your API script. To display an issue to the user, use the messagebox script command instead.

3. Other

  • If you are a part of our Discord community, consider enabling “Verified Discord roles” in the general settings. This will grant you a “Verified Scripter” role if your script gets verified, which will help other members of our Discord community to easily identify script developers.