You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The emulator can be build with [Maven](https://maven.apache.org/):
10
10
11
11
mvn clean package
12
12
13
-
The coffee-gb-*-complete.jar executable file will be available in the `./target` directory.
13
+
The coffee-gb-*.jar executable file will be available in the `./swing/target` directory.
14
14
15
15
## Usage
16
16
@@ -32,12 +32,20 @@ Play with <kbd>←</kbd>, <kbd>↑</kbd>, <kbd>↓</kbd>, <kbd>→</
32
32
* Support for zipped ROMs
33
33
* ROM-based compatibility tests run from Maven
34
34
35
+
## Modules
36
+
37
+
Emulator is split into modules:
38
+
39
+
* core - the core emulator. This module can be easily referenced from other projects.
40
+
* swing - the desktop UI with executable.
41
+
* controller - the middleware between the UI and the core. It also contains network support.
42
+
35
43
## Running Blargg's tests
36
44
37
45
The [Blargg's test ROMs](http://gbdev.gg8.se/wiki/articles/Test_ROMs) are used for testing the compatibility. Tests can be launched from Maven using appropriate profile:
38
46
39
-
mvn clean test -Ptest-blargg
40
-
mvn clean test -Ptest-blargg-individual # for running "single" tests providing more diagnostic info
47
+
mvn clean test -f core/pom.xml -Ptest-blargg
48
+
mvn clean test -f core/pom.xml -Ptest-blargg-individual # for running "single" tests providing more diagnostic info
41
49
42
50
They are also part of the [Travis-based CI](https://travis-ci.org/trekawek/coffee-gb).
43
51
@@ -66,7 +74,7 @@ Coffee GB passes all the tests:
66
74
67
75
The [Mooneye GB](https://github.com/Gekkio/mooneye-gb) emulator comes with a great set of test ROMs. They can be used to test the Coffee GB as well. Use -Ptest-mooneye profile:
0 commit comments