Skip to content

Commit 8eee40a

Browse files
committed
Public release
0 parents  commit 8eee40a

File tree

10 files changed

+533
-0
lines changed

10 files changed

+533
-0
lines changed

.gitignore

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
*.gem
2+
*.rbc
3+
.bundle
4+
.config
5+
.yardoc
6+
Gemfile.lock
7+
InstalledFiles
8+
_yardoc
9+
coverage
10+
doc/
11+
lib/bundler/man
12+
pkg
13+
rdoc
14+
spec/reports
15+
test/tmp
16+
test/version_tmp
17+
tmp

.rspec

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
--color
2+
--format progress

.yardopts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
--markup markdown

Gemfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# encoding: UTF-8
2+
source 'https://rubygems.org'
3+
4+
gem 'steam_codec'
5+
gem 'json'
6+
gem 'gyoku'

README.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# ACF Manager
2+
3+
Simple application to work with Steam ACF files.
4+
5+
6+
## Features
7+
8+
* Export data from ACF files to several formats (csv, yml, json, xml, vdf)
9+
* Support for multiple Steam libraries
10+
* Locate unused steam game directories (those which aren't referenced in any ACF)
11+
* Supports Windows, Linux, Mac OS X
12+
13+
14+
## Installation
15+
16+
`git clone https://github.com/davispuh/ACF-Manager.git`
17+
18+
### Dependencies
19+
20+
gems:
21+
22+
* `steam_codec` (required)
23+
* `json` (optional, to export in JSON format)
24+
* `gyoku` (optional, to export in XML format)
25+
26+
install manually (`gem install`) or with
27+
28+
`bundle install`
29+
30+
## Usage
31+
32+
for command information use `-h` or `--help` flag
33+
34+
`ruby acf_manager.rb -h`
35+
36+
```
37+
Usage: acf_manager.rb [options]
38+
-p, --paths steam Paths to Steam directories
39+
-a, --apps paths Paths to SteamApps directories
40+
-e, --execute ACTION Execute specified action (export, list)
41+
-f, --fields fields Specify which fields to export
42+
-m, --mode MODE Mode for `list` (downloaded, installed,
43+
unreferenced)
44+
-o, --output FORMAT Output format (csv, yml, json, xml, vdf)
45+
-s, --save FILE File where to save output
46+
-h, --help Show this message
47+
```
48+
49+
* `-p, --paths` comma separated list of locations to Steam directories, example `-p "C:\Steam","D:\Steam"`
50+
* `-a, --apps` comma separated list of locations to SteamApps directories, example `-p "C:\Steam\SteamApps","D:\Steam\SteamApps"`
51+
* `-e, --execute ACTION`, example `-e export` or `-e list`
52+
* `-f, --fields fields`, comma separated list of fields, example `-f AppID,InstallDir,UserConfig.Name` (used only for `export`)
53+
* `-m, --mode MODE`, comma separated list of fields, example `-m installed` (used only for `list`)
54+
* `-o, --output FORMAT`, file format for output, example `-o json`
55+
* `-s, --save FILE`, file path where to save, example `-s C:\apps.json`
56+
57+
58+
## Documentation
59+
60+
YARD with markdown is used for documentation (`redcarpet` required)
61+
62+
## Specs
63+
64+
RSpec and simplecov are required, to run tests just `rake spec`
65+
code coverage will also be generated
66+
67+
## Unlicense
68+
69+
![Copyright-Free](http://unlicense.org/pd-icon.png)
70+
71+
All text, documentation, code and files in this repository are in public domain (including this text, README).
72+
It means you can copy, modify, distribute and include in your own work/code, even for commercial purposes, all without asking permission.
73+
74+
[About Unlicense](http://unlicense.org/)
75+
76+
## Contributing
77+
78+
Feel free to improve anything.
79+
80+
1. Fork it
81+
2. Create your feature branch (`git checkout -b my-new-feature`)
82+
3. Commit your changes (`git commit -am 'Add some feature'`)
83+
4. Push to the branch (`git push origin my-new-feature`)
84+
5. Create new Pull Request
85+
86+
87+
**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)
88+
89+
Also before sending pull request you acknowledge that you own all copyrights or have authorization to dedicate them to public domain.
90+
91+
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.
92+

Rakefile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# encoding: UTF-8
2+
require 'rspec/core/rake_task'
3+
require 'yard'
4+
5+
desc 'Default: run specs.'
6+
task :default => :spec
7+
8+
desc 'Run specs'
9+
RSpec::Core::RakeTask.new(:spec) do |t|
10+
end
11+
12+
YARD::Rake::YardocTask.new(:doc) do |t|
13+
t.files = ['*.rb', '-', '*.md']
14+
end

UNLICENSE

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
This is free and unencumbered software released into the public domain.
2+
3+
Anyone is free to copy, modify, publish, use, compile, sell, or
4+
distribute this software, either in source code form or as a compiled
5+
binary, for any purpose, commercial or non-commercial, and by any
6+
means.
7+
8+
In jurisdictions that recognize copyright laws, the author or authors
9+
of this software dedicate any and all copyright interest in the
10+
software to the public domain. We make this dedication for the benefit
11+
of the public at large and to the detriment of our heirs and
12+
successors. We intend this dedication to be an overt act of
13+
relinquishment in perpetuity of all present and future rights to this
14+
software under copyright law.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.
23+
24+
For more information, please refer to <http://unlicense.org/>

0 commit comments

Comments
 (0)