https://github.com/antoniond/ugba-template
Template of how to integrate libugba in a project.
https://github.com/antoniond/ugba-template
Last synced: about 1 month ago
JSON representation
Template of how to integrate libugba in a project.
- Host: GitHub
- URL: https://github.com/antoniond/ugba-template
- Owner: AntonioND
- Created: 2021-07-15T23:37:13.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-01T01:31:14.000Z (about 3 years ago)
- Last Synced: 2025-04-03T19:16:04.382Z (about 1 month ago)
- Language: C
- Size: 178 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.rst
- License: licenses/kaos_och_dekadens.txt
Awesome Lists containing this project
README
UGBA template
=============
1. Preparation
--------------
This is a template of how to integrate `libugba`_ and `UMOD Player`_ in your
own project by adding them as submodules. Check `UGBA Testing`_ for examples of
what the library can do.
You can add files to the ``data`` folder, graphics to the ``graphics`` folder,
and music and SFX files to the ``audio`` folder. You'll need to adjust the asset
conversion scripts accordingly.
Before building this template, check the `libugba`_ repository and install the
dependencies that the readme mentions.
2. Build for host
-----------------
Just run the following commands:
.. code:: bash
git clone --recurse-submodules https://github.com/AntonioND/ugba-template
cd ugba-template
bash assets.sh
mkdir build
cd build
cmake .. -DBUILD_GBA=OFF
make -j`nproc`
3. Build for GBA
----------------
This will fetch all the code and convert the assets,
.. code:: bash
git clone --recurse-submodules https://github.com/AntonioND/ugba-template
cd ugba-template
bash assets.sh
This will build the GBA and host targets at the same time with **devkitPro**:
.. code:: bash
mkdir build
cd build
cmake ..
make -j`nproc`
This will build the GBA and host targets at the same time without **devkitPro**:
.. code:: bash
mkdir build
cd build
cmake .. -DUSE_DEVKITARM=OFF
make -j`nproc`
To override the autodetected location of the cross compiler, you can add
``-DARM_GCC_PATH=/path/to/folder/`` to the ``cmake`` command.
.. _libugba: https://github.com/AntonioND/libugba
.. _UGBA Testing: https://github.com/AntonioND/ugba-testing
.. _UMOD Player: https://github.com/AntonioND/umod-player