Compare commits

...
Author SHA1 Message Date
e89ff9101e fix for fj 2026-08-07 05:25:49 +02:00
William Oldham
7181faff0b
Fix formatting in CONTRIBUTING.md 2025-08-25 18:42:21 +01:00
William Oldham
fd7641e241
Use correct icon pattern 2025-05-20 23:02:42 +01:00
William Oldham
f3c735ddee
Create workflow template properties file 2025-05-20 23:02:05 +01:00
William Oldham
51b4d3dfb3
Add docker GitHub workflow template 2025-05-20 22:59:21 +01:00
mrjvs
e12a517fa2
Merge pull request #92 from PretendoNetwork/missing-warning
Add missing legal warning to `Prerequisites` section in the contribution guide
2025-05-07 10:25:35 +02:00
9d1917e623
chore: reword contribution warning
Co-authored-by: William Oldham <github@binaryoverload.co.uk>
2025-02-05 14:04:16 -05:00
e8b4588205
chore: add missing warning to prerequisites section of the contribution guide 2025-02-05 12:11:52 -05:00
909cafb193
Merge pull request #81 from soulpower11/soulpower11-patch-1 2024-07-04 17:28:57 -04:00
soulpower11
bf61dce931
Update profile/README.md
Co-authored-by: Jonathan Barrow <jonbarrow1998@gmail.com>
2024-07-04 00:20:44 +08:00
soulpower11
646e4d2bae
Fix spelling mistake 2024-07-03 10:51:25 +08:00
d7051c094e
Merge pull request #79 from christophe-asselin/master 2024-06-28 12:02:12 -04:00
Christophe Asselin
64fe542ec9 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.
2024-06-27 19:36:07 -04:00
Christophe Asselin
65d12cdef6 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.
2024-06-26 18:07:10 -04:00
f3bebe5e95
Merge pull request #74 from PretendoNetwork/pull-requests-update 2024-06-25 11:13:29 -04:00
5 changed files with 150 additions and 33 deletions

View file

@ -17,6 +17,15 @@ Thank you for showing interest in contributing to Pretendo Network! As an open s
- [Licensing](#licensing)
# Prerequisites
> [!CAUTION]
> 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 Nintendos IP** We strictly avoid infringing on Nintendos intellectual property. If you have had access to Nintendos 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).

View file

@ -1,40 +1,18 @@
![Banner](https://user-images.githubusercontent.com/49426949/180600012-1fa623f7-98e9-4d84-83bb-d5c99d68224d.png)
# 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.
# Pretendo
For more information on the project such as current goals, project status and other news, visit [our website](https://pretendo.network).
Pretendo is an open source Nintendo Network replacement that aims to build custom servers for the WiiU and 3DS family of consoles.
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).
## Contributing
## Official Links
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for contributing to the project.
* [Website](https://pretendo.network)
* [Discord](https://discord.gg/pretendo)
* [Forum](https://forum.pretendo.network/)
* [Twitter](https://twitter.com/pretendonetwork)
## 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!**
<p align="left">
<a href="https://invite.gg/pretendo" target="_blank">
<img src="https://discordapp.com/api/guilds/408718485913468928/widget.png?style=banner2">
</a>
</p>
This project is licensed under the [GNU Affero General Public License version 3](../LICENSE)

18
profile/README.md Normal file
View file

@ -0,0 +1,18 @@
# 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://pretendo.network).
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
* [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)

View file

@ -0,0 +1,11 @@
{
"name": "Docker Build Workflow",
"description": "Workflow to build an AMD64 and ARM64 Docker build on push and PR",
"iconName": "octicon package",
"categories": [
"Docker"
],
"filePatterns": [
"^Dockerfile"
]
}

View file

@ -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