Skip to content

Commit

Permalink
Public release
Browse files Browse the repository at this point in the history
  • Loading branch information
davispuh committed Oct 2, 2013
0 parents commit 8eee40a
Show file tree
Hide file tree
Showing 10 changed files with 533 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
*.gem
*.rbc
.bundle
.config
.yardoc
Gemfile.lock
InstalledFiles
_yardoc
coverage
doc/
lib/bundler/man
pkg
rdoc
spec/reports
test/tmp
test/version_tmp
tmp
2 changes: 2 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--color
--format progress
1 change: 1 addition & 0 deletions .yardopts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--markup markdown
6 changes: 6 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# encoding: UTF-8
source 'https://rubygems.org'

gem 'steam_codec'
gem 'json'
gem 'gyoku'
92 changes: 92 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# ACF Manager

Simple application to work with Steam ACF files.


## Features

* Export data from ACF files to several formats (csv, yml, json, xml, vdf)
* Support for multiple Steam libraries
* Locate unused steam game directories (those which aren't referenced in any ACF)
* Supports Windows, Linux, Mac OS X


## Installation

`git clone https://github.com/davispuh/ACF-Manager.git`

### Dependencies

gems:

* `steam_codec` (required)
* `json` (optional, to export in JSON format)
* `gyoku` (optional, to export in XML format)

install manually (`gem install`) or with

`bundle install`

## Usage

for command information use `-h` or `--help` flag

`ruby acf_manager.rb -h`

```
Usage: acf_manager.rb [options]
-p, --paths steam Paths to Steam directories
-a, --apps paths Paths to SteamApps directories
-e, --execute ACTION Execute specified action (export, list)
-f, --fields fields Specify which fields to export
-m, --mode MODE Mode for `list` (downloaded, installed,
unreferenced)
-o, --output FORMAT Output format (csv, yml, json, xml, vdf)
-s, --save FILE File where to save output
-h, --help Show this message
```

* `-p, --paths` comma separated list of locations to Steam directories, example `-p "C:\Steam","D:\Steam"`
* `-a, --apps` comma separated list of locations to SteamApps directories, example `-p "C:\Steam\SteamApps","D:\Steam\SteamApps"`
* `-e, --execute ACTION`, example `-e export` or `-e list`
* `-f, --fields fields`, comma separated list of fields, example `-f AppID,InstallDir,UserConfig.Name` (used only for `export`)
* `-m, --mode MODE`, comma separated list of fields, example `-m installed` (used only for `list`)
* `-o, --output FORMAT`, file format for output, example `-o json`
* `-s, --save FILE`, file path where to save, example `-s C:\apps.json`


## Documentation

YARD with markdown is used for documentation (`redcarpet` required)

## Specs

RSpec and simplecov are required, to run tests just `rake spec`
code coverage will also be generated

## Unlicense

![Copyright-Free](http://unlicense.org/pd-icon.png)

All text, documentation, code and files in this repository are in public domain (including this text, README).
It means you can copy, modify, distribute and include in your own work/code, even for commercial purposes, all without asking permission.

[About Unlicense](http://unlicense.org/)

## Contributing

Feel free to improve anything.

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request


**Warning**: By sending pull request to this repository you dedicate any and all copyright interest in pull request (code files and all other) to the public domain. (files will be in public domain even if pull request doesn't get merged)

Also before sending pull request you acknowledge that you own all copyrights or have authorization to dedicate them to public domain.

If you don't want to dedicate code to public domain or if you're not allowed to (eg. you don't own required copyrights) then DON'T send pull request.

14 changes: 14 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# encoding: UTF-8
require 'rspec/core/rake_task'
require 'yard'

desc 'Default: run specs.'
task :default => :spec

desc 'Run specs'
RSpec::Core::RakeTask.new(:spec) do |t|
end

YARD::Rake::YardocTask.new(:doc) do |t|
t.files = ['*.rb', '-', '*.md']
end
24 changes: 24 additions & 0 deletions UNLICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>
Loading

0 comments on commit 8eee40a

Please sign in to comment.