Skip to content

Commit fa59526

Browse files
authored
docs: Add some basic compilation instructions
1 parent eea33cb commit fa59526

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,33 @@ Inkay is an Aroma/WUPS plugin that patches various Nintendo Network URLs on a Wi
1313

1414
Inkay also includes game-specific patches to add extra features:
1515
- Modpack-specific matchmaking for global, regional rooms (by simulating extra DLC) - **Mario Kart 8**
16-
- P2P port override for better connection stability (if you port forward) - **Minecraft: Wii U Edition**
16+
- P2P port override for better connection stability (if you port forward) - **Minecraft: Wii U Edition**, **Mario Kart 8**, **Splatoon**
1717

18-
## Dependencies
18+
## Requirements
1919
Inkay is only supported on the release version of Aroma configured for autoboot/coldboot. Other configurations (specifically lacking coldboot) may cause issues with SpotPass.
2020

2121
## Safety
2222
Inkay's patches are all temporary, and only applied in-memory without modifying your console. The SSL patch, while also temporary, could reduce the overall security of your console while active - this is because it no longer checks if a server is verified. However, this does not apply to the Internet Browser, where SSL still works as expected.
2323

24+
## Compiling - Docker
25+
Inkay's dependencies and build tooling can be handled as a container, which is recommended for WUPS plugins. Using `docker` or `podman`:
26+
```shell
27+
docker build -t inkay .
28+
docker run --rm -v $(pwd):/app inkay make
29+
# you can replace "make" with other commands - e.g. make clean
30+
```
31+
If using `podman` on SELinux systems (like Fedora Linux), you might need to use `$(pwd):/app:Z` instead of `$(pwd):/app`.
32+
33+
## Compiling - System
34+
Inkay has the following dependencies aside from devkitPPC and wut:
35+
- [WiiUPluginSystem](https://github.com/wiiu-env/WiiUPluginSystem)
36+
- [WiiUModuleSystem](https://github.com/wiiu-env/WiiUModuleSystem)
37+
- [libmocha](https://github.com/wiiu-env/libmocha)
38+
- [libkernel](https://github.com/wiiu-env/libkernel/)
39+
- [libnotifications](https://github.com/wiiu-env/libnotifications/)
40+
- [libfunctionpatcher](https://github.com/wiiu-env/libfunctionpatcher)
41+
42+
Each of these should be `make install`-able. After that, you can compile Inkay with `make`.
43+
2444
## TODO
2545
See [Issues](https://github.com/PretendoNetwork/Inkay/issues).

0 commit comments

Comments
 (0)