From 65d12cdef6565e3e755ea44de1790d30da6ef24f Mon Sep 17 00:00:00 2001 From: Christophe Asselin Date: Wed, 26 Jun 2024 18:07:10 -0400 Subject: [PATCH 01/11] chore: create organization profile readme Create a simpler and updated README for the Pretendo Network organization profile README. Replace contents of existing README to explain the purpose of the repository. --- README.md | 41 ++--------------------------------------- profile/README.md | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 39 deletions(-) create mode 100644 profile/README.md diff --git a/README.md b/README.md index ec103bf..31525c7 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,3 @@ -![Banner](https://user-images.githubusercontent.com/49426949/180600012-1fa623f7-98e9-4d84-83bb-d5c99d68224d.png) +# Pretendo Network -# Pretendo - -Pretendo is an open source Nintendo Network replacement that aims to build custom servers for the WiiU and 3DS family of consoles. - -## Contributing - -Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for contributing to the project. - -## Goals/Roadmap - -Pretendo is a large project with many smaller sections, each with their own goals. To find the goals and roadmap for a specific section of the network, check its repo. - -# Service repositories: -- NEX framework [https://github.com/PretendoNetwork/nex-go](https://github.com/PretendoNetwork/nex-go) -- Account server [https://github.com/PretendoNetwork/account](https://github.com/PretendoNetwork/account) -- eShop (PoC) [https://github.com/PretendoNetwork/eShop](https://github.com/PretendoNetwork/eShop) - -# Non-service repositories: -- Official Discord bot [https://github.com/PretendoNetwork/Bandwidth](https://github.com/PretendoNetwork/Bandwidth) -- Official proxy [https://github.com/PretendoNetwork/maryo](https://github.com/PretendoNetwork/maryo) - -## License - -This project is licensed under the Mozilla Public License 2.0 License - see the [LICENSE](LICENSE) file for details - -## Acknowledgments - -* PRUDP/NEX was originally designed and developed by [Quazal](https://en.wikipedia.org/wiki/List_of_Ubisoft_subsidiaries#Quazal) -* Huge thanks to [Kinnay](https://github.com/Kinnay) as without his reverse engineering work and documentation of PRUDP and NEX, we doubt Pretendo would be anywhere today. - -Our full list of acknowledgements are visible on [our website](https://pretendo.network/#credits) - -**Come join our discord server!** -

- - - -

+This special repository contains community files. \ No newline at end of file diff --git a/profile/README.md b/profile/README.md new file mode 100644 index 0000000..a3f6dd0 --- /dev/null +++ b/profile/README.md @@ -0,0 +1,16 @@ +# About Pretendo Network +Pretendo is an open source Nintendo Network replacement that aims to build custom servers for the Wii U and 3DS family of consoles. Our goal is to preserve the online functionality of these consoles, to allow players to continue to play their favorite Wii U and 3DS games to their fullest capacity. + +Visit [our website](https://prentendo.network) for more information on the project. + +## Official Links + +* [Website](https://prentendo.network) +* [Discord](https://discord.gg/pretendo) +* [Forum](https://forum.pretendo.network/) +* [X/Twitter](https://x.com/pretendonetwork) + + +## License + +This project is licensed under the [GNU Affero General Public License version 3](../LICENSE) From 64fe542ec93253097d18972a7cfc5bba82c76798 Mon Sep 17 00:00:00 2001 From: Christophe Asselin Date: Thu, 27 Jun 2024 19:36:07 -0400 Subject: [PATCH 02/11] chore: add relevent links to readmes Added main links to root README. Added link to contribution guide in profile README. Minor rewording in profile README. --- README.md | 9 ++++++++- profile/README.md | 6 ++++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 31525c7..94e7122 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ # Pretendo Network -This special repository contains community files. \ No newline at end of file +This special repository contains community files and common templates. + +## Contents + +* [License](LICENSE) +* [Security Policy](.github/SECURITY.md) +* [Code of Conduct](.github/CODE_OF_CONDUCT.md) +* [Contribution Guide](.github/CONTRIBUTING.md) diff --git a/profile/README.md b/profile/README.md index a3f6dd0..ab3262f 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,14 +1,16 @@ # About Pretendo Network Pretendo is an open source Nintendo Network replacement that aims to build custom servers for the Wii U and 3DS family of consoles. Our goal is to preserve the online functionality of these consoles, to allow players to continue to play their favorite Wii U and 3DS games to their fullest capacity. -Visit [our website](https://prentendo.network) for more information on the project. +For more information on the project such as current goals, project status and other news, visit [our website](https://prentendo.network). + +As a fully open-source project, Prentendo welcomes contributions made by the community. If you are interested in contributing, please refer to the [contribution guide](../.github/CONTRIBUTING.md). ## Official Links * [Website](https://prentendo.network) * [Discord](https://discord.gg/pretendo) * [Forum](https://forum.pretendo.network/) -* [X/Twitter](https://x.com/pretendonetwork) +* [Twitter](https://twitter.com/pretendonetwork) ## License From 646e4d2bae94f2a99841193a09a5954662e2d23a Mon Sep 17 00:00:00 2001 From: soulpower11 <5299979+soulpower11@users.noreply.github.com> Date: Wed, 3 Jul 2024 10:51:25 +0800 Subject: [PATCH 03/11] Fix spelling mistake --- profile/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/profile/README.md b/profile/README.md index ab3262f..21ce288 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,13 +1,13 @@ # About Pretendo Network Pretendo is an open source Nintendo Network replacement that aims to build custom servers for the Wii U and 3DS family of consoles. Our goal is to preserve the online functionality of these consoles, to allow players to continue to play their favorite Wii U and 3DS games to their fullest capacity. -For more information on the project such as current goals, project status and other news, visit [our website](https://prentendo.network). +For more information on the project such as current goals, project status and other news, visit [our website](https://pretendo.network). As a fully open-source project, Prentendo welcomes contributions made by the community. If you are interested in contributing, please refer to the [contribution guide](../.github/CONTRIBUTING.md). ## Official Links -* [Website](https://prentendo.network) +* [Website](https://pretendo.network) * [Discord](https://discord.gg/pretendo) * [Forum](https://forum.pretendo.network/) * [Twitter](https://twitter.com/pretendonetwork) From bf61dce9312d83cbeed89db89ecf374dfd77bc07 Mon Sep 17 00:00:00 2001 From: soulpower11 <5299979+soulpower11@users.noreply.github.com> Date: Thu, 4 Jul 2024 00:20:44 +0800 Subject: [PATCH 04/11] Update profile/README.md Co-authored-by: Jonathan Barrow --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index 21ce288..8c89dfd 100644 --- a/profile/README.md +++ b/profile/README.md @@ -3,7 +3,7 @@ Pretendo is an open source Nintendo Network replacement that aims to build custo For more information on the project such as current goals, project status and other news, visit [our website](https://pretendo.network). -As a fully open-source project, Prentendo welcomes contributions made by the community. If you are interested in contributing, please refer to the [contribution guide](../.github/CONTRIBUTING.md). +As a fully open-source project, Pretendo welcomes contributions made by the community. If you are interested in contributing, please refer to the [contribution guide](../.github/CONTRIBUTING.md). ## Official Links From e8b4588205d8675e4a7b3421095dc53ed09e83d7 Mon Sep 17 00:00:00 2001 From: Jonathan Barrow Date: Wed, 5 Feb 2025 12:11:52 -0500 Subject: [PATCH 05/11] chore: add missing warning to prerequisites section of the contribution guide --- .github/CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 53b4dfb..23aeafd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -17,6 +17,9 @@ Thank you for showing interest in contributing to Pretendo Network! As an open s - [Licensing](#licensing) # Prerequisites +> [!CAUTION] +> You may only contribute to Pretendo Network if you are legally able to do so. Being a part of the Nintendo Developer program, being under any other related NDA, having access to any related SDKs legally obtained or not, etc. prohibits you from contributing to Pretendo Network. If it is discovered that you are a part of these programs, are under any related NDA, have access to any related SDKs legally obtained or not, etc. you will immediately be blocked from the organization, even if you never use any information in contributions or don't even use the mentioned tools. + Before diving into the contribution process, we recommend familiarizing yourself with our project's existing repositories. By studying our existing codebases, issues, and pull requests you will get a better sense of direction of how we operate. Additionally, please review our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a respectful and inclusive environment for all participants. Given that our project's main goal is to emulate Nintendo Network, it is also highly recommended that you familiarize yourself with how these services operate. Information on these topics, and our libraries, can be found both on our [wiki](https://nintendo-wiki.pretendo.network/docs/) and our (in progress) [developer documentation](https://developer.pretendo.network/home). From 9d1917e623538c05e70749d78eda832f348d4e8a Mon Sep 17 00:00:00 2001 From: Jonathan Barrow Date: Wed, 5 Feb 2025 14:04:16 -0500 Subject: [PATCH 06/11] chore: reword contribution warning Co-authored-by: William Oldham --- .github/CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 23aeafd..612ae57 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -18,8 +18,13 @@ Thank you for showing interest in contributing to Pretendo Network! As an open s # Prerequisites > [!CAUTION] -> You may only contribute to Pretendo Network if you are legally able to do so. Being a part of the Nintendo Developer program, being under any other related NDA, having access to any related SDKs legally obtained or not, etc. prohibits you from contributing to Pretendo Network. If it is discovered that you are a part of these programs, are under any related NDA, have access to any related SDKs legally obtained or not, etc. you will immediately be blocked from the organization, even if you never use any information in contributions or don't even use the mentioned tools. - +> By contributing to this project, you agree to the following: +> +> 1. **Developer Certificate of Origin** – All contributions must comply with the [Developer Certificate of Origin](https://developercertificate.org/). +> 2. **Ownership & Rights** – You may only contribute content you own. Do not submit anything that is: +> - Owned by someone else (unless properly licensed for this project). +> - A trade secret, under NDA, or otherwise confidential. +> 3. **Respect for Nintendo’s IP** – We strictly avoid infringing on Nintendo’s intellectual property. If you have had access to Nintendo’s proprietary materials (legally or otherwise), we may take steps to ensure compliance, including blocking contributions or removing existing ones. Before diving into the contribution process, we recommend familiarizing yourself with our project's existing repositories. By studying our existing codebases, issues, and pull requests you will get a better sense of direction of how we operate. Additionally, please review our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a respectful and inclusive environment for all participants. Given that our project's main goal is to emulate Nintendo Network, it is also highly recommended that you familiarize yourself with how these services operate. Information on these topics, and our libraries, can be found both on our [wiki](https://nintendo-wiki.pretendo.network/docs/) and our (in progress) [developer documentation](https://developer.pretendo.network/home). From 51b4d3dfb3b36fac019a7e797540dba90c61b9e5 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 20 May 2025 22:59:21 +0100 Subject: [PATCH 07/11] Add docker GitHub workflow template --- workflow-templates/docker.yml | 101 ++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 workflow-templates/docker.yml diff --git a/workflow-templates/docker.yml b/workflow-templates/docker.yml new file mode 100644 index 0000000..2691cb2 --- /dev/null +++ b/workflow-templates/docker.yml @@ -0,0 +1,101 @@ +name: Build and Publish Docker Image + +on: + push: + pull_request: + workflow_dispatch: + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + DEFAULT_BRANCH: ${{ format('refs/heads/{0}', github.event.repository.default_branch) }} + SHOULD_PUSH_IMAGE: ${{ (github.event_name == 'push' && (github.ref == format('refs/heads/{0}', github.event.repository.default_branch) || github.ref == 'refs/heads/dev')) || github.event_name == 'workflow_dispatch' }} + +jobs: + build-publish-amd64: + name: Build and Publish Docker Image (amd64) + runs-on: ubuntu-latest + + permissions: + contents: read + packages: write + + steps: + - name: Set up QEMU for Docker + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Log into the container registry + if: ${{ env.SHOULD_PUSH_IMAGE == 'true' }} + uses: docker/login-action@v3 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=raw,value=latest,enable=${{ github.ref == env.DEFAULT_BRANCH }} + type=raw,value=edge,enable=${{ github.ref == 'refs/heads/dev' }} + type=sha + + - name: Build and push Docker image + id: build-and-push + uses: docker/build-push-action@v6 + with: + platforms: linux/amd64 + push: ${{ env.SHOULD_PUSH_IMAGE }} + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + + build-publish-arm64: + name: Build and Publish Docker Image (arm64) + runs-on: ubuntu-24.04-arm + + permissions: + contents: read + packages: write + + steps: + - name: Set up QEMU for Docker + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Log into the container registry + if: ${{ env.SHOULD_PUSH_IMAGE == 'true' }} + uses: docker/login-action@v3 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + tags: | + type=raw,value=latest-arm,enable=${{ github.ref == env.DEFAULT_BRANCH }} + type=raw,value=edge-arm,enable=${{ github.ref == 'refs/heads/dev' }} + type=sha,suffix=-arm + + - name: Build and push Docker image + id: build-and-push + uses: docker/build-push-action@v6 + with: + platforms: linux/arm64 + push: ${{ env.SHOULD_PUSH_IMAGE }} + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max From f3c735ddee8f7bdf4f295fd52bf0751a7fb193df Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 20 May 2025 23:02:05 +0100 Subject: [PATCH 08/11] Create workflow template properties file --- workflow-templates/docker.properties.json | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 workflow-templates/docker.properties.json diff --git a/workflow-templates/docker.properties.json b/workflow-templates/docker.properties.json new file mode 100644 index 0000000..ab110c4 --- /dev/null +++ b/workflow-templates/docker.properties.json @@ -0,0 +1,11 @@ +{ + "name": "Docker Build Workflow", + "description": "Workflow to build an AMD64 and ARM64 Docker build on push and PR", + "iconName": "package", + "categories": [ + "Docker" + ], + "filePatterns": [ + "^Dockerfile" + ] +} From fd7641e241bfa7560994937199dfd89ac6442b9e Mon Sep 17 00:00:00 2001 From: William Oldham Date: Tue, 20 May 2025 23:02:42 +0100 Subject: [PATCH 09/11] Use correct icon pattern --- workflow-templates/docker.properties.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/workflow-templates/docker.properties.json b/workflow-templates/docker.properties.json index ab110c4..fc7aeb6 100644 --- a/workflow-templates/docker.properties.json +++ b/workflow-templates/docker.properties.json @@ -1,7 +1,7 @@ { "name": "Docker Build Workflow", "description": "Workflow to build an AMD64 and ARM64 Docker build on push and PR", - "iconName": "package", + "iconName": "octicon package", "categories": [ "Docker" ], From 7181faff0be6ad3ab986fb389e295b97e981b842 Mon Sep 17 00:00:00 2001 From: William Oldham Date: Mon, 25 Aug 2025 18:42:21 +0100 Subject: [PATCH 10/11] Fix formatting in CONTRIBUTING.md --- .github/CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 612ae57..4066242 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,7 +24,8 @@ Thank you for showing interest in contributing to Pretendo Network! As an open s > 2. **Ownership & Rights** – You may only contribute content you own. Do not submit anything that is: > - Owned by someone else (unless properly licensed for this project). > - A trade secret, under NDA, or otherwise confidential. -> 3. **Respect for Nintendo’s IP** – We strictly avoid infringing on Nintendo’s intellectual property. If you have had access to Nintendo’s proprietary materials (legally or otherwise), we may take steps to ensure compliance, including blocking contributions or removing existing ones. +> 3. **Respect for Nintendo’s IP** – We strictly avoid infringing on Nintendo’s intellectual property. If you have had access to Nintendo’s proprietary materials (legally or otherwise), we may take steps to ensure compliance, including blocking contributions or removing existing ones. + Before diving into the contribution process, we recommend familiarizing yourself with our project's existing repositories. By studying our existing codebases, issues, and pull requests you will get a better sense of direction of how we operate. Additionally, please review our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a respectful and inclusive environment for all participants. Given that our project's main goal is to emulate Nintendo Network, it is also highly recommended that you familiarize yourself with how these services operate. Information on these topics, and our libraries, can be found both on our [wiki](https://nintendo-wiki.pretendo.network/docs/) and our (in progress) [developer documentation](https://developer.pretendo.network/home). @@ -125,4 +126,4 @@ We ask that you have patience with us as we review your pull request. Pretendo N We do not require 100% code coverage in any tests. We do not currently have strict rules regarding tests, however we may ask that tests be provided for large or complex changes. # Licensing -Unless otherwise specified all code is licensed under [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0), including that of outside contributions. This license allows users many freedoms to use our code in their own applications, including private and commercial use, while ensuring that all derivatives remain under this same license and keeps the source available, even when used over a network. A repository's license may not be changed by outside contributors unless that change is done with good reason, has been approved by the core development team, and is done with the consent of all relevant contributors. \ No newline at end of file +Unless otherwise specified all code is licensed under [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0), including that of outside contributions. This license allows users many freedoms to use our code in their own applications, including private and commercial use, while ensuring that all derivatives remain under this same license and keeps the source available, even when used over a network. A repository's license may not be changed by outside contributors unless that change is done with good reason, has been approved by the core development team, and is done with the consent of all relevant contributors. From e89ff9101e3631f71556c392835327480eed085f Mon Sep 17 00:00:00 2001 From: kitten Date: Fri, 7 Aug 2026 05:25:49 +0200 Subject: [PATCH 11/11] fix for fj --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 94e7122..8c89dfd 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ -# Pretendo Network +# About Pretendo Network +Pretendo is an open source Nintendo Network replacement that aims to build custom servers for the Wii U and 3DS family of consoles. Our goal is to preserve the online functionality of these consoles, to allow players to continue to play their favorite Wii U and 3DS games to their fullest capacity. -This special repository contains community files and common templates. +For more information on the project such as current goals, project status and other news, visit [our website](https://pretendo.network). -## Contents +As a fully open-source project, Pretendo welcomes contributions made by the community. If you are interested in contributing, please refer to the [contribution guide](../.github/CONTRIBUTING.md). -* [License](LICENSE) -* [Security Policy](.github/SECURITY.md) -* [Code of Conduct](.github/CODE_OF_CONDUCT.md) -* [Contribution Guide](.github/CONTRIBUTING.md) +## Official Links + +* [Website](https://pretendo.network) +* [Discord](https://discord.gg/pretendo) +* [Forum](https://forum.pretendo.network/) +* [Twitter](https://twitter.com/pretendonetwork) + + +## License + +This project is licensed under the [GNU Affero General Public License version 3](../LICENSE)