Search the Community

Good evening all, I am extremely happy to present to you - Emby Scripter-X version 3.0 (up on the catalog now!) The major change in this version is -- Packages -- ! This gives you the opportunity to develop packages for Scripter X for others to install and use. And very soon, there will be a Packages catalog available that you'll be able to search for, and install community packages, straight from your Emby Administration Console. A package is written in Javascript. A Package requires 3 things - 1) a PackageInfo.json file, 2) a Package.js file, and 3) both these files zipped up together in a .ZIP file. PackageInfo.json provides vital information about your package to ScripterX. It's format is as follows :- { "Id": "scripterx.package.example", "Name": "Example Package", "Description": "An example package for the ScripterX package system.", "Author": "Anthony Musgrove", "Email": "anthony@emby-scripterx.info" } Package.js is the javascript file for your package - where all your code exists. This is the fun bit. Some important things to know about your script: - When your package is initialised by ScripterX (on installation, and on server startup), a function in your Package.js is executed. It is called _package_init(): function _package_init() { //do something here on package startup } - Your script can subscribe to ANY of the ScripterX events, by adding a function with the name _EventName, for example, if you wish to subscribe your package to the onAuthenticationFailed event, you'd simply enter: function _onAuthenticationFailed(context) { //do something here when someone fails to authenticate to emby. } *** Note, the parameter for these functions is context, which is the context of the event call. It contains all the information regarding token values, etc, that you have full access to. For example, to get the username of the attempted failed authentication, you could use :- function _onAuthenticationFailed(context) { var attempted_username = context.Token("%username%").value; } - Same goes for any of the other events, events being: onAuthenticationFailed, onAuthenticationSuccess, onLibraryScanComplete, onMediaItemAdded, onMediaItemRemoved, onMediaItemUpdated, onPlaybackStart, onPlaybackStopped, onScheduledTask, onSessionEnded, onSessionStarted, onCameraImageUploaded, onLiveTVRecordingStart, onLiveTVRecordingEnded, onScheduledTaskStart, onScheduledTaskEnded, onMediaItemAddedComplete, onPlaybackProgress - To log output from your package to the Emby server log, you can utilise the ScripterX.Log functions, they are :- ScripterX.Log.Info("Add an Info log entry to emby server log."); ScripterX.Log.Error("Add an Error log entry to emby server log."); - If you need timers, ScripterX has timers. You can simply create, delete, start, restart or stop a timer by using the following Timers commands : Create a timer that only elapses once, but can be restarted manually after its elapsed, by using .createOnce: ScripterX.Timers.createOnce("myTimer", 5000, "tmrMyTimer_Elapsed", null); or, create a timer that elapses every interval, without having to be restarted, by using .createRepeating: ScripterX.Timers.createRepeating("myRepeatingTimer", 10000, "tmrMyRepeatingTimer_Elapsed", null); - When your timer elapses, it will call the function set in as your callback. For example, when my timer elapses, it will call the following function: function tmrMyTimer_Elapsed(timer_name, timer_interval, objects) { //do something here when my timer elapses, the timer's name is given here too. //timer name is needed to start, stop, restart, delete etc. } - ScripterX supports webhook posts right from your javascript, you can perform a webhook post by using the ScripterX.Web functions, for example, in my _onPlaybackStart function, I want to post to a webhook every time someone starts playing a movie or TV show on my server, I can do this by: function _onPlaybackStart(context) { /* Send a webhook when (someone) plays (something) */ var api_url = "https://myapi.url.com"; var playback_info = {}; playback_info.itemId = context.Token("%item.id%").value; playback_info.itemName = context.Token("%item.name%").value; playback_info.userName = context.Token("%username%").value; playback_info.deviceName = context.Token("%device.name%").value; playback_info.serverName = context.Token("%server.name%").value; playback_info.memo = playback_info.userName + " is playing " + playback_info.itemName + " on device " + playback_info.deviceName + " from server " + playback_info.serverName; ScripterX.Web.Post(api_url, JSON.stringify(playback_info)); } - Once you've created your Package zip file for distribution, you can install it on your Emby server by using the Emby Scripter-X package installer interface, as shown below: - While you're testing your package, you don't have to keep uninstalling and reinstalling your package to test and debug. Simply install your package ONCE, then navigate to your Emby data directory, find ScripterX, then find Packages, then find the folder labelled with your package's assigned installationId. Inside this directory, you'll notice Package.js. Make changes directly to this file, then go back into your Emby administration panel and click the 'Reload' icon next to your package listed in your 'Installed Packages' panel. The reload icon is next to the uninstall/delete icon. If you wish to uninstall a package, simply click the trashbin, then confirm by clicking 'Really Uninstall?' There is MUCH, MUCH more to come, but for now this will get people going. There are other function groups that I am going to implement including Library searching and Item manipulation, User manipulation and searching, among many, many other functionality. Please enjoy, and as always, any comments, feedback, suggestions are MUCH MUCH appreciated. Emby ScripterX (github: https://github.com/AnthonyMusgrove/Emby-ScripterX) Project/Product Website: https://www.emby-scripterx.info/ Version v2.3.4 now up on the Emby Plugin Catalog & GitHub with changes. Events supported: On Authentication Failed, On Authentication Success, On Playback Start, On Playback Stopped, On Session Started, On Session Ended, On Media Item Added, On Media Item Updated, On Media Item Removed, on Scripter-X Scheduled Task, on Library Scan Completed, On Camera Image Uploaded, on Live TV Recording Start, on Live TV Recording Ended, onScheduledTaskStart, onScheduledTaskEnded, onPlaybackProgress, onMediaItemAddedComplete For tokens available, please see GitHub readme, or check out the Actions interface in the plugin - you can find the plugin in the Emby Server Catalog, under 'General'. ChangeLog Changes for 2.3.4: Major core rewrite Added conditions (drag and drop) Rewrote token parser and added contexts Added event onPlaybackProgress (which supports transcoding detection) Added event onMediaItemAddedComplete which is called virtually, after an onMediaItemAdded + Meta Data (or timeout of 40 seconds, whichever comes first) Added IP address tokens for Authentication events Various other modifications and changes Changes for 2.3.1: %item.library.name%, %item.library.type% issue resolved Added confirmation on delete for actions (theme friendly) Remove 'Global Tokens' section in Actions interface (they're listed now for each event) Changes for 2.3.0: Variables are now case-insensitive, refactoring a lot of the interface code (Prototype-to-production), cleaning interface, addressed various GitHub issues. Changes for 2.2.9: Progressively from v2.2.6, functionality to enable or disable events individually, many more tokens (please see GitHub tokens list or the Actions interface), global tokens (server version, uptime, etc), more item tokens (for example, season number, episode number, item meta (imdb id, tmdb id, whatever you wish), season meta, series meta, plus plenty more! Changes for 2.2.5: Aesthetics on Actions Interface (enlarged textboxes for script and interpreter, better alignment of add buttons) Changes for 2.2.4: Progessively from v2.2.0 to v2.2.4, integration with a sortable library, actions user interface customisation and remembering custom order within browser local storage. Changes for 2.2.0: Now theme friendly and compatible, changes with theme selection correctly. Changes for 2.1.9: Redesign Events/Actions interface for less clutter Please ignore the 'Advanced' tab, It won't be there in the next catalog release, its just used for debug at this stage. Changes for 2.1.7, 2.1.6, 2.1.5, 2.1.4: Progressive changes to implement Live TV Recording Events. 'Emby Scripter-X DVR Manager' was implemented in the codebase to handle all Live TV events, tokens and logging. Changes for 2.1.3: Addressed bug with %item.library.*% tokens with respect to onItemRemoved event. (see https://github.com/AnthonyMusgrove/Emby-ScripterX/issues/2 for info!) Changes for 2.1.2: Added new event - onCameraImageUploaded. This event is triggered when a user uploads an image to the Emby Server via the 'Camera Upload' functionality within the various Emby Apps. Tokens supported are as above. Below is an image of the event on the Actions page, along with an image of a sample batch script and output: Changes for 2.1.1: Actions now utilises the entire available interface space; so editing and viewing are much easier. Some input validation added for Interpreter and Script Some cosmetic modifications :- on adding new action, delete/trash button is now changed to 'X' so it indicates 'remove this unsaved action'. Once a new action is saved, the 'X' icon will change to a 'trash/delete' icon, signifying 'delete this action from the server'. Changes for 2.1.0: Bug fix for " in script name, parameters, interpreter. various other bugs, interface bug fixes very stable at this stage. Changes for 2.0.0: Redesign Interfaces, add Actions interface, Community interface (as tabs) Redesign core Allow multiple script actions for each event Changes for 1.0.0.8 - Various updates/changes: Addressed issues with having to supply entire path to interpreter. Implemented better way to detect OS platform (IsWindows() IsLinux() IsOSX()) Powershell.exe, cmd.exe, /bin/bash or a custom executable is now supported Examples now: using powershell.exe as interpreter: -File "D:\embyscripts\ScripterX-test.ps1" -Name %item.name% -ID %item.id% -Type %item.type% -LibName %item.library.name% using cmd.exe as interpreter: /s /c D:\embyscripts\test.bat AuthFail %username% %user.id% %device.id% %device.name% using /bin/bash /home/medius/scripts/test.sh AuthOK %username% Changes for 1.0.0.7: on Library Scan Completed : D:\embyscripts\test.bat Library Scan Complete! Library Scan Complete! Changes for 1.0.0.6: %item.update.reason% : Media Item Updated "1917" "D:\Media\Movies\1917.2019.1080p.BluRay.x264.AAC5.1-[YTS.MX] - Copy.mp4" (Update Reason: MetadataEdit) ‪D:\embyscripts\test.bat Media Item Updated "%item.name%" "%item.path%" (Update Reason: %item.update.reason%) 1.0.0.5 additions: %series.id%, %series.name%, %season.id%, %season.name% : PlaybackStart ItemID: 593 - Name: "Brian: Portrait of a Dog" - Path: "D:\Media\TV\Family Guy\S01\S01E07 - Brian - Portrait Of A Dog.avi" - Username: Anthony - DeviceName: Firefox - ItemType: item type: Episode - LibraryName: TV - LibraryContentType: tvshows (seriesname: Family Guy) (season: Season 1) ‪D:\embyscripts\test.bat PlaybackStart ItemID: %item.id% - Name: "%item.name%" - Path: "%item.path%" - Username: %username% - DeviceName: %device.name% - ItemType: item type: %item.type% - LibraryName: %item.library.name% - LibraryContentType: %item.library.type% (seriesname: %series.name%) (season: %season.name%) README is on Github. Comments/Feedback/Suggestions are GREATLY appreciated. On Scheduled Task: A field now exists to specify a script to run as a scheduled task - you'll now see under 'Scheduled Tasks -> Application' an Emby ScripterX Scheduled Task. No tokens are yet available to this field - need feedback/suggestions/comments on what should be available to specify as parameters/tokens.

UPDATED: 2-13-14 I updated the configuration I am using...again. I was getting random missed events with the original configuration and now its working much better. Not perfect, but much better. You should be able to use this for any media player you use. You just need to point the entries which say "EDIT" to the program of your choosing. I found out the reason for not being able to capture the focus of the program. There is a plugin called "Task Create/Switch Events". This will help determine when an application has been brought to front, closed or minimized. The catch is that you need explorer to be running in order to capture "Task" events. So I am stuck capturing process events which has been a bit more tricky to get to work right. -- If anyone knows about creating python scripts and would like to create a script to make EventGhost better at this whole convoluted process, then be my guest and let us know what you come up with -- Changes 2-13-14 1. Pre-Starts 'media program' (PowerDVD, JRiver, Total Media Theater, etc..) at initial boot then after 20 seconds, the 'media program' is minimized, sent to the back and Media Browser is brought into focus. Reason I changed it to 20 seconds is during a cold boot, it takes time for the media program to be loaded, and the process I capture is created before the program shows up so adding the extra time makes EventGhost wait till the next step in the process. 2. Added a "Left Mouse Click" to certain areas. I had issues with PowerDVD loosing focus after it loaded, even though it was on top and maximized. Probably due to more processes being created. So this left click was the only way I found so far to get it back into focus. Maybe I should have EG wait 30 seconds or so to pre-load the media program to keep it in focus. 3. Cleaned up Event Tree Notice - This IS NOT meant to be a plug and play setup but with a few tweaks you should be able to get it to work. This is meant to put you on the right path for a working Work-Around. - You will need to capture the proper events specific to the program you are using. Example, Process.Destroyed.PDVDLP is actually telling me that PDVD has been sent to the rear or closed. The PDVDLP portion is PDVDLP.EXE so you will need to start up your media program, then minimize it and watch for the specific events on the left hand side column in Event Ghost which will give you realtime list of all events its monitoring. I can try and help you out if needed. ---------------------------------------------------- Updated Original Post: Soon to be a completed HOW TO. In my quest to make this work "for now" untill MBT becomes beta or further and plugins are offered, I continued to find a way to get automatic disc playback when MBT is used as windows shell (not explorer). When Explorer.exe is closed or not used, Windows looses all the AutoPlay functions we use. Instant Sheller is what I used to make MBT Windows Shell MBT Program Path (C:\Users\*UserAccount*\AppData\Roaming\MediaBrowser-Theater\System\MediaBrowser.UI.exe) Download Event Ghost Download EventGhost Tree XML (As a template) (Updated 2-13-14) When loading Event Ghost, go to "FILE" and "OPEN" then browse to EventGhost Tree.xml. I ended up capturing the system event...."System.DriveMounted.E" and "System.DriveRemoved.E" to auto start PowerDVD13 and play the disc and close PowerDVD13 when ejecting the disc. The. ".E" is the drive letter. Though I have yet to capture the correct even to get PowerDVD to close when I press the STOP button. I need to conversate with the folks at EG some more to see if someone can write a script with that. A picture of the event tree. This is setup for PowerDVD13 but can easily be adjusted for another program Picture Updated 2-13-14