-
-
Notifications
You must be signed in to change notification settings - Fork 31
Requesting
So you have a request for a script or feature and want to submit it? Read below to learn how to make a good script request.
- Check if script/feature doesn't already exist
- Check if request should be integrated as a feature into another script or as a new script
- Formulate a good request
Before making your request, you should check if your request hasn't already been realised. Someone else might've already requested what you want or a script already has the functionality built in to fulfil your request. So go through the repository first and look at all the scripts to check if there isn't already one available that can do what you want. All scripts are grouped together into folders to make searching for a script easier. Inside each script, a small description can be found about what it does.
Keep in mind that I decide what is possible and what not. So don't start your request with "It's probably not possible, but my request is ...". Your request will most probably be possible, be it in full form or with some things changed. However, it's also the other way around: if I say something isn't possible, than it's not. For example: the limitations listed below can't be fixed anyway, no matter what you suggest.
I'm not the only one with a repository for scripts regarding these software's. Check these out too to check if your request hasn't been fulfilled there:
There are some scripts that have a better version made by someone else. These versions might already do what you want, which avoids a feature request for the version here. See the list below:
There are some limitations that you should keep in mind:
- Controlling plex streams (starting, stopping, changing audio/subtitles, etc.) can only be done locally.
- I can't edit any web-ui. So this isn't possible: "Add a button inside plex/sonarr/radarr/etc. that does xyz". However, I probably can realise the action that the button should trigger. I just can't link it to a button in the web-ui. Often there is an other trigger that works just as well, like when a stream starts or every X minutes.
- I'm very inexperienced in the live-tv/tuner part of plex. For this reason, I can't make scripts that have anything to do with this part of plex.
If you are certain that your request hasn't already been realised and that it falls between the limitations, continue to the next step!
There are two types of script requests: 'Feature request' and 'Script request'. If, in the previous step, you determined that your request can be fulfilled as a feature in an already existing script, than create a 'Feature request'. Otherwise create a 'Script request', where you request a completely new script.
If you aren't sure about what type of request to make, make a 'Script request'. Inform me in the issue that you couldn't decide and I'll help you :).
You are now ready to make your request!
All requests are required to be made on the issues page of the repository. Requests made anywhere else (Reddit comments/private message/chat, Discord server/dm, etc.) will be ignored. When creating a GitHub issue, choose the template that matches the type of request.
If you're going to make a feature request, choose "Feature request" as the template for the GitHub issue or click here.
First give the filename of the script that you want a feature to be added for. Then describe what feature you would like to see. Be clear and precise about what you want.
If you're going to make a script request, choose "Script request" as the template for the GitHub issue or click here.
In your script request, make clear what you want to achieve or what you want the script to do. You can also explain your "problem" and I'll make a script to fix it. Be clear and precise about what you want.
A good request makes it immediately clear to me what you want and I can immediately go to work without asking extra questions. Bonus points if you add an example!
After you've made your request, I'll look at it. If the request isn't clear, more information will be asked. If the request is clear, I will either accept or decline the request.
If the request is declined, the issue will be marked as such and then be closed. If the request is accepted, it is again marked as such and it will stay open until the request is fulfilled. Any additional questions or info will be put as a comment in the issue. It is your responsibility to stay "up-to-date" with the request. You should periodically check if any questions are asked by me or if your request has been completed.
After your request has been completed, you'll want to set it up of course. Learn more about how to setup the scripts here.