libcontentredirection/README.md

30 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2022-04-14 22:32:09 +02:00
[![Publish Docker Image](https://github.com/wiiu-env/libcontentredirection/actions/workflows/push_image.yml/badge.svg)](https://github.com/wiiu-env/libcontentredirection/actions/workflows/push_image.yml)
# libcontentredirection
Requires the [ContentRedirectionModule](https://github.com/wiiu-env/ContentRedirectionModule) to be running via [WUMSLoader](https://github.com/wiiu-env/WUMSLoader).
Requires [wut](https://github.com/devkitPro/wut) for building.
Install via `make install`.
## Usage
Make sure to define
```
WUMS_ROOT := $(DEVKITPRO)/wums
```
and add `-lcontentredirection` to `LIBS` and `$(WUMS_ROOT)` to `LIBDIRS`.
After that you can simply include `<content_redirection/redirection.h>`, call `ContentRedirection_Init();` to get access to the content redirection functions if it returns `CONTENT_REDIRECTION_RESULT_SUCCESS`.
## Use this lib in Dockerfiles.
A prebuilt version of this lib can found on dockerhub. To use it for your projects, add this to your Dockerfile.
```
[...]
2023-04-01 08:32:10 +02:00
COPY --from=ghcr.io/wiiu-env/libcontentredirection:[tag] /artifacts $DEVKITPRO
2022-04-14 22:32:09 +02:00
[...]
```
2023-04-01 08:32:10 +02:00
Replace [tag] with a tag you want to use, a list of tags can be found [here](https://github.com/wiiu-env/libcontentredirection/pkgs/container/libcontentredirection/versions).
2022-04-14 22:32:09 +02:00
It's highly recommended to pin the version to the **latest date** instead of using `latest`.
## Format the code via docker
2023-04-01 08:32:10 +02:00
`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source ./include -i`