parker 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6de19b17c3640302aaade18a9d582f9f722932c
-  data.tar.gz: c48cf8251883eeee06758cf1ca2751668132e1a6
+  metadata.gz: '0709af93d92931305663713141fe6a67fb9699df'
+  data.tar.gz: 58bb11ca758aa66e6ccb6495eba785c901c1bcd8
 SHA512:
-  metadata.gz: bc6d256b2e12b1fbdb0cd9e0b66d5bc9f173a8c0c130c0333481ce75c9c246828fb9c93e1e027907227c7cf877f7a656f18d9a8f969a8b3ecc09c3fce65810b1
-  data.tar.gz: f4c8445a9b40b25f3499226303de72bb3e752e3fbdc82bc13d7e0ce8e5c3f9925d25f8e7121a2b8f604301cbde65b2287f7f83e3e732471a01929e8753286407
+  metadata.gz: f1a54c242f0ba0b815bfa6e7ca5342c5cc56e4617a8f19383b0b68b3643999bdc5d20faf72ab2d489d35a9176c656530d57a8c148abaddf6a80b8d9d47738915
+  data.tar.gz: f9fa4103f6319804bd295c8c9e823a76e35cdf5398b5dbb2433ce31116f1770d5632a48324c61fc58838fd17111991f96df81b9bad28f7ce29471dad64335080

data/bin/parker

@@ -24,7 +24,6 @@ Usage:
 parker
 Options:
 EOS
-  opt :config, 'Config file path', type: :string, default: File.join(source_directory, 'config.json')
   opt :destination, 'Output directory for screenshots', type: :string, default: Dir.pwd
 end
 
@@ -36,7 +35,7 @@ end
 
 platforms = []
 
-Dir.glob(File.join(source_directory, '*.json')).each do |path|
+Dir.glob(File.join(source_directory, 'platforms', '*.json')).each do |path|
   platform_name = File.basename(path, File.extname(path)).capitalize
 
   if (platform_klass = Object.const_get("Parker::Platform::#{platform_name}"))
@@ -50,6 +49,11 @@ Dir.glob(File.join(source_directory, '*.json')).each do |path|
   end
 end
 
+if platforms.empty?
+  puts "Nothing to do (no platforms found)."
+  exit
+end
+
 output_path = File.expand_path(options[:destination])
 FileUtils.mkdir_p(output_path) unless Dir.exist?(output_path)
 

data/lib/parker/README.md

@@ -0,0 +1,46 @@
+# Parker
+
+This is a very simple tool for organising your video game screenshots. I _love_ my game screenshots, and like to have them neatly sorted by platform and game, but I might just be weird.
+
+It currently supports 3 platforms: Steam, the Nintendo Switch, and the PS4. Please note: you'll still have to, y'know, actually copy them onto a disk somewhere yourself before running Parker. I wish this wasn't still a painful experience, but here we are.
+
+## Installation
+
+Parker is built in Ruby as a gem, and thus:
+
+> gem install parker
+
+And done.
+
+## Usage
+
+It's a very simple command-line tool - by default, Parker will try to copy your screenshots into the current directory, though you can provide an alternative with the `-d` option.
+
+It will look for JSON configuration files with a name matching each game platform in its `~/.config/parker` directory:
+
+- `~/.config/parker/steam.json`
+- `~/.config/parker/switch.json`
+- `~/.config/parker/playstation.json`
+
+All config files share the same format:
+
+```json
+{
+  "source_path": "/path/to/game/screenshots/",
+  "name": "My Steam Screenshots",
+  "games": {
+    "game_id_1": "Awesome Game",
+    "game_id_2": "Awesome Game 2: More Awesomer"
+  }
+}
+```
+
+Your config _must_ have a `source_path`, or Parker won't know where to look for screenshots, and that would be bad.
+
+The optional `name` value will be used to name the parent directory housing each game (and so in the above example, if you were telling Parker to use `~/Pictures/Screenshots`, the above would copy games into `~/Pictures/Screenshots/My Steam Screenshots/Awesome Game`, etc. If left out, it defaults to a capitalised version of the platform name.
+
+The key/value in the `games` section is required for every platform _except_ the Playstation (due to the layout of the screenshots on disk coming off the console, we can pull the game name for you). You can determine the game ID for Steam and Switch games based on the ID in the screenshot path, or the ending hash of the filename, respectively. This is less than ideal, but hey, it works for now.
+
+It's possible that eventually I'd either add a way to look these up or keep a giant database of the mappings locally. Maybe.
+
+And that's pretty much it. This is mostly for me, really, but I'd love to know if someone else finds it useful.

data/lib/parker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Parker
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2017-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -34,6 +34,7 @@ extra_rdoc_files: []
 files:
 - bin/parker
 - lib/parker.rb
+- lib/parker/README.md
 - lib/parker/game.rb
 - lib/parker/platform/base.rb
 - lib/parker/platform/playstation.rb