controller_patcher/README.md
Mark J.F. Teunissen 7ea483e70f
Update README.md
Added docker info to readme file.
2018-12-26 17:22:02 +01:00

68 lines
2.1 KiB
Markdown

[![Build Status](https://travis-ci.org/Maschell/controller_patcher.svg?branch=master)](https://travis-ci.org/Maschell/controller_patcher)
# What is in this controller_patcher repository
These files are the magic behind tools like HID to VPAD and can used to use your USB HID Device on your WiiU console.
# How to create config files
Detailed information about creating config files and adding support for more controller can be found in the [wiki](https://github.com/Maschell/controller_patcher/wiki)
# Where can I find config files
Configfiles for all controllers are collection in [this repository](https://github.com/Maschell/controller_patch_configs)
## Logging usage
To able to use the logging change the "DO_LOGGING" parameter in the Makefile.
# Compiling
You either need to install all dependencies first! Or use the provided docker configuration.
Start the docker container by running:
``` docker-compose up ```
When this container is running you'll be able to run the rest of the command below inside this container.
This container will have all dependencies required to be able to make and make install the app:
- devkitpro/devkitppc
- libutils
- dynamic_libs
Install this static library into your portlibs folder via:
```
make && make install
```
Link the application with
```
-lutils -ldynamiclibs -lcontrollerpatcher
```
You also need to add the include path to your Makefile. Example:
```
export INCLUDE := [...] -I$(PORTLIBS)/include
```
# Dependencies
- Application needs to be loaded from the [homebrew_launcher](https://github.com/dimok789/homebrew_launcher)
- [libutils](https://github.com/Maschell/libutils) for common functions.
- [dynamic_libs](https://github.com/Maschell/dynamic_libs/tree/lib) for access to the functions.
# Example implementation
### How to "install" it
TODO!
```
ControllerPatcher::Init(NULL); //No custom configuration
ControllerPatcher::disableControllerMapping();
ControllerPatcher::startNetworkServer();
```
```
ControllerPatcher::DeInit();
ControllerPatcher::stopNetworkServer();
```
# Credits:
- Maschell
- FIX94 - huge thanks to him and his initally created gc-to-vpad. Was a motivation and base to start all this