日本語 README はこちら / Japanese README
OpenDiamond is an open-source WUPS plugin for Minecraft: Wii U Edition. It builds only against the WUPS plugin target; there is no Cemu emulator target and no standalone ELF target in this project.
This repository contains only local game and user-interface functionality. The following proprietary or hosted-service features have been removed from the upstream codebase this project descends from:
- license activation and per-user product settings;
- vendor/hosted server communication and crash-report uploads;
- account/profile integration;
- forum, public-game, and friend-service integration;
- Lua scripting support;
- code obfuscation.
Minecraft's own in-game gameplay networking (multiplayer sessions between players) remains available, because it is part of the game itself, not an OpenDiamond hosted service.
This project also includes local, on-console low-level and debugging components derived from TCPGecko (src/tcpgecko), covering kernel syscalls, filesystem/string helpers, GX2 texture helpers, RPX/RPL memory-area support, and exception/breakpoint/debug support. This is distinct from the removed vendor/hosted-service communication above: these are local, in-process helpers, not a network listener or hosted TCPGecko server.
OpenDiamond is authored and led by Katope (project/plugin author, Lead Developer / UI Designer). The in-plugin About/settings screen (OpenDSettingsCategory::DrawAboutSettings()) also credits:
- Katope — Lead Developer / UI Designer
- kaoru767 — Developer
- BeeSoup / Zora — Developer
- A devkitPro environment with
devkitPPC, WUT, and WiiUPluginSystem installed, or - Docker, for the reproducible container build described below.
docker build -t opendiamond-builder .
docker run --rm -v "${PWD}:/project" -w /project opendiamond-builder make -j2With DEVKITPRO (and DEVKITPPC) set in your environment and WUT and WiiUPluginSystem installed:
makeBoth paths produce the plugin at:
wups/OpenDiamond.wps
Copy wups/OpenDiamond.wps into the WUPS plugin directory used by your Aroma/WUPS environment (typically a wiiu/environments/<environment>/plugins path on the console's SD card). Consult your WUPS/Aroma environment's own documentation for the exact path, as this varies by setup and this project does not install or manage it for you.
The repository does not include a private SDK, embedded credentials, or a bundled devkitPro installation.
OpenDiamond's own source code is licensed under GPL-3.0-only. It builds on top of the following third-party components, each of which remains under its own license:
| Library | Purpose | License / notice |
|---|---|---|
| WiiUPluginSystem (WUPS) | Plugin loader/API this project targets | LGPL-3.0 |
| wut | Wii U homebrew toolchain headers/runtime | zlib-style license |
OpenDiamond mc header library (src/libs/mc) |
Project-local Minecraft: Wii U Edition ABI declarations and helpers | See OPEND_VENDOR.md and THIRD_PARTY_NOTICES.md for provenance and redistribution notes |
GHUI (src/opend/ui/ghui) |
Project UI toolkit (an ImGui-derived fork) | Notices retained in source; not independently re-verified here |
Boost.Preprocessor (src/boost) |
Preprocessor metaprogramming utilities | Boost Software License 1.0 |
nlohmann/json (src/libs/json.hpp) |
JSON parsing | MIT |
toml++ (src/libs/toml.hpp, src/libs/toml) |
TOML parsing | MIT |
zstd (src/libs/zstd) |
Compression | BSD-style / GPLv2 dual license, per included headers |
| stb_image / stb_image_write | Image loading/writing | Dual MIT / public domain |
TinyXML-2 (src/libs/tinyxml2.*) |
XML parsing | zlib license |
| opengametools ogt_vox | Voxel (.vox) file reading/writing |
MIT |
BS::thread_pool (src/libs/thread_pool.hpp) |
Thread pool | MIT |
Hash implementations (src/libs/hash_lib) |
Various hash algorithms | Mixed; see individual file headers for each algorithm's notice |
TCPGecko-derived components (src/tcpgecko) |
Local kernel syscalls, filesystem/string helpers, GX2 texture helpers, RPX/RPL memory-area support, and exception/breakpoint/debug support | See individual file headers for provenance; not a network listener or hosted TCPGecko server in this project |
See THIRD_PARTY_NOTICES.md for the current redistribution-review inventory, including items that require verification before publishing binary releases.
OpenDiamond project code is licensed under the GNU General Public License, version 3 only (GPL-3.0-only). See LICENSE.
Third-party components listed above remain under their own licenses; the project-level GPL does not replace them. Review the relevant license files before redistribution.
OpenDiamond is not affiliated with, endorsed by, or sponsored by Mojang, Microsoft, or Nintendo. This repository does not include Minecraft game binaries, proprietary console SDK components, or any credentials. You are responsible for ensuring you have the right to use any game binaries, symbols, or platform SDK components required by your own local build.