mirror of
https://github.com/MatthewL246/pretendo-docker.git
synced 2026-05-02 11:37:41 -05:00
55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
# Unofficial Pretendo Network server in Docker
|
|
|
|
This is an unofficial Docker Compose setup for self-hosting a Pretendo Network server (because there is no official
|
|
self-hosting setup).
|
|
|
|
[](https://github.com/MatthewL246/pretendo-docker/actions/workflows/test.yml)
|
|
|
|
## Supported consoles
|
|
|
|
| Console | Testing status |
|
|
| -------------- | ---------------- |
|
|
| Wii U | ✅ Working |
|
|
| Cemu emulator | ✅ Working |
|
|
| 3DS | ✅ Working |
|
|
| Citra emulator | ⏱️ Coming soon |
|
|
| Wii/DS/Switch | ⛔ Unsupported\* |
|
|
|
|
_\*The Pretendo Network servers only support the Wii U and 3DS consoles. Support for other consoles is not planned._
|
|
|
|
## Features
|
|
|
|
- Easily set up and run a Pretendo Network server on your own hardware!
|
|
- Everything runs in Docker containers and avoids making changes to your host system.
|
|
- Regular updates to support the latest development versions of the servers.
|
|
- Source code of the Pretendo servers is
|
|
[automatically updated daily by Dependabot](https://github.com/MatthewL246/pretendo-docker/pulls?q=is:pr+author:app/dependabot).
|
|
- Supports Wii U and 3DS consoles and emulators with detailed documentation for each.
|
|
- Includes server and database administration tools, with easy access through web interfaces.
|
|
- Useful scripts for managing the servers.
|
|
|
|
## Getting started
|
|
|
|
**Please visit [the documentation website](https://matthewl246.github.io/pretendo-docker) for detailed setup and usage
|
|
instructions.**
|
|
|
|
## Future plans
|
|
|
|
Check the [General Roadmap and Plans issue](https://github.com/MatthewL246/pretendo-docker/issues/50) for more
|
|
information on my plans for this project.
|
|
|
|
## Learn more
|
|
|
|
- Read the [containers documentation](https://matthewl246.github.io/pretendo-docker/containers-list) to learn about the
|
|
different components of this project.
|
|
- Read Pretendo's [Nintendo Wiki](https://nintendo-wiki.pretendo.network/docs/) for technical information about
|
|
Nintendo's protocols and their [Developer Documentation](https://developer.pretendo.network/home) for more information
|
|
about their libraries and implementations of those protocols.
|
|
- See the [Pretendo Network GitHub organization](https://github.com/PretendoNetwork) for all of the open-source servers'
|
|
source code.
|
|
- Visit the [Pretendo Network forum](https://forum.pretendo.network) (and specifically check out the
|
|
[Technical Discussion category](https://forum.pretendo.network/c/technical-discussion/5)) to ask questions about the
|
|
servers.
|
|
- Join the [Pretendo Network Discord server](https://invite.gg/pretendo) (but please note: this is primarily a general
|
|
community server, not a place for technical development discussion).
|