gamerom 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/workflows/main.yml +18 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.rubocop.yml +10 -0
- data/.ruby-version +1 -0
- data/CODE_OF_CONDUCT.md +84 -0
- data/Dockerfile +16 -0
- data/Gemfile +12 -0
- data/Gemfile.lock +104 -0
- data/LICENSE.txt +21 -0
- data/Makefile +39 -0
- data/README.md +561 -0
- data/Rakefile +12 -0
- data/bin/console +15 -0
- data/bin/setup +8 -0
- data/exe/gamerom +5 -0
- data/gamerom.gemspec +39 -0
- data/lib/gamerom.rb +11 -0
- data/lib/gamerom/cli.rb +322 -0
- data/lib/gamerom/config.rb +19 -0
- data/lib/gamerom/game.rb +49 -0
- data/lib/gamerom/repo.rb +85 -0
- data/lib/gamerom/repo_adapters/coolrom.rb +78 -0
- data/lib/gamerom/repo_adapters/vimm.rb +71 -0
- data/lib/gamerom/version.rb +5 -0
- metadata +129 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ed630a7050f3d5206302cdc93cd126be98bf854a6a89e076a807ae81703dc78d
|
4
|
+
data.tar.gz: 24e25edcaebd1520d48c0ae7c0cc2d148d48ba1c002c16497d95579e372b51be
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7dd4cc672d3bcbf177caf54d53add0070c703fa4cce022e3dca3beddcd6b07ab6793686aef6e0cf4518285b0887b272cf61e4d1063a6a72bb779f4f48633ec82
|
7
|
+
data.tar.gz: b08221243a8b538b8343ffe84c7c2e011093bfeabb96208693f043c78bff396edfbee10ca779851a78bf1eed0db86dbb2bd81240cee56d5f5560ccda6be81642
|
@@ -0,0 +1,18 @@
|
|
1
|
+
name: Ruby
|
2
|
+
|
3
|
+
on: [push,pull_request]
|
4
|
+
|
5
|
+
jobs:
|
6
|
+
build:
|
7
|
+
runs-on: ubuntu-latest
|
8
|
+
steps:
|
9
|
+
- uses: actions/checkout@v2
|
10
|
+
- name: Set up Ruby
|
11
|
+
uses: ruby/setup-ruby@v1
|
12
|
+
with:
|
13
|
+
ruby-version: 3.0.0
|
14
|
+
- name: Run the default task
|
15
|
+
run: |
|
16
|
+
gem install bundler -v 2.2.3
|
17
|
+
bundle install
|
18
|
+
bundle exec rake
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.rubocop.yml
ADDED
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
ruby-3.0.0
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
6
|
+
|
7
|
+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
|
8
|
+
|
9
|
+
## Our Standards
|
10
|
+
|
11
|
+
Examples of behavior that contributes to a positive environment for our community include:
|
12
|
+
|
13
|
+
* Demonstrating empathy and kindness toward other people
|
14
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
15
|
+
* Giving and gracefully accepting constructive feedback
|
16
|
+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
17
|
+
* Focusing on what is best not just for us as individuals, but for the overall community
|
18
|
+
|
19
|
+
Examples of unacceptable behavior include:
|
20
|
+
|
21
|
+
* The use of sexualized language or imagery, and sexual attention or
|
22
|
+
advances of any kind
|
23
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
24
|
+
* Public or private harassment
|
25
|
+
* Publishing others' private information, such as a physical or email
|
26
|
+
address, without their explicit permission
|
27
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
28
|
+
professional setting
|
29
|
+
|
30
|
+
## Enforcement Responsibilities
|
31
|
+
|
32
|
+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
|
33
|
+
|
34
|
+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
|
35
|
+
|
36
|
+
## Scope
|
37
|
+
|
38
|
+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
39
|
+
|
40
|
+
## Enforcement
|
41
|
+
|
42
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at lucas.mundim@g.globo. All complaints will be reviewed and investigated promptly and fairly.
|
43
|
+
|
44
|
+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
45
|
+
|
46
|
+
## Enforcement Guidelines
|
47
|
+
|
48
|
+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
|
49
|
+
|
50
|
+
### 1. Correction
|
51
|
+
|
52
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
|
53
|
+
|
54
|
+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
|
55
|
+
|
56
|
+
### 2. Warning
|
57
|
+
|
58
|
+
**Community Impact**: A violation through a single incident or series of actions.
|
59
|
+
|
60
|
+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
|
61
|
+
|
62
|
+
### 3. Temporary Ban
|
63
|
+
|
64
|
+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
|
65
|
+
|
66
|
+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
|
67
|
+
|
68
|
+
### 4. Permanent Ban
|
69
|
+
|
70
|
+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
|
71
|
+
|
72
|
+
**Consequence**: A permanent ban from any sort of public interaction within the community.
|
73
|
+
|
74
|
+
## Attribution
|
75
|
+
|
76
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
|
77
|
+
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
78
|
+
|
79
|
+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
80
|
+
|
81
|
+
[homepage]: https://www.contributor-covenant.org
|
82
|
+
|
83
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
84
|
+
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
|
data/Dockerfile
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
FROM ruby:3.0.0-alpine as build
|
2
|
+
|
3
|
+
RUN apk add --no-cache --virtual .build-deps \
|
4
|
+
build-base \
|
5
|
+
git
|
6
|
+
|
7
|
+
# throw errors if Gemfile has been modified since Gemfile.lock
|
8
|
+
RUN bundle config --global frozen 1
|
9
|
+
|
10
|
+
RUN mkdir -p /app
|
11
|
+
WORKDIR /app
|
12
|
+
|
13
|
+
COPY . .
|
14
|
+
RUN bundle install
|
15
|
+
|
16
|
+
ENTRYPOINT ["bundle", "exec", "./exe/gamerom"]
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,104 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
gamerom (0.1.0)
|
5
|
+
mechanize (~> 2.8.0)
|
6
|
+
nokogiri (~> 1.11.3)
|
7
|
+
rest-client (~> 2.1.0)
|
8
|
+
thor (~> 1.1.0)
|
9
|
+
|
10
|
+
GEM
|
11
|
+
remote: https://rubygems.org/
|
12
|
+
specs:
|
13
|
+
addressable (2.7.0)
|
14
|
+
public_suffix (>= 2.0.2, < 5.0)
|
15
|
+
ast (2.4.2)
|
16
|
+
connection_pool (2.2.5)
|
17
|
+
diff-lcs (1.4.4)
|
18
|
+
domain_name (0.5.20190701)
|
19
|
+
unf (>= 0.0.5, < 1.0.0)
|
20
|
+
http-accept (1.7.0)
|
21
|
+
http-cookie (1.0.3)
|
22
|
+
domain_name (~> 0.5)
|
23
|
+
mechanize (2.8.0)
|
24
|
+
addressable (~> 2.7)
|
25
|
+
domain_name (~> 0.5, >= 0.5.20190701)
|
26
|
+
http-cookie (~> 1.0, >= 1.0.3)
|
27
|
+
mime-types (~> 3.0)
|
28
|
+
net-http-digest_auth (~> 1.4, >= 1.4.1)
|
29
|
+
net-http-persistent (>= 2.5.2, < 5.0.dev)
|
30
|
+
nokogiri (~> 1.11, >= 1.11.2)
|
31
|
+
rubyntlm (~> 0.6, >= 0.6.3)
|
32
|
+
webrick (~> 1.7)
|
33
|
+
webrobots (~> 0.1.2)
|
34
|
+
mime-types (3.3.1)
|
35
|
+
mime-types-data (~> 3.2015)
|
36
|
+
mime-types-data (3.2021.0225)
|
37
|
+
net-http-digest_auth (1.4.1)
|
38
|
+
net-http-persistent (4.0.1)
|
39
|
+
connection_pool (~> 2.2)
|
40
|
+
netrc (0.11.0)
|
41
|
+
nokogiri (1.11.3-x86_64-darwin)
|
42
|
+
racc (~> 1.4)
|
43
|
+
nokogiri (1.11.3-x86_64-linux)
|
44
|
+
racc (~> 1.4)
|
45
|
+
parallel (1.20.1)
|
46
|
+
parser (3.0.1.0)
|
47
|
+
ast (~> 2.4.1)
|
48
|
+
public_suffix (4.0.6)
|
49
|
+
racc (1.5.2)
|
50
|
+
rainbow (3.0.0)
|
51
|
+
rake (13.0.3)
|
52
|
+
regexp_parser (2.1.1)
|
53
|
+
rest-client (2.1.0)
|
54
|
+
http-accept (>= 1.7.0, < 2.0)
|
55
|
+
http-cookie (>= 1.0.2, < 2.0)
|
56
|
+
mime-types (>= 1.16, < 4.0)
|
57
|
+
netrc (~> 0.8)
|
58
|
+
rexml (3.2.5)
|
59
|
+
rspec (3.10.0)
|
60
|
+
rspec-core (~> 3.10.0)
|
61
|
+
rspec-expectations (~> 3.10.0)
|
62
|
+
rspec-mocks (~> 3.10.0)
|
63
|
+
rspec-core (3.10.1)
|
64
|
+
rspec-support (~> 3.10.0)
|
65
|
+
rspec-expectations (3.10.1)
|
66
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
67
|
+
rspec-support (~> 3.10.0)
|
68
|
+
rspec-mocks (3.10.2)
|
69
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
70
|
+
rspec-support (~> 3.10.0)
|
71
|
+
rspec-support (3.10.2)
|
72
|
+
rubocop (0.93.1)
|
73
|
+
parallel (~> 1.10)
|
74
|
+
parser (>= 2.7.1.5)
|
75
|
+
rainbow (>= 2.2.2, < 4.0)
|
76
|
+
regexp_parser (>= 1.8)
|
77
|
+
rexml
|
78
|
+
rubocop-ast (>= 0.6.0)
|
79
|
+
ruby-progressbar (~> 1.7)
|
80
|
+
unicode-display_width (>= 1.4.0, < 2.0)
|
81
|
+
rubocop-ast (1.4.1)
|
82
|
+
parser (>= 2.7.1.5)
|
83
|
+
ruby-progressbar (1.11.0)
|
84
|
+
rubyntlm (0.6.3)
|
85
|
+
thor (1.1.0)
|
86
|
+
unf (0.1.4)
|
87
|
+
unf_ext
|
88
|
+
unf_ext (0.0.7.7)
|
89
|
+
unicode-display_width (1.7.0)
|
90
|
+
webrick (1.7.0)
|
91
|
+
webrobots (0.1.2)
|
92
|
+
|
93
|
+
PLATFORMS
|
94
|
+
x86_64-darwin-20
|
95
|
+
x86_64-linux-musl
|
96
|
+
|
97
|
+
DEPENDENCIES
|
98
|
+
gamerom!
|
99
|
+
rake (~> 13.0)
|
100
|
+
rspec (~> 3.0)
|
101
|
+
rubocop (~> 0.80)
|
102
|
+
|
103
|
+
BUNDLED WITH
|
104
|
+
2.2.3
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2021 Lucas Mundim
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/Makefile
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
VERSION:=$(shell cat lib/gamerom/version.rb |grep VERSION|cut -d\" -f2)
|
2
|
+
IMAGE=lucasmundim/gamerom:${VERSION}
|
3
|
+
DOCKER_OPTS=--rm -it -v ${HOME}/.gamerom:/root/.gamerom ${IMAGE}
|
4
|
+
LOCAL_VOLUME_OPTS=-v ${CURDIR}:/app
|
5
|
+
DOCKER_DEVELOPMENT_OPTS=${LOCAL_VOLUME_OPTS} --entrypoint '' ${DOCKER_OPTS}
|
6
|
+
|
7
|
+
version:
|
8
|
+
@echo ${VERSION}
|
9
|
+
|
10
|
+
build:
|
11
|
+
@docker build -t ${IMAGE} .
|
12
|
+
|
13
|
+
console:
|
14
|
+
@docker run ${DOCKER_DEVELOPMENT_OPTS} ./bin/console
|
15
|
+
|
16
|
+
push: build
|
17
|
+
@docker push ${IMAGE}
|
18
|
+
|
19
|
+
# If the first argument is "run"...
|
20
|
+
ifeq (run,$(firstword $(MAKECMDGOALS)))
|
21
|
+
# use the rest as arguments for "run"
|
22
|
+
RUN_ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
|
23
|
+
# ...and turn them into do-nothing targets
|
24
|
+
$(eval $(RUN_ARGS):;@:)
|
25
|
+
endif
|
26
|
+
|
27
|
+
run:
|
28
|
+
@docker run ${LOCAL_VOLUME_OPTS} ${DOCKER_OPTS} $(RUN_ARGS)
|
29
|
+
|
30
|
+
shell:
|
31
|
+
@docker run ${DOCKER_DEVELOPMENT_OPTS} sh
|
32
|
+
|
33
|
+
spec:
|
34
|
+
@docker run ${DOCKER_DEVELOPMENT_OPTS} bundle exec rake spec
|
35
|
+
|
36
|
+
update_bundle:
|
37
|
+
@docker run ${DOCKER_DEVELOPMENT_OPTS} sh -c "bundle config unset frozen && bundle"
|
38
|
+
|
39
|
+
.PHONY: build push run shell spec update_bundle
|
data/README.md
ADDED
@@ -0,0 +1,561 @@
|
|
1
|
+
# Gamerom - The Video Game ROM downloader
|
2
|
+
|
3
|
+
A command-line installer for game ROMs from many repositories.
|
4
|
+
|
5
|
+
It currently supports the following repositories:
|
6
|
+
|
7
|
+
- https://vimm.net/
|
8
|
+
- https://coolrom.com.au/
|
9
|
+
|
10
|
+
## Installation
|
11
|
+
|
12
|
+
### Using Docker
|
13
|
+
|
14
|
+
Add this to your .bashrc, .bash_aliases, etc:
|
15
|
+
|
16
|
+
```
|
17
|
+
alias gamerom='docker run --rm -it -v ~/.gamerom:/root/.gamerom docker.io/lucasmundim/gamerom:0.1.0'
|
18
|
+
```
|
19
|
+
|
20
|
+
Use it as:
|
21
|
+
|
22
|
+
```
|
23
|
+
gamerom help
|
24
|
+
```
|
25
|
+
|
26
|
+
### Using Rubygems
|
27
|
+
|
28
|
+
Install it as a regular gem:
|
29
|
+
|
30
|
+
$ gem install gamerom
|
31
|
+
|
32
|
+
Use it as:
|
33
|
+
|
34
|
+
```
|
35
|
+
gamerom help
|
36
|
+
```
|
37
|
+
|
38
|
+
### Using Git
|
39
|
+
|
40
|
+
Clone, cd into, bundle install, and bundle exec:
|
41
|
+
|
42
|
+
$ git clone git@github.com:lucasmundim/gamerom.git
|
43
|
+
$ cd rom/
|
44
|
+
$ bundle install
|
45
|
+
|
46
|
+
Use it as:
|
47
|
+
|
48
|
+
$ bundle exec ./exe/gamerom help
|
49
|
+
|
50
|
+
## Usage
|
51
|
+
|
52
|
+
### help
|
53
|
+
|
54
|
+
```
|
55
|
+
$ gamerom help
|
56
|
+
Commands:
|
57
|
+
gamerom config # Show config
|
58
|
+
gamerom help [COMMAND] # Describe available commands or one specific command
|
59
|
+
gamerom info GAME_IDENTIFIER -p, --platform=PLATFORM -r, --repo=REPO # Info for game GAME_IDENTIFIER (id/name)
|
60
|
+
gamerom install GAME_IDENTIFIER -p, --platform=PLATFORM -r, --repo=REPO # Install game GAME_IDENTIFIER (id/name)
|
61
|
+
gamerom install_all -p, --platform=PLATFORM -r, --repo=REPO # Install all games
|
62
|
+
gamerom list -p, --platform=PLATFORM -r, --repo=REPO # List available games
|
63
|
+
gamerom platforms -r, --repo=REPO # List available platforms
|
64
|
+
gamerom recover -p, --platform=PLATFORM -r, --repo=REPO # Try to recover state from already downloaded roms
|
65
|
+
gamerom regions -p, --platform=PLATFORM -r, --repo=REPO # List available regions
|
66
|
+
gamerom repo # List available repo
|
67
|
+
gamerom search KEYWORD -p, --platform=PLATFORM -r, --repo=REPO # Search games by KEYWORD
|
68
|
+
gamerom stats -p, --platform=PLATFORM -r, --repo=REPO # Show platform stats
|
69
|
+
gamerom stats_all -r, --repo=REPO # Show stats for all platforms
|
70
|
+
gamerom uninstall GAME_IDENTIFIER -p, --platform=PLATFORM -r, --repo=REPO # Uninstall game GAME_IDENTIFIER (id/name)
|
71
|
+
gamerom uninstall_all -p, --platform=PLATFORM -r, --repo=REPO # Uninstall all games
|
72
|
+
gamerom update_all_databases -r, --repo=REPO # Update all local databases
|
73
|
+
gamerom update_database -p, --platform=PLATFORM -r, --repo=REPO # Update local database
|
74
|
+
gamerom version # Print program version
|
75
|
+
|
76
|
+
Options:
|
77
|
+
-v, [--verbose], [--no-verbose] # Show verbose backtrace
|
78
|
+
```
|
79
|
+
|
80
|
+
### repo
|
81
|
+
|
82
|
+
List available repo
|
83
|
+
|
84
|
+
```
|
85
|
+
$ gamerom repo
|
86
|
+
listing available repo...
|
87
|
+
coolrom
|
88
|
+
vimm
|
89
|
+
```
|
90
|
+
|
91
|
+
### platforms
|
92
|
+
|
93
|
+
List available platforms
|
94
|
+
|
95
|
+
```
|
96
|
+
$ gamerom platform --repo coolrom
|
97
|
+
listing available platforms for coolrom repo...
|
98
|
+
---
|
99
|
+
:platforms:
|
100
|
+
atari2600: Atari 2600
|
101
|
+
atari5200: Atari 5200
|
102
|
+
atari7800: Atari 7800
|
103
|
+
atarijaguar: Atari Jaguar
|
104
|
+
atarilynx: Atari Lynx
|
105
|
+
c64: Commodore 64
|
106
|
+
cps1: CPS1
|
107
|
+
cps2: CPS2
|
108
|
+
mame: MAME
|
109
|
+
namcosystem22: Namco System 22
|
110
|
+
neogeo: Neo Geo
|
111
|
+
neogeocd: Neo Geo CD
|
112
|
+
neogeopocket: Neo Geo Pocket
|
113
|
+
segacd: Sega CD
|
114
|
+
dc: Sega Dreamcast
|
115
|
+
gamegear: Sega Game Gear
|
116
|
+
genesis: Sega Genesis
|
117
|
+
mastersystem: Sega Master System
|
118
|
+
model2: Sega Model 2
|
119
|
+
saturn: Sega Saturn
|
120
|
+
psx: Sony Playstation
|
121
|
+
ps2: Sony Playstation 2
|
122
|
+
psp: Sony Playstation Portable
|
123
|
+
```
|
124
|
+
|
125
|
+
```
|
126
|
+
$ gamerom platform -r vimm
|
127
|
+
listing available platforms for vimm repo...
|
128
|
+
---
|
129
|
+
:platforms:
|
130
|
+
Dreamcast: Dreamcast
|
131
|
+
DS: Nintendo DS
|
132
|
+
GameCube: GameCube
|
133
|
+
GB: Game Boy
|
134
|
+
GBA: Game Boy Advance
|
135
|
+
GBC: Game Boy Color
|
136
|
+
Genesis: Genesis
|
137
|
+
N64: Nintendo 64
|
138
|
+
NES: Nintendo
|
139
|
+
PS1: PlayStation
|
140
|
+
PS2: PlayStation 2
|
141
|
+
PS3: PlayStation 3
|
142
|
+
PSP: PlayStation Portable
|
143
|
+
Saturn: Saturn
|
144
|
+
SNES: Super Nintendo
|
145
|
+
Wii: Wii
|
146
|
+
WiiWare: WiiWare
|
147
|
+
```
|
148
|
+
|
149
|
+
### list
|
150
|
+
|
151
|
+
List available games
|
152
|
+
|
153
|
+
```
|
154
|
+
$ gamerom list -r coolrom -p namcosystem22
|
155
|
+
listing available games for namcosystem22 platform on coolrom repo...
|
156
|
+
ID NAME REGION INSTALLED
|
157
|
+
316 Rave Racer USA installed
|
158
|
+
318 Ridge Racer 2 USA -
|
159
|
+
```
|
160
|
+
|
161
|
+
Filtering by region:
|
162
|
+
```
|
163
|
+
$ gamerom list -r coolrom -p model2 -g Japan
|
164
|
+
listing available games for model2 platform on coolrom repo...
|
165
|
+
ID NAME REGION INSTALLED
|
166
|
+
12952 Virtual On Cyber Troopers (Japan) Japan -
|
167
|
+
12956 Zero Gunner (Japan Model 2B) Japan -
|
168
|
+
```
|
169
|
+
|
170
|
+
### search
|
171
|
+
|
172
|
+
Search games by KEYWORD
|
173
|
+
|
174
|
+
```
|
175
|
+
$ gamerom search -r vimm -p SNES zelda
|
176
|
+
searching available games for SNES platform on vimm repo...
|
177
|
+
ID NAME REGION INSTALLED
|
178
|
+
1346 Legend of Zelda, The: A Link to the Past USA -
|
179
|
+
```
|
180
|
+
|
181
|
+
### regions
|
182
|
+
|
183
|
+
List available regions
|
184
|
+
|
185
|
+
```
|
186
|
+
$ gamerom regions -r coolrom -p genesis
|
187
|
+
listing available regions for genesis platform on coolrom repo...
|
188
|
+
Australia
|
189
|
+
Brazil
|
190
|
+
China
|
191
|
+
Europe
|
192
|
+
France
|
193
|
+
Germany
|
194
|
+
Japan
|
195
|
+
Korea
|
196
|
+
Spain
|
197
|
+
Sweden
|
198
|
+
USA
|
199
|
+
```
|
200
|
+
|
201
|
+
### install
|
202
|
+
|
203
|
+
Install game GAME_IDENTIFIER (id/name)
|
204
|
+
|
205
|
+
```
|
206
|
+
$ gamerom install -r vimm -p NES 'Mega Man'
|
207
|
+
installing game 545 - Mega Man - USA on NES platform on vimm repo...
|
208
|
+
Game installed
|
209
|
+
```
|
210
|
+
|
211
|
+
### install_all
|
212
|
+
|
213
|
+
Install all games
|
214
|
+
|
215
|
+
```
|
216
|
+
$ gamerom install_all -r coolrom -p genesis -g Brazil
|
217
|
+
installing game 48155 - Duke Nukem 3D (Brazil) - Brazil on genesis platform on coolrom repo...
|
218
|
+
Game installed
|
219
|
+
installing game 6501 - Ferias Frustradas do Pica-Pau (Brazil) - Brazil on genesis platform on coolrom repo...
|
220
|
+
Game installed
|
221
|
+
installing game 6358 - Mega Games 10 (Brazil) - Brazil on genesis platform on coolrom repo...
|
222
|
+
Game installed
|
223
|
+
installing game 47766 - Phantasy Star II (Brazil) - Brazil on genesis platform on coolrom repo...
|
224
|
+
Game installed
|
225
|
+
installing game 5683 - Sega Top Five (Brazil) - Brazil on genesis platform on coolrom repo...
|
226
|
+
Game installed
|
227
|
+
installing game 47898 - Show do Milhao (Brazil) - Brazil on genesis platform on coolrom repo...
|
228
|
+
Game installed
|
229
|
+
installing game 47909 - Show do Milhao Volume 2 (Brazil) - Brazil on genesis platform on coolrom repo...
|
230
|
+
Game installed
|
231
|
+
installing game 47747 - Sport Games (Brazil) - Brazil on genesis platform on coolrom repo...
|
232
|
+
Game installed
|
233
|
+
installing game 5552 - Telebradesco Residencia (Brazil) - Brazil on genesis platform on coolrom repo...
|
234
|
+
Game installed
|
235
|
+
installing game 5808 - Turma da Monica na Terra dos Monstros (Brazil) - Brazil on genesis platform on coolrom repo...
|
236
|
+
Game installed
|
237
|
+
installing game 48020 - Where in the World Is Carmen Sandiego (Brazil) - Brazil on genesis platform on coolrom repo...
|
238
|
+
Game installed
|
239
|
+
installing game 47824 - Where in Time Is Carmen Sandiego (Brazil) - Brazil on genesis platform on coolrom repo...
|
240
|
+
Game installed
|
241
|
+
installing game 47770 - Yuu Yuu Hakusho - Sunset Fighters (Brazil) - Brazil on genesis platform on coolrom repo...
|
242
|
+
Game installed
|
243
|
+
```
|
244
|
+
|
245
|
+
### uninstall
|
246
|
+
|
247
|
+
Uninstall game GAME_IDENTIFIER (id/name)
|
248
|
+
|
249
|
+
```
|
250
|
+
$ gamerom uninstall -r coolrom -p gamegear 7493
|
251
|
+
uninstalling game 7493 - Zoop - USA on gamegear platform...
|
252
|
+
Game uninstalled
|
253
|
+
```
|
254
|
+
|
255
|
+
### uninstall_all
|
256
|
+
|
257
|
+
Uninstall all games
|
258
|
+
|
259
|
+
```
|
260
|
+
$ gamerom uninstall_all -r coolrom -p gamegear
|
261
|
+
uninstalling game 7274 - 007 James Bond - The Duel - USA on gamegear platform...
|
262
|
+
Game uninstalled
|
263
|
+
uninstalling game 7414 - 5 in 1 Funpak - USA on gamegear platform...
|
264
|
+
Game uninstalled
|
265
|
+
uninstalling game 7545 - Addams Family - USA on gamegear platform...
|
266
|
+
Game uninstalled
|
267
|
+
```
|
268
|
+
|
269
|
+
### info
|
270
|
+
|
271
|
+
Info for game GAME_IDENTIFIER (id/name)
|
272
|
+
|
273
|
+
```
|
274
|
+
$ gamerom info --repo coolrom --platform atari2600 adventure
|
275
|
+
showing info for game adventure on atari2600 platform on coolrom repo...
|
276
|
+
15913 - Adventure - USA (installed)
|
277
|
+
/Users/lucas/.gamerom/games/coolrom/atari2600/USA/Adventure.zip
|
278
|
+
```
|
279
|
+
|
280
|
+
### update_database
|
281
|
+
|
282
|
+
Update local database
|
283
|
+
|
284
|
+
```
|
285
|
+
$ gamerom update_database --repo vimm --platform SNES
|
286
|
+
updating SNES platform on vimm repo...
|
287
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
288
|
+
Game database updated for platform SNES on vimm repo
|
289
|
+
```
|
290
|
+
|
291
|
+
### update_all_databases
|
292
|
+
|
293
|
+
Update all local databases
|
294
|
+
|
295
|
+
```
|
296
|
+
$ gamerom update_all_databases -r vimm
|
297
|
+
updating Dreamcast platform on vimm repo...
|
298
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
299
|
+
Game database updated for platform Dreamcast on vimm repo
|
300
|
+
updating DS platform on vimm repo...
|
301
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
302
|
+
Game database updated for platform DS on vimm repo
|
303
|
+
updating GameCube platform on vimm repo...
|
304
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
305
|
+
Game database updated for platform GameCube on vimm repo
|
306
|
+
updating GB platform on vimm repo...
|
307
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
308
|
+
Game database updated for platform GB on vimm repo
|
309
|
+
updating GBA platform on vimm repo...
|
310
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
311
|
+
Game database updated for platform GBA on vimm repo
|
312
|
+
updating GBC platform on vimm repo...
|
313
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
314
|
+
Game database updated for platform GBC on vimm repo
|
315
|
+
updating Genesis platform on vimm repo...
|
316
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
317
|
+
Game database updated for platform Genesis on vimm repo
|
318
|
+
updating N64 platform on vimm repo...
|
319
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
320
|
+
Game database updated for platform N64 on vimm repo
|
321
|
+
updating NES platform on vimm repo...
|
322
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
323
|
+
Game database updated for platform NES on vimm repo
|
324
|
+
updating PS1 platform on vimm repo...
|
325
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
326
|
+
Game database updated for platform PS1 on vimm repo
|
327
|
+
updating PS2 platform on vimm repo...
|
328
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
329
|
+
Game database updated for platform PS2 on vimm repo
|
330
|
+
updating PS3 platform on vimm repo...
|
331
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
332
|
+
Game database updated for platform PS3 on vimm repo
|
333
|
+
updating PSP platform on vimm repo...
|
334
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
335
|
+
Game database updated for platform PSP on vimm repo
|
336
|
+
updating Saturn platform on vimm repo...
|
337
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
338
|
+
Game database updated for platform Saturn on vimm repo
|
339
|
+
updating SNES platform on vimm repo...
|
340
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
341
|
+
Game database updated for platform SNES on vimm repo
|
342
|
+
updating Wii platform on vimm repo...
|
343
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
344
|
+
Game database updated for platform Wii on vimm repo
|
345
|
+
updating WiiWare platform on vimm repo...
|
346
|
+
number a b c d e f g h i j k l m n o p q r s t u v w x y z
|
347
|
+
Game database updated for platform WiiWare on vimm repo
|
348
|
+
All game databases updated
|
349
|
+
```
|
350
|
+
|
351
|
+
### stats
|
352
|
+
|
353
|
+
Show platform stats
|
354
|
+
|
355
|
+
```
|
356
|
+
$ gamerom stats -r coolrom -p gamegear
|
357
|
+
stats for gamegear platform on coolrom repo...
|
358
|
+
All: 4/337 - size: 440K
|
359
|
+
Japan: 0/45 - size: 0
|
360
|
+
USA: 4/292 - size: 440K
|
361
|
+
```
|
362
|
+
|
363
|
+
### stats_all
|
364
|
+
|
365
|
+
Show stats for all platforms
|
366
|
+
|
367
|
+
```
|
368
|
+
$ gamerom stats_all -r coolrom
|
369
|
+
stats for atari2600 platform on coolrom repo...
|
370
|
+
All: 645/645 - size: 3.6M
|
371
|
+
USA: 645/645 - size: 3.6M
|
372
|
+
|
373
|
+
stats for atari5200 platform on coolrom repo...
|
374
|
+
All: 94/94 - size: 1.2M
|
375
|
+
USA: 94/94 - size: 1.2M
|
376
|
+
|
377
|
+
stats for atari7800 platform on coolrom repo...
|
378
|
+
All: 58/58 - size: 2.0M
|
379
|
+
USA: 58/58 - size: 2.0M
|
380
|
+
|
381
|
+
stats for atarijaguar platform on coolrom repo...
|
382
|
+
All: 44/44 - size: 85M
|
383
|
+
USA: 44/44 - size: 85M
|
384
|
+
|
385
|
+
stats for atarilynx platform on coolrom repo...
|
386
|
+
All: 85/85 - size: 12M
|
387
|
+
USA: 85/85 - size: 12M
|
388
|
+
|
389
|
+
stats for c64 platform on coolrom repo...
|
390
|
+
All: 0/5649 - size: 0
|
391
|
+
Germany: 0/2 - size: 0
|
392
|
+
Spain: 0/9 - size: 0
|
393
|
+
USA: 0/5638 - size: 0
|
394
|
+
|
395
|
+
stats for cps1 platform on coolrom repo...
|
396
|
+
All: 24/24 - size: 49M
|
397
|
+
USA: 24/24 - size: 49M
|
398
|
+
|
399
|
+
stats for cps2 platform on coolrom repo...
|
400
|
+
All: 32/32 - size: 472M
|
401
|
+
USA: 32/32 - size: 472M
|
402
|
+
|
403
|
+
stats for mame platform on coolrom repo...
|
404
|
+
All: 22/29668 - size: 16M
|
405
|
+
Australia: 0/6 - size: 0
|
406
|
+
Brazil: 22/22 - size: 16M
|
407
|
+
Canada: 0/5 - size: 0
|
408
|
+
China: 0/47 - size: 0
|
409
|
+
Europe: 0/48 - size: 0
|
410
|
+
France: 0/136 - size: 0
|
411
|
+
Germany: 0/230 - size: 0
|
412
|
+
Italy: 0/174 - size: 0
|
413
|
+
Japan: 0/1556 - size: 0
|
414
|
+
Korea: 0/112 - size: 0
|
415
|
+
Netherlands: 0/195 - size: 0
|
416
|
+
Norway: 0/2 - size: 0
|
417
|
+
Russia: 0/95 - size: 0
|
418
|
+
Spain: 0/179 - size: 0
|
419
|
+
Sweden: 0/2 - size: 0
|
420
|
+
USA: 0/26859 - size: 0
|
421
|
+
|
422
|
+
stats for namcosystem22 platform on coolrom repo...
|
423
|
+
All: 1/2 - size: 21M
|
424
|
+
USA: 1/2 - size: 21M
|
425
|
+
|
426
|
+
stats for neogeo platform on coolrom repo...
|
427
|
+
All: 125/125 - size: 1.5G
|
428
|
+
USA: 125/125 - size: 1.5G
|
429
|
+
|
430
|
+
stats for neogeocd platform on coolrom repo...
|
431
|
+
All: 94/94 - size: 5.1G
|
432
|
+
USA: 94/94 - size: 5.1G
|
433
|
+
|
434
|
+
stats for neogeopocket platform on coolrom repo...
|
435
|
+
All: 0/87 - size: 0
|
436
|
+
USA: 0/87 - size: 0
|
437
|
+
|
438
|
+
stats for segacd platform on coolrom repo...
|
439
|
+
All: 147/147 - size: 14G
|
440
|
+
USA: 147/147 - size: 14G
|
441
|
+
|
442
|
+
stats for dc platform on coolrom repo...
|
443
|
+
All: 0/262 - size: 0
|
444
|
+
USA: 0/262 - size: 0
|
445
|
+
|
446
|
+
stats for gamegear platform on coolrom repo...
|
447
|
+
All: 4/337 - size: 440K
|
448
|
+
Japan: 0/45 - size: 0
|
449
|
+
USA: 4/292 - size: 440K
|
450
|
+
|
451
|
+
stats for genesis platform on coolrom repo...
|
452
|
+
All: 990/1615 - size: 637M
|
453
|
+
Australia: 0/1 - size: 0
|
454
|
+
Brazil: 13/13 - size: 12M
|
455
|
+
China: 0/8 - size: 0
|
456
|
+
Europe: 10/243 - size: 6.1M
|
457
|
+
France: 0/4 - size: 0
|
458
|
+
Germany: 0/5 - size: 0
|
459
|
+
Japan: 10/373 - size: 4.4M
|
460
|
+
Korea: 0/7 - size: 0
|
461
|
+
Spain: 0/2 - size: 0
|
462
|
+
Sweden: 0/2 - size: 0
|
463
|
+
USA: 957/957 - size: 615M
|
464
|
+
|
465
|
+
stats for mastersystem platform on coolrom repo...
|
466
|
+
All: 309/309 - size: 43M
|
467
|
+
USA: 309/309 - size: 43M
|
468
|
+
|
469
|
+
stats for model2 platform on coolrom repo...
|
470
|
+
All: 23/25 - size: 355M
|
471
|
+
Japan: 0/2 - size: 0
|
472
|
+
USA: 23/23 - size: 355M
|
473
|
+
|
474
|
+
stats for saturn platform on coolrom repo...
|
475
|
+
All: 0/133 - size: 0
|
476
|
+
USA: 0/133 - size: 0
|
477
|
+
|
478
|
+
stats for psx platform on coolrom repo...
|
479
|
+
All: 84/5025 - size: 20G
|
480
|
+
Australia: 0/1 - size: 0
|
481
|
+
Europe: 0/796 - size: 0
|
482
|
+
France: 0/30 - size: 0
|
483
|
+
Germany: 0/156 - size: 0
|
484
|
+
Italy: 0/21 - size: 0
|
485
|
+
Japan: 0/2147 - size: 0
|
486
|
+
Russia: 0/3 - size: 0
|
487
|
+
Spain: 0/36 - size: 0
|
488
|
+
USA: 84/1835 - size: 20G
|
489
|
+
|
490
|
+
stats for ps2 platform on coolrom repo...
|
491
|
+
All: 0/3173 - size: 0
|
492
|
+
Australia: 0/85 - size: 0
|
493
|
+
China: 0/2 - size: 0
|
494
|
+
Europe: 0/1170 - size: 0
|
495
|
+
France: 0/25 - size: 0
|
496
|
+
Germany: 0/100 - size: 0
|
497
|
+
Italy: 0/18 - size: 0
|
498
|
+
Japan: 0/219 - size: 0
|
499
|
+
Korea: 0/8 - size: 0
|
500
|
+
Netherlands: 0/1 - size: 0
|
501
|
+
Russia: 0/1 - size: 0
|
502
|
+
Spain: 0/47 - size: 0
|
503
|
+
Sweden: 0/2 - size: 0
|
504
|
+
USA: 0/1495 - size: 0
|
505
|
+
|
506
|
+
stats for psp platform on coolrom repo...
|
507
|
+
All: 0/2808 - size: 0
|
508
|
+
Australia: 0/4 - size: 0
|
509
|
+
China: 0/91 - size: 0
|
510
|
+
Europe: 0/609 - size: 0
|
511
|
+
France: 0/43 - size: 0
|
512
|
+
Germany: 0/45 - size: 0
|
513
|
+
Italy: 0/35 - size: 0
|
514
|
+
Japan: 0/1189 - size: 0
|
515
|
+
Korea: 0/107 - size: 0
|
516
|
+
Netherlands: 0/6 - size: 0
|
517
|
+
Norway: 0/2 - size: 0
|
518
|
+
Russia: 0/21 - size: 0
|
519
|
+
Spain: 0/37 - size: 0
|
520
|
+
Sweden: 0/3 - size: 0
|
521
|
+
USA: 0/616 - size: 0
|
522
|
+
```
|
523
|
+
|
524
|
+
### config
|
525
|
+
|
526
|
+
Show config
|
527
|
+
|
528
|
+
```
|
529
|
+
$ gamerom config
|
530
|
+
{:ROM_ROOT=>"/Users/lucas/.gamerom",
|
531
|
+
:CACHE_DIR=>"/Users/lucas/.gamerom/cache",
|
532
|
+
:GAME_DIR=>"/Users/lucas/.gamerom/games",
|
533
|
+
:LOG_DIR=>"/Users/lucas/.gamerom/logs"}
|
534
|
+
```
|
535
|
+
|
536
|
+
### version
|
537
|
+
|
538
|
+
Print program version
|
539
|
+
|
540
|
+
```
|
541
|
+
$ gamerom version
|
542
|
+
0.1.0
|
543
|
+
```
|
544
|
+
|
545
|
+
## Development
|
546
|
+
|
547
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
548
|
+
|
549
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
550
|
+
|
551
|
+
## Contributing
|
552
|
+
|
553
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/lucasmundim/gamerom. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/lucasmundim/gamerom/blob/master/CODE_OF_CONDUCT.md).
|
554
|
+
|
555
|
+
## License
|
556
|
+
|
557
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
558
|
+
|
559
|
+
## Code of Conduct
|
560
|
+
|
561
|
+
Everyone interacting in the Gamerom project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lucasmundim/gamerom/blob/master/CODE_OF_CONDUCT.md).
|