diff --git a/.gitmodules b/.gitmodules index b31ca17..e021a1e 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ [submodule "agbplay"] path = agbplay - url = https://github.com/ipatix/agbplay + url = https://github.com/ahigerd/agbplay diff --git a/README.md b/README.md new file mode 100644 index 0000000..9689ace --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# agbplay-gui + +**agbplay-gui** is a music player for Game Boy Advance ROMs that use the MusicPlayer2000 +(mp2k/m4a/"Sappy") sound engine. It is based on [agbplay](https://github.com/ipatix/agbplay) +by ipatix. + +![agbplay-gui screenshot](screenshot.png) + +## Building + +agbplay-gui depends on the following libraries: + +* Qt 5 +* PortAudio + +A build script is provided for compiling on Windows using MSYS2. This script will download +and build the required dependencies automatically. This script also supports cross +compiling agbplay-gui from a non-Windows system with MinGW. + +First ensure that the agbplay submodule is checked out and up to date: + +* `git submodule update --init --recursive` + +To build on Windows using the automatic build script: + +* `make -C windows` + +To cross-compile a 32-bit binary using MinGW: + +* `make -C windows CROSS=mingw32` + +To cross-compile a 64-bit binary using MinGW: + +* `make -C windows CROSS=mingw64` + +To build using locally-installed libraries: + +* `qmake` +* `make` + +## License + +**agbplay-gui** is created by Adam Higerd. It is derived from agbplay by +ipatix. Both agbplay and agbplay-gui are distributed under the terms of +the LGPLv3. + +*This program is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your +option) any later version.* + +*This program is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public +License for more details.* + +*For more information about the GNU Lesser General Public License, see +[https://www.gnu.org/licenses](https://www.gnu.org/licenses).* + +agbplay source code: [https://github.com/ipatix/agbplay](https://github.com/ipatix/agbplay) diff --git a/resources/about.html b/resources/about.html index 7a0bfb6..2af3e94 100644 --- a/resources/about.html +++ b/resources/about.html @@ -5,22 +5,22 @@

agbplay-gui is created by Adam Higerd. It is derived from agbplay by ipatix. Both agbplay and agbplay-gui are distributed under the terms of - the GPLv3. + the LGPLv3.

This program is free software: you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by the + under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General - Public License for more details. + WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public + License for more details.

- For more information about the GNU General Public License, see + For more information about the GNU Lesser General Public License, see https://www.gnu.org/licenses.

diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..566bde3 Binary files /dev/null and b/screenshot.png differ