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

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

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/wiiu-env/NotificationModule
• Owner: wiiu-env
• License: gpl-3.0
• Created: 2023-01-26T13:25:51.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-06T13:01:21.000Z (6 months ago)
• Last Synced: 2024-07-07T14:03:17.587Z (6 months ago)
• Language: C++
• Size: 85.9 KB
• Stars: 10
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CI-Release](https://github.com/wiiu-env/NotificationModule/actions/workflows/ci.yml/badge.svg)](https://github.com/wiiu-env/NotificationModule/actions/workflows/ci.yml)

See [libnotifications](https://github.com/wiiu-env/libnotifications).

## Usage

(`[ENVIRONMENT]` is a placeholder for the actual environment name.)

1. Copy the file `NotificationModule.wms` into `sd:/wiiu/environments/[ENVIRONMENT]/modules`.  

2. Requires the [WUMSLoader](https://github.com/wiiu-env/WUMSLoader) in `sd:/wiiu/environments/[ENVIRONMENT]/modules/setup`.

## Buildflags

### Logging

Building via `make` only logs errors (via OSReport). To enable logging via the [LoggingModule](https://github.com/wiiu-env/LoggingModule) set `DEBUG` to `1` or `VERBOSE`.

`make` Logs errors only (via OSReport).  

`make DEBUG=1` Enables information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).  

`make DEBUG=VERBOSE` Enables verbose information and error logging via [LoggingModule](https://github.com/wiiu-env/LoggingModule).

If the [LoggingModule](https://github.com/wiiu-env/LoggingModule) is not present, it'll fall back to UDP (Port 4405) and [CafeOS](https://github.com/wiiu-env/USBSerialLoggingModule) logging.

## Building using the Dockerfile

It's possible to use a docker image for building. This way you don't need anything installed on your host system.

```

# Build docker image (only needed once)

docker build . -t notificationmodule-builder

# make 

docker run -it --rm -v ${PWD}:/project notificationmodule-builder make

# make clean

docker run -it --rm -v ${PWD}:/project notificationmodule-builder make clean

```

## Format the code via docker

`docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./src -i`