Skip to content

Commit

Permalink
Rename project name to "ia-rcade" into sources
Browse files Browse the repository at this point in the history
  • Loading branch information
TiBeN committed Aug 12, 2018
1 parent 0a39cb6 commit ada011b
Show file tree
Hide file tree
Showing 58 changed files with 219 additions and 223 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
CHANGELOG
=========

Current
-------

- Change project name to `ia-arcade`

1.0
---

Expand Down
39 changes: 13 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,6 @@ notes](https://github.com/TiBeN/ia-rcade#legal) below.

![preview](./doc/screenshot.png)

Watch `ia-rcade` in action with the following screencast made by [Geoff
Yuen](https://vimeo.com/user51410922):

[![ia-rcade on OS X
demo](https://i.vimeocdn.com/video/567335844.jpg)](https://vimeo.com/163855518)

Prerequisites
-------------

Expand Down Expand Up @@ -68,8 +62,8 @@ Installation

- Install `ia-rcade` and make it executable:

$ sudo curl -fsSLo /usr/local/bin/ia-mame https://github.com/TiBeN/ia-mame/releases/download/1.0/ia-mame
$ sudo chmod +x /usr/local/bin/ia-mame
$ sudo curl -fsSLo /usr/local/bin/ia-rcade https://github.com/TiBeN/ia-mame/releases/download/1.1/ia-rcade
$ sudo chmod +x /usr/local/bin/ia-rcade

- Tell `ia-rcade` where is your Mame executable by making it available
on your \$PATH environment variable — its name must match
Expand All @@ -83,7 +77,7 @@ Installation
### Windows

- Download
[ia-mame.exe](https://github.com/TiBeN/ia-mame/releases/download/1.0/ia-mame.exe)
[ia-rcade.exe](https://github.com/TiBeN/ia-rcade/releases/download/1.1/ia-rcade.exe)
and place it on the folder where is your mame.exe

You can alternatively place it somewhere else and use the \$MAME\_EXEC
Expand All @@ -104,7 +98,7 @@ The compilation requires `Maven`.
$ cd /path/to/ia-rcade
$ mvn package

The binary files `ia-mame` (Linux/OS X) and `ia-mame.exe` (Windows) and
The binary files `ia-rcade` (Linux/OS X) and `ia-rcade.exe` (Windows) and
the executable jar are available on the `target` directory.

Usage
Expand All @@ -119,40 +113,33 @@ Mame executable which launches the game/system.

### Linux, Os X

Let's try `The King Of Fighters '98`. Simply type what you would have
typed with the original Mame to launch the game:

$ ia-mame kof98
Let's try `Galaxian`. Simply type what you would have typed with the original
Mame to launch the game:

![King Of Fighters 98 launched on Linux using
ia-rcade](./doc/screenshot3.png)
$ ia-rcade galaxian

### Windows

Let's try Columns on the Sega Master System.

Open a console `cmd` then type:
Let's try Pacman. Open a console `cmd` then type:

C:\> cd \path\to\mame
C:\> ia-mame.exe sms columns

![Columns launched on Windows using ia-rcade](./doc/screenshot4.png)
C:\> ia-rcade.exe pacman

### Executable JAR

Alternatively, the provided [executable
jar](https://github.com/TiBeN/ia-rcade/releases/download/1.0/ia-mame.jar)
jar](https://github.com/TiBeN/ia-rcade/releases/download/1.1/ia-rcade.jar)
can be used directly:

$ java -jar ia-mame.jar sf2
$ java -jar ia-rcade.jar sf2

### Use a different rompath

If you want to try `ia-rcade` using a different rompath than your Mame's
default, you can use the original Mame option `-rompath` on the
command-line.

$ ia-mame -rompath /tmp sms sonic
$ ia-rcade -rompath /tmp sms sonic

### Disable Mame execution

Expand All @@ -161,7 +148,7 @@ It is possible to run `ia-rcade` without running Mame afterward using the
rom file without execute the game. If the rom is already available,
`ia-rcade` simply does nothing.

$ ia-mame -noexecmame sms sonic
$ ia-rcade -noexecmame sms sonic

Known limitations
-----------------
Expand Down
Binary file modified doc/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/screenshot2.png
Binary file not shown.
Binary file removed doc/screenshot3.png
Binary file not shown.
Binary file removed doc/screenshot4.png
Binary file not shown.
32 changes: 16 additions & 16 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.tibennetwork</groupId>
<artifactId>ia-mame</artifactId>
<artifactId>ia-rcade</artifactId>
<version>1.0</version>
<packaging>jar</packaging>
<name>ia-mame</name>
<url>https://github.com/TiBeN/ia-mame</url>
<name>ia-rcade</name>
<url>https://github.com/TiBeN/ia-rcade</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
Expand All @@ -25,7 +25,7 @@
<artifactId>maven-jar-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<finalName>ia-mame</finalName>
<finalName>ia-rcade</finalName>
</configuration>
</plugin>
<plugin>
Expand All @@ -40,10 +40,10 @@
</execution>
</executions>
<configuration>
<mainClass>org.tibennetwork.iamame.IaMame</mainClass>
<mainClass>org.tibennetwork.iarcade.IaRcade</mainClass>
<systemProperties>
<systemProperty>
<key>iamame.debug</key>
<key>iarcade.debug</key>
<value>1</value>
</systemProperty>
</systemProperties>
Expand All @@ -63,7 +63,7 @@
<configuration>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>org.tibennetwork.iamame.IaMame</mainClass>
<mainClass>org.tibennetwork.iarcade.IaRcade</mainClass>
</transformer>
</transformers>
<createDependencyReducedPom>
Expand All @@ -87,11 +87,11 @@
</goals>
<configuration>
<headerType>console</headerType>
<outfile>target/ia-mame.exe</outfile>
<jar>target/ia-mame.jar</jar>
<errTitle>ia-mame</errTitle>
<outfile>target/ia-rcade.exe</outfile>
<jar>target/ia-rcade.jar</jar>
<errTitle>ia-rcade</errTitle>
<classPath>
<mainClass>org.tibennetwork.iamame.IaMame</mainClass>
<mainClass>org.tibennetwork.iarcade.IaRcade</mainClass>
<addDependencies>false</addDependencies>
<preCp>anything</preCp>
</classPath>
Expand All @@ -101,13 +101,13 @@
<versionInfo>
<fileVersion>0.0.0.1</fileVersion>
<txtFileVersion>first</txtFileVersion>
<fileDescription>IaMame executable</fileDescription>
<fileDescription>ia-rcade executable</fileDescription>
<copyright>github.com/TiBeN</copyright>
<productVersion>0.0.${project.version}</productVersion>
<txtProductVersion>${project.version}</txtProductVersion>
<productName>IaMame</productName>
<internalName>IaMame</internalName>
<originalFilename>ia-mame.exe</originalFilename>
<productName>ia-rcade</productName>
<internalName>ia-rcade</internalName>
<originalFilename>ia-rcade.exe</originalFilename>
</versionInfo>
</configuration>
</execution>
Expand All @@ -119,7 +119,7 @@
<artifactId>really-executable-jar-maven-plugin</artifactId>
<version>1.4.1</version>
<configuration>
<programFile>ia-mame</programFile>
<programFile>ia-rcade</programFile>
</configuration>
<executions>
<execution>
Expand Down
6 changes: 3 additions & 3 deletions src/assembly/release.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
<directory>${project.basedir}/target</directory>
<outputDirectory>${file.separator}bin</outputDirectory>
<includes>
<include>ia-mame</include>
<include>ia-mame.exe</include>
<include>ia-mame.jar</include>
<include>ia-rcade</include>
<include>ia-rcade.exe</include>
<include>ia-rcade.jar</include>
</includes>
</fileSet>
</fileSets>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.tibennetwork.iamame;
package org.tibennetwork.iarcade;

import java.io.File;
import java.io.IOException;
Expand All @@ -12,16 +12,16 @@
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.commons.io.FilenameUtils;
import org.tibennetwork.iamame.mame.CommandLineOptions;
import org.tibennetwork.iamame.mame.InvalidMameArgumentsException;
import org.tibennetwork.iamame.mame.Machine;
import org.tibennetwork.iamame.mame.MachineDoesntExistException;
import org.tibennetwork.iamame.mame.MachineHasNoSoftwareListException;
import org.tibennetwork.iamame.mame.MachineRepository;
import org.tibennetwork.iamame.mame.MediaDevice;
import org.tibennetwork.iamame.mame.Software;
import org.tibennetwork.iamame.mame.SoftwareNotFoundInSoftwareListsException;
import org.tibennetwork.iamame.mame.SoftwareRepository;
import org.tibennetwork.iarcade.mame.CommandLineOptions;
import org.tibennetwork.iarcade.mame.InvalidMameArgumentsException;
import org.tibennetwork.iarcade.mame.Machine;
import org.tibennetwork.iarcade.mame.MachineDoesntExistException;
import org.tibennetwork.iarcade.mame.MachineHasNoSoftwareListException;
import org.tibennetwork.iarcade.mame.MachineRepository;
import org.tibennetwork.iarcade.mame.MediaDevice;
import org.tibennetwork.iarcade.mame.Software;
import org.tibennetwork.iarcade.mame.SoftwareNotFoundInSoftwareListsException;
import org.tibennetwork.iarcade.mame.SoftwareRepository;

/**
* Set of Mame command line arguments
Expand Down Expand Up @@ -63,7 +63,7 @@ public boolean hasSoftwares () {
/**
* IaMmame specific options
*/
private Options iaMameOptions;
private Options iaRcadeOptions;

/**
* Mame specific options
Expand All @@ -77,7 +77,7 @@ public boolean hasSoftwares () {
public CommandLineArguments (CommandLineOptions mameOptions, String[] rawArgs)
throws InvalidMameArgumentsException {
this.mameOptions = mameOptions;
this.iaMameOptions = buildIaMameOptions();
this.iaRcadeOptions = buildIaRcadeOptions();
this.rawArgs = rawArgs;
}

Expand Down Expand Up @@ -112,9 +112,9 @@ public String[] getMameRawArgs () {

optionsLoop: for (Option o: this.commandLine.getOptions()) {

// Discard IaMame options
// Discard ia-rcade options

for (Option ia: this.iaMameOptions.getOptions()) {
for (Option ia: this.iaRcadeOptions.getOptions()) {
if (o.getOpt().equals(ia.getOpt())) {
continue optionsLoop;
}
Expand Down Expand Up @@ -163,9 +163,9 @@ public String[] getMameOptionsRawArgs () {
}
}

// Discard IaMame options
// Discard ia-rcade options

for (Option ia: this.iaMameOptions.getOptions()) {
for (Option ia: this.iaRcadeOptions.getOptions()) {
if (o.getOpt().equals(ia.getOpt())) {
continue optionsLoop;
}
Expand Down Expand Up @@ -281,13 +281,13 @@ public ExtractedMachineAndSoftwares extractMachineAndSoftwares (
public void validate ()
throws InvalidMameArgumentsException {

// Merge IaMame and Mame options
// Merge ia-rcade and Mame options

Options mergedOptions = new Options();
for (Option o: mameOptions.getAllOptions().getOptions()) {
mergedOptions.addOption(o);
}
for (Option o: iaMameOptions.getOptions()) {
for (Option o: iaRcadeOptions.getOptions()) {
mergedOptions.addOption(o);
}

Expand Down Expand Up @@ -315,11 +315,11 @@ private boolean isRegularSoftwareFile (String name) {
}

/**
* Create Options bag for ia-mame specific options
* Create Options bag for ia-rcade specific options
*/
private Options buildIaMameOptions () {
private Options buildIaRcadeOptions () {

// Build IaMame specific options
// Build ia-rcade specific options

Options opts = new Options();

Expand Down
Loading

0 comments on commit ada011b

Please sign in to comment.