https://github.com/sonodima/clay3ds
Single-header Clay renderer for the 3DS using Citro2D
https://github.com/sonodima/clay3ds
Last synced: 3 months ago
JSON representation
Single-header Clay renderer for the 3DS using Citro2D
- Host: GitHub
- URL: https://github.com/sonodima/clay3ds
- Owner: sonodima
- License: mit
- Created: 2024-12-30T16:52:58.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-31T09:06:35.000Z (5 months ago)
- Last Synced: 2024-12-31T09:31:58.357Z (5 months ago)
- Language: C
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Clay3DS
Clay3DS is a library that makes it easy to use the [Clay](https://github.com/nicbarker/clay) library on the Nintendo 3DS.
It provides a fully featured 2D renderer with basic shapes, rounded corners, and text rendering with custom font support.
## Installation
Clay3DS is header only, so just include its header after including `clay.h` and you are good.
You can also use CMake FetchContent if you feel fancy.
## Usage
**LOOK AT THE [EXAMPLES](examples)**
## Running the Examples
The easiest way to build the examples is to use [Docker](https://www.docker.com) and the provided `Dockerfile`.
### Docker Builds
Install Docker on your system, and then execute the following command in this directory:
```sh
docker build --rm -t clay3ds --output type=tar,dest=artifacts.tar .
```
After the build is finished, a file named `artifacts.tar`, containing all the executables, will be created.
### Manual Builds
If you want to compile the examples manually, you will need to install `git`, `cmake` and [devkitPro](https://devkitpro.org/wiki/Getting_Started) on your system, and install the `3ds-dev` group using the following commands:
```sh
dkp-pacman -S 3ds-dev
```
---
```sh
# Use the CMake wrapper provided by devkitPro to configure the project.
/opt/devkitpro/portlibs/3ds/bin/arm-none-eabi-cmake -S . -DCLAY3DS_BUILD_EXAMPLES=true -B build
# Compile the project in release mode.
cmake -B build -C Release
```
If the compilation succeeds, in the `build` folder you will find the `3dsx` packages you can load on your device.