Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e89ff9101e | |||
|
|
7181faff0b |
||
|
|
fd7641e241 |
||
|
|
f3c735ddee |
||
|
|
51b4d3dfb3 |
||
|
|
e12a517fa2 |
||
|
9d1917e623 |
|||
|
e8b4588205 |
|||
|
909cafb193 |
|||
|
|
bf61dce931 |
||
|
|
646e4d2bae |
||
|
d7051c094e |
|||
|
|
64fe542ec9 | ||
|
|
65d12cdef6 | ||
|
f3bebe5e95 |
5 changed files with 150 additions and 33 deletions
11
.github/CONTRIBUTING.md
vendored
11
.github/CONTRIBUTING.md
vendored
|
|
@ -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 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).
|
||||
|
|
@ -117,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.
|
||||
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.
|
||||
|
|
|
|||
42
README.md
42
README.md
|
|
@ -1,40 +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.
|
||||
|
||||
# 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
18
profile/README.md
Normal 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)
|
||||
11
workflow-templates/docker.properties.json
Normal file
11
workflow-templates/docker.properties.json
Normal 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"
|
||||
]
|
||||
}
|
||||
101
workflow-templates/docker.yml
Normal file
101
workflow-templates/docker.yml
Normal 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
|
||||
Loading…
Reference in a new issue