Repositories¶
OpenPak is not a monorepo. Every service is its own repository under github.com/openpak, with its own README, changelog, tests, image and releases. A change that spans services is one pull request per repository.
Note
During the alpha some repositories are still private. They are opened as they get ready; if a link here returns a 404, that repository is not public yet.
Finding a repository by topic¶
Every repository is tagged with GitHub topics, by platform and by kind.
Platform:
switch ·
wiiu ·
3ds ·
wii ·
ds ·
xbox ·
xbox360 ·
ps3 ·
core (shared by every console) ·
multi-platform
Kind:
infra (network services) ·
game-server ·
client (what runs on the console or your phone) ·
emulator ·
tool ·
library ·
docs
Naming¶
Repository names say which family they belong to:
| Prefix | Family |
|---|---|
nx- |
Switch infrastructure |
nn- |
Wii U and 3DS infrastructure and clients, and the Wii/DS WFC server and patchers |
np- |
PlayStation 3 |
x360- |
Xbox 360 |
xb- |
Original Xbox |
| no prefix | core services (account, website, saves, ...), shared game-server hosts (nex, npln, ...), clients (app, openpak-nro) and emulators |
New Xbox and Xbox 360 service names follow the names the console's own firmware uses.
Good places to start¶
| Repository | What it is |
|---|---|
account |
The account core. Knows nothing about consoles. |
website |
openpak.org, the account portal, the title catalogue and the mobile API. |
nx-baas |
The Switch adapter. |
nex |
The shared NEX/PRUDP game-server host for Wii U, 3DS and Switch titles. |
app |
The companion app for Android and iOS. |
openpak-nro |
OpenPak Setup for the Switch. |
harbor |
The Switch emulator. |
docs |
This site. |
Teams¶
Maintainers are organised in GitHub teams that match the families: core, switch, wiiu-3ds, wii-ds, ps3, xbox, xbox360, clients and emulators, plus reviewer and maintainer teams. Pull requests are reviewed by the team that owns the repository.
Forks¶
Several repositories are forks of other projects: the Wii U, 3DS and Wii/DS services and clients build on Pretendo Network and WiiLink, and every emulator is a fork of an upstream emulator. Forks keep their upstream licence and credits. Report fork-specific problems to the OpenPak fork, and general problems upstream.
Releases and CI¶
Each repository's CI runs when a version tag (vX.Y.Z) is pushed, or when it is started by
hand, and builds and publishes that release. Ordinary pushes do not start a build, so run the
tests yourself before you open a pull request.