mirror of
https://github.com/wiiu-env/WiiUPluginSystem.git
synced 2024-11-13 06:15:11 +01:00
Update the README
This commit is contained in:
Maschell
parent
54b09fe44c
commit
7f68073112
@ -1,4 +1,4 @@
|
||||
FROM wiiuenv/devkitppc:20220806
|
||||
FROM wiiuenv/devkitppc:20230218
|
||||
|
||||
WORKDIR tmp_build
|
||||
COPY . .
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
FROM wiiuenv/devkitppc:20220806
|
||||
FROM wiiuenv/devkitppc:20230218
|
||||
|
||||
WORKDIR tmp_build
|
||||
COPY . .
|
||||
@ -8,7 +8,7 @@ WORKDIR /artifacts
|
||||
FROM scratch as libwups
|
||||
COPY --from=0 /artifacts /artifacts
|
||||
|
||||
FROM wiiuenv/devkitppc:20220806
|
||||
FROM wiiuenv/devkitppc:20230218
|
||||
|
||||
COPY --from=libwups /artifacts $DEVKITPRO
|
||||
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
FROM wiiuenv/devkitppc:20220806
|
||||
FROM wiiuenv/devkitppc:20230218
|
||||
|
||||
WORKDIR project
|
||||
78
README.MD
78
README.MD
@ -1,69 +1,31 @@
|
||||
[Nightly builds](https://github.com/Maschell/WiiUPluginSystem/releases) | [Issue Tracker](https://github.com/Maschell/WiiUPluginSystem/issues) | [Discussion](https://gbatemp.net/threads/wii-u-plugin-system.496659/). | [Discord](https://discord.gg/bZ2rep2) | [Wiki](https://maschell.github.io/WiiUPluginSystem/dev_overview.html)
|
||||
# Plugin system for the Wii U. (WIP) [](https://travis-ci.org/Maschell/WiiUPluginSystem)
|
||||
|
||||
WARNING: THIS PROJECT HAS JUST STARTED AND IS FOR DEVS AND PEOPLE WHO WANT TO PLAY AROUND WITH NEW THINGS. IT MAY BE BUGGY, FEATURE COULD BREAK AT ANY TIME, INTERFACES CAN CHANGE, AND MANY BUGS CAN OCCUR. THIS APPLICATION COMES WITH NO WARRANTY-
|
||||
|
||||
[Issue Tracker](https://github.com/wiiu-env/WiiUPluginSystem/issues) | [Discord](https://discord.gg/bZ2rep2)
|
||||
|
||||
# What is the Wii U Plugin System?
|
||||
|
||||
The Wii U Plugin allows you to load multiple plugins on your Wii U which enhance your experience.
|
||||
For example you can mod your games, use USB controller, swap your gamepad and TV screen and much more.
|
||||
# How to build
|
||||
The Wii U Plugin System is a library to create plugins for the [WiiUPluginLoaderBackend](https://github.com/wiiu-env/WiiUPluginLoaderBackend).
|
||||
See the repository of the Backend for more information.
|
||||
|
||||
A detailed instruction can be found in the Wiki:
|
||||
## How create plugins
|
||||
See the [example plugin](https://github.com/wiiu-env/WiiUPluginSystem/tree/master/plugins/example_plugin) for more information about creating a plugin.
|
||||
|
||||
- [Installing the required libraries for creating plugins](https://maschell.github.io/WiiUPluginSystem/dev_required_libraries.html)
|
||||
## Compile and install the WUPS lib
|
||||
For building you need:
|
||||
- [wut](https://github.com/devkitPro/wut)
|
||||
|
||||
# Plugin loader
|
||||
To load the plugins, you need the WiiUPluginLoader, you can find it [here](https://github.com/Maschell/WiiUPluginLoader).
|
||||
Install them (in this order) according to their README's. Don't forget the dependencies of the libs itself.
|
||||
|
||||
# Plugins
|
||||
Then you can compile and install this lib via `make install`.
|
||||
|
||||
Last but not least you need to build the plugins that should be loaded.
|
||||
Plugins depend on the "WUPS library" installed in build step one, other dependencies are optional.
|
||||
|
||||
This is a (maybe incomplete) list of currently available plugins:
|
||||
|
||||
- [HID to VPAD](https://github.com/Maschell/hid_to_vpad/tree/wups):
|
||||
Port of [HID to VPAD](https://github.com/Maschell/hid_to_vpad).
|
||||
No configuration is possible yet, all controllers map automatically to the game pad, pro controller mapping not support. Network client is working.
|
||||
- [Screenshot plugin](https://github.com/Maschell/ScreenshotWUPS):
|
||||
Simple plugin that take a screenshot by presing L+R+ZL+ZR on the gamepad. Button combo can be changed.
|
||||
- [Streaming plugin](https://github.com/Maschell/StreamingPluginWiiU):
|
||||
Gamepad streaming tool. Requires the [StreamingPluginClient](https://github.com/Maschell/StreamingPluginClient)
|
||||
- [SD Cafiine](https://github.com/Maschell/SDCafiine/tree/wups):
|
||||
Port of the orignal SDCafiine (https://github.com/Maschell/SDCafiine). No NTFS support yet.
|
||||
- [SwipSwapMe](https://github.com/Maschell/SwipSwapMe):
|
||||
Swaps the TV and gamepad screen via a buttons combo.The button combo can be changed.
|
||||
- [Diibugger](https://github.com/Maschell/DiiBuggerWUPS):
|
||||
Port of the DiiBugger.
|
||||
- [WUPSPluginPlayground (Various other demo plugins)](https://github.com/Maschell/WUPSPluginPlayground):
|
||||
This repository is supposed to hold serveral small testing plugins for the Wii U Plugin System.
|
||||
Most of the plugin are either really small (Padcon, NNU_Patcher) or are just for testing / gathering information.
|
||||
|
||||
# Configuration of the plugins
|
||||
Plugins can register to the configuration menu.
|
||||
This configuration menu can be opened while running any application (e.g. while gameplay).
|
||||
|
||||
Just press **L, DPAD down and minus** on the gamepad.
|
||||
|
||||
This does only work when the game is allowed to open the home menu.
|
||||
Settings made using the configuration menu will be saved to the SD Card and reloaded the next time the plugin will be used.
|
||||
|
||||
# Logging
|
||||
For logging (for example of the loader) you need to start the UdpDebugReader on a computer in the same network.
|
||||
This has been created by @dimok789 and can be found in the tools folder.
|
||||
|
||||
# Future and contribution
|
||||
On the Discord you can more information about open tasks and how to contribute: https://discord.gg/bZ2rep2
|
||||
## 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/wiiupluginsystem:[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/wiiupluginsystem/tags).
|
||||
It's highly recommended to pin the version to the **latest date** instead of using `latest`.
|
||||
|
||||
## Format the code via docker
|
||||
|
||||
`docker run --rm -v ${PWD}:/src wiiuenv/clang-format:13.0.0-2 -r ./include ./libraries ./plugins/example_plugin/src -i`
|
||||
|
||||
# Credits
|
||||
Some files are based on brainslug by Chadderz:
|
||||
https://github.com/Chadderz121/brainslug-wii
|
||||
Much stuff also wouldn't be possible without dimok789. He made many great tools and homebrew this stuff in based on (Makefiles, Mocha, homebrew channel, udp logger, dynamic_libs etc.)
|
||||
Also thanks to everyone who made actual exploits.
|
||||
Thanks to dhewg for wiiload:
|
||||
http://wiibrew.org/wiki/Wiiload
|
||||
|
||||
Loading…
Reference in New Issue
Block a user