forked from Github/Axter-Stash
Changed Plugin name
This commit is contained in:
35
plugins/FileMonitor/README.md
Normal file
35
plugins/FileMonitor/README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# FileMonitor: Ver 0.1.0 (By David Maisonave)
|
||||
FileMonitor is a [Stash](https://github.com/stashapp/stash) plugin which updates Stash if any changes occurs in the Stash library paths.
|
||||
|
||||
### Using FileMonitor as a plugin
|
||||
- To start monitoring file changes, go to **Stash->Settings->Task->[Plugin Tasks]->FileMonitor**, and click on the [Start Library Monitor] button.
|
||||
- 
|
||||
- To stop this task, go to **Stash->Settings->Task->[Task Queue]**, and click on the **[x]**.
|
||||
- 
|
||||
|
||||
### Using FileMonitor as a script
|
||||
**FileMonitor** can be called as a standalone script.
|
||||
- To start monitoring call the script and pass any argument.
|
||||
- python filemonitor.py **start**
|
||||
- To stop **FileMonitor**, pass argument **stop**.
|
||||
- python filemonitor.py **stop**
|
||||
- After running above command line, **FileMonitor** will stop after the next file change occurs.
|
||||
- The stop command works to stop the standalone job and the Stash plugin task job.
|
||||
|
||||
### Requirements
|
||||
`pip install stashapp-tools`
|
||||
`pip install pyYAML`
|
||||
`pip install watchdog`
|
||||
|
||||
### Installation
|
||||
- Follow **Requirements** instructions.
|
||||
- In the stash plugin directory (C:\Users\MyUserName\.stash\plugins), create a folder named **FileMonitor**.
|
||||
- Copy all the plugin files to this folder.(**C:\Users\MyUserName\\.stash\plugins\FileMonitor**).
|
||||
- Restart Stash.
|
||||
|
||||
That's it!!!
|
||||
|
||||
### Options
|
||||
- All options are accessible in the GUI via Settings->Plugins->Plugins->[FileMonitor].
|
||||
|
||||
|
||||
Reference in New Issue
Block a user