librpxloader/README.md

33 lines
1.3 KiB
Markdown
Raw Normal View History

2022-02-12 15:28:56 +01:00
[![Publish Docker Image](https://github.com/wiiu-env/librpxloader/actions/workflows/push_image.yml/badge.svg)](https://github.com/wiiu-env/librpxloader/actions/workflows/push_image.yml)
2022-02-12 15:26:09 +01:00
# librpxloader
Requires the [RPXLoadingModule](https://github.com/wiiu-env/RPXLoadingModule) to be running via [WUMSLoader](https://github.com/wiiu-env/WUMSLoader).
Requires [wut](https://github.com/devkitPro/wut) for building.
2021-01-16 23:00:50 +01:00
Install via `make install`.
2021-04-07 16:07:54 +02:00
## Usage
2021-01-16 23:00:50 +01:00
2022-04-22 22:25:45 +02:00
Make sure to define
2021-04-07 16:07:54 +02:00
```
WUMS_ROOT := $(DEVKITPRO)/wums
```
and add `-lrpxloader` to `LIBS` and `$(WUMS_ROOT)` to `LIBDIRS`.
2022-04-22 22:25:45 +02:00
After that you can simply include `<rpxloader/rpxloader.h>` to get access to the RPXLoader functions.
To init the library call `RPXLoader_Init()` and check for the `RPX_LOADER_RESULT_SUCCESS` return code.
2021-04-07 16:07:54 +02:00
## 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.
```
[...]
COPY --from=wiiuenv/librpxloader:[tag] /artifacts $DEVKITPRO
[...]
```
Replace [tag] with a tag you want to use, a list of tags can be found [here](https://hub.docker.com/r/wiiuenv/librpxloader/tags).
2022-02-12 15:28:56 +01:00
It's highly recommended to pin the version to the **latest date** instead of using `latest`.
## Format the code via docker
2022-04-22 22:25:45 +02:00
`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./source ./include -i`