Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LunarLambda/meson-gba
Meson-based GBA toolchain
https://github.com/LunarLambda/meson-gba
Last synced: 2 months ago
JSON representation
Meson-based GBA toolchain
- Host: GitHub
- URL: https://github.com/LunarLambda/meson-gba
- Owner: LunarLambda
- License: zlib
- Created: 2022-10-15T08:13:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T13:02:02.000Z (8 months ago)
- Last Synced: 2024-11-10T11:45:07.504Z (3 months ago)
- Language: Meson
- Homepage: https://lunarlambda.github.io/meson-gba-book/
- Size: 161 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-gbadev - meson-gba - Meson-based GBA toolkit with support for many different libraries and tools. (Toolkits / Other places)
README
# meson-gba - Modern GBA Development with Meson
This project provides [Meson] build files for various Game Boy Advance libraries and tools.
## Development Notice
This project is still fairly experimental. Things are still messy, but are continuously being
updated and improved. Things might break unexpectedly, and things are developed with the latest
versions of Meson and GCC/devkitARM in mind, so make sure your tools are as up-to-date as can be.
[Projects made with meson-gba](./PROJECTS.md)
## What's Included
Libraries and tools can be accessed using the
[`dependency`][meson-dependency] and [`find_program`][meson-find_program] functions.
Project | Version | Dependencies | Programs
----------------------|--------------------|----------------------------|---------
[agbabi] | 2.1.7 | `agbabi` |
[butano] [^1] [^2] | 17.3.0 | `butano` |
[gba-hpp] | r180.e313a94 | `gba-hpp` |
[gba-link-connection] | 6.2.3 | `gba-link-connection` |
[gbfs] | 2002-02-07 | `gbfs` | `gbfs`, `insgbfs`, `lsgbfs`, `ungbfs`
[gbt-player] | 4.4.1 | `gbt-player` | `mod2gbt`, `s3m2gbt`, `s3msplit`
[grit] | 0.9.2 | | `grit`
[libfat] [^1] | 1.1.5.r2.g69543f0 | `libfat` |
[libgba] | r136.0d46fc9 | `libgba` |
[libsavgba] | 3.3.2 | `libtonc` |
[libseven] | 0.22.3 | `libseven` |
[libtonc] | r15.cc862ce | `libtonc` |
[libugba/libsysgba] | 0.3.0 | `libugba`, `libsysgba` |
[libutil] | r1.743f5d1 | `libutil` |
[maxmod] | 1.0.15 | `maxmod` |
[minrt] | 0.12.0 | `minrt`, `minrt-multiboot` | `makerom`, `gbafix-py`, `bin2s-py`
[mmutil] | 1.10.1 | | `mmutil`
[posprintf] | sdk-seven fork | `posprintf` |
[superfamiconv] | 0.9.2.r16.ga5027f3 | | `superfamiconv`
[^1]: Only available with the devkitARM toolchain.
[^2]: Pulls in code from agbabi, gbt-player, libtonc, libugba, maxmod, posprintf and vgm-player.
You may get linking errors if you try to combine those dependencies with butano. Use a
[partial dependency][meson-partial_dependency] to access includes and build flags.
## Installation and Usage
As all the libraries and tools are compiled from source, the only things you need to have
installed and in your PATH are:
- meson (at least version 1.1.0 or later)
- git
- A compiler for your system (`cl.exe`, `gcc`, etc.)
- A compiler for the GBA (`arm-none-eabi-gcc`)
See the [meson gba book](https://lunarlambda.github.io/meson-gba-book/) for more information.
## Using devkitPro
If you want to use devkitPro (for example, if you want to use libfat), use the following command
to generate a suitable cross file:
Windows, using Powershell (not recommended):
```powershell
$f = gc meson/gba.ini; $f[1] = "path = '$Env:DEVKITARM/bin'"; sc dkarm.ini $f
```
Windows, using MSYS2:
```sh
sed "2cpath = '$(cygpath -m $DEVKITARM/bin)'" meson/gba.ini > dkarm.ini
```
Windows, using WSL / Linux / MacOS:
```sh
sed "2cpath = '$DEVKITARM/bin'" meson/gba.ini > dkarm.ini
```
Then run
```sh
meson setup --cross-file=dkarm.ini build
```
for the setup step.
To build, run:
```sh
ninja -C build
```
The built ROMs (.elf, .gba) will be in the `build` directory.
Check out the `examples` branch for some example projects.
## Compiler Support
This toolchain works both with devkitARM, and "standard" arm-none-eabi-gcc distributions. When
reporting problems, please specify which compiler you're using, and what version (output of
`arm-none-eabi-gcc --version`), as well as the output of `meson setup`.
If you wish to detect the devkitARM compiler specifically:
```meson
cc = meson.get_compiler('c')
cc_ver = run_command(cc, '--version', capture: true, check: false)
have_devkitarm = cc_ver.stdout().to_lower().contains('devkitarm')
```
See the [Meson compiler API][meson-compiler] for other things you can test for.
## License
meson-gba is licensed under the zlib license. See [LICENSE.txt](./LICENSE.txt) for more information.
See the homepages of the bundled projects for their respective licensing.
[agbabi]: https://github.com/felixjones/agbabi
[butano]: https://github.com/GValiente/butano
[gba-hpp]: https://github.com/felixjones/gba-hpp
[gba-link-connection]: https://github.com/rodri042/gba-link-connection
[gbfs]: https://pineight.com/gba/#gbfs
[gbt-player]: https://github.com/AntonioND/gbt-player
[grit]: https://github.com/devkitPro/grit
[libfat]: https://github.com/devkitPro/libfat
[libgba]: https://github.com/gbadev-org/libgba
[libsavgba]: https://github.com/aronson/libsavgba
[libseven]: https://github.com/sdk-seven/libseven
[libtonc]: https://github.com/gbadev-org/libtonc
[libugba/libsysgba]: https://github.com/AntonioND/libugba
[libutil]: https://github.com/sdk-seven/libutil
[maxmod]: https://github.com/devkitPro/maxmod
[minrt]: https://github.com/sdk-seven/runtime
[mmutil]: https://github.com/devkitPro/mmutil
[posprintf]: https://github.com/sdk-seven/posprintf
[superfamiconv]: https://github.com/Optiroc/SuperFamiconv
[Meson]: https://mesonbuild.com/index.html
[meson-compiler]: https://mesonbuild.com/Reference-manual_returned_compiler.html
[meson-dependency]: https://mesonbuild.com/Reference-manual_functions.html#dependency
[meson-find_program]: https://mesonbuild.com/Reference-manual_functions.html#find_program
[meson-options]: https://mesonbuild.com/Build-options.html#using-build-options
[meson-partial_dependency]: https://mesonbuild.com/Reference-manual_returned_dep.html#deppartial_dependency