justin/discord-auto-upload
1
0
Fork 0
Code Issues 15 Pull Requests 1 Actions Packages Projects Releases 20 Wiki Activity

Let's commit to the go version

Browse Source
This commit is contained in:
Justin Hawkins
2017-02-20 21:58:28 +10:30
parent 6c3cb6066d
commit 29fc0c67c9
3 changed files with 12 additions and 221 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
README.md
View File

@@ -1,6 +1,6 @@
# Automatically upload screenshots from your computer into a discord channel
This script automaticall uploads new screenshots that appear in a folder on your computer to Discord and posts them in a channel:
This program automaticall uploads new screenshots that appear in a folder on your computer to Discord and posts them in a channel:
![Screenshot](http://i.imgur.com/QPS9V6f.jpg)
@@ -10,71 +10,17 @@ Point it at your Steam screenshot folder, or similar, and shortly after you hit
* A folder where screenshots are stored
* A [discord webhook](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
* This script and perl, or one of the provided binaries
* This program
## Getting started
### Linux
### Binaries
#### Standalone binary
* Grab the latest binary from `https://github.com/tardisx/discord-auto-upload/releases/latest` called 'dau-linux.gz'.
* `gunzip dau-linux.gz`
* `mv dau-linux dau`
* `chmod +x dau`
* put `dau` somewhere on your path
#### From Source
* Download the script:
`curl -O https://raw.githubusercontent.com/tardisx/discord-auto-upload/master/dau`
* Put it somewhere on your path (if you want to be able to run it from anywhere)
* chmod +x it
* Install the dependencies:
CPAN: `cpan install Mojolicious IO::Socket::SSL`
CPANM: `cpanm Mojolicious IO::Socket::SSL`
Ubuntu/Debian: `sudo apt-get install libmojolicious-perl libio-socket-ssl-perl`
* test it:
`dau --help`
### Mac
#### Standalone binary
* Grab the latest binary from `https://github.com/tardisx/discord-auto-upload/releases/latest` called 'dau-mac.gz'.
* `gunzip dau-mac.gz`
* `mv dau-mac dau`
* `chmod +x dau`
* put `dau` somewhere on your path
TBD
#### From source
Basically the same as Linux above. [Perlbrew](https://perlbrew.pl) is highly recommended so as not to disturb the system perl. No need for superuser access then either.
### Windows
* Grab the latest windows exe
`https://github.com/tardisx/discord-auto-upload/releases/latest`
* Optional, put it somewhere on your path
* Open a command prompt
* Test it
`\some\path\dau --help`
If you want to hack it, audit it, or don't trust my exe, you can install
[Strawberry Perl](http://strawberryperl.com) and run it using that directly.
You'll need the same dependencies mentioned above in the Linux setup.
If you want to build your own .exe, see BINARIES.md
TBD
## Using it
@@ -88,32 +34,23 @@ If `dau` is on your path, you can run it from your screenshot folder and there i
Note that currently `dau` does not look in subdirectories. Please submit an issue if this is a use case for you.
The only mandatory command line parameter is the discord webhook URL:
The only two mandatory command line parameters are the discord webhook URL:
`--webhook URL` - the webhook URL (see [here](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks) for details).
and the directory to watch:
`--directory /some/path/here` - the directory that screenshots will appear in.
You will have to quote the path on windows, or anywhere where the directory path contains spaces.
Other parameters are:
`--watch xx` - specify how many seconds to wait between scanning the directory. The default is 10 seconds.
`--directory <somedir>` - the directory to watch for images to appear in. If this option is not supplied, will look in the current directory.
You will have to quote the path on windows, or anywhere where the directory path contains spaces.
`--username` - supply a 'username' with the webhook submission. Slightly misleading, it basically provides some extra text next to the "Bot" display on the upload to the channel.
In the example screenshot at the top of this README, this was set to "tardisx uploaded from EDD".
`--debug` - provide extra debugging.
## Example
![Example output while running](http://i.imgur.com/cU7z13Y.png)
## Limitations/bugs
* Only files ending jpg, gif or png are uploaded.
* Subdirectories are not scanned.
* If multiple screenshots occur quickly (<1 second apart) not all may be uploaded.
## TODO