https://github.com/wiiu-env/WiiUModuleSystem

https://github.com/wiiu-env/WiiUModuleSystem

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/wiiu-env/WiiUModuleSystem
• Owner: wiiu-env
• License: lgpl-3.0
• Created: 2020-05-17T19:08:41.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-03T10:43:19.000Z (about 1 year ago)
• Last Synced: 2023-12-03T11:29:07.119Z (about 1 year ago)
• Language: C
• Size: 71.3 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Publish Docker Image](https://github.com/wiiu-env/WiiUModuleSystem/actions/workflows/push_image.yml/badge.svg)](https://github.com/wiiu-env/WiiUModuleSystem/actions/workflows/push_image.yml)

# Wii U Module System

This lib is designed to build modules to be loaded with the [Wii U Module System Loader](https://github.com/wiiu-env/WUMSLoader).

## Usage

A module needs to implements at least the following macros.

```C++

#include 

WUMS_MODULE_EXPORT_NAME("homebrew_modulename");

WUMS_INITIALIZE() {

    /** THIS CODE WILL BE RUN ONCE **/ 

}

```

The `WUMS_MODULE_EXPORT_NAME` needs to be a globally unique name across all loaded modules. `WUMS_INITIALIZE` defines the code that will be run after the module was loaded.

The module will have full permission to the sd card via `fs:/vol/external01`.

### Optional macros/hooks

Other optional macros/hooks are support, here some examples:

```C++

WUMS_APPLICATION_STARTS() {

    /** Is called when a new application was started. **/

}

WUMS_APPLICATION_REQUESTS_EXIT() {

    /** Is called when a new application is going to be closed. **/

}

```

This list is incomplete, see `hooks.h` for all hooks and `meta.h` for all macros.

### Export functions

Modules can be used to export functions for other modules or "normal" applications.

```C++

#include 

void MyCustomFunction() {

    /** Some special code that should be useable for everyone */

}

WUMS_EXPORT_FUNCTION(MyCustomFunction);

```

This function can then be used like they would be inside a .rpl, where the name of the "rpl" is the one defined in `WUMS_MODULE_EXPORT_NAME`.

Example using the Cafe OS OSDynLoad API:

```C++

if (OSDynLoad_Acquire("homebrew_modulename", &sModuleHandle) != OS_DYNLOAD_OK) {

    OSFatal("OSDynLoad_Acquire failed.");

}

void (*sMyCustomFunction)() = NULL;

if (OSDynLoad_FindExport(sModuleHandle, FALSE, "MyCustomFunction", (void**) &sMyCustomFunction) != OS_DYNLOAD_OK) {

    OSFatal("OSDynLoad_FindExport failed.");

}

```

## 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.

```Dockerfile

[...]

COPY --from=ghcr.io/wiiu-env/wiiumodulesystem:[tag] /artifacts $DEVKITPRO

[...]

```

Replace [tag] with a tag you want to use, a list of tags can be found [here](https://github.com/orgs/wiiu-env/packages/container/wiiumodulesystem/versions). 

It's highly recommended to pin the version to the **latest date** instead of using `latest`.

## Format the code via docker

```bash

docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./include ./libraries ./example/example_module/source -i

```