Updated README and LICENSE. Added contribution guide and CoC
This commit is contained in:
parent
cebfce21b3
commit
ca758f7116
4 changed files with 545 additions and 678 deletions
36
README.md
36
README.md
|
|
@ -1,33 +1,35 @@
|
|||
# Pretendo
|
||||
|
||||
<p align="left">
|
||||
<a href="https://discord.gg/rxekqVJ" target="_blank">
|
||||
<img src="https://discordapp.com/api/guilds/408718485913468928/widget.png?style=banner3">
|
||||
<p align="center">
|
||||
<a href="https://discord.me/pretendo" target="_blank">
|
||||
<img src="https://discordapp.com/api/guilds/408718485913468928/widget.png?style=banner2">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
[](http://forthebadge.com)
|
||||
# Pretendo
|
||||
|
||||
## A close-as-possible server emulation project for the 3DS and WiiU
|
||||
Pretendo is an open source Nintendo Network replacement that aims to build custom servers for the WiiU and 3DS family of consoles.
|
||||
|
||||
## For detailed information, see the [wiki](https://github.com/PretendoNetwork/Pretendo/wiki)
|
||||
## 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 it's 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)
|
||||
- Friends service (WIP) [https://github.com/PretendoNetwork/Friends](https://github.com/PretendoNetwork/Friends)
|
||||
- Super Mario Maker (WIP) [https://github.com/PretendoNetwork/SuperMarioMaker](https://github.com/PretendoNetwork/SuperMarioMaker)
|
||||
- eShop (PoC) [https://github.com/PretendoNetwork/eShop](https://github.com/PretendoNetwork/eShop)
|
||||
|
||||
# Non-service repositories:
|
||||
- Official Discord bot [https://github.com/PretendoNetwork/Yamamura](https://github.com/PretendoNetwork/Yamamura)
|
||||
- Official proxy [https://github.com/PretendoNetwork/maryo](https://github.com/PretendoNetwork/maryo)
|
||||
|
||||
# What is this useful for?
|
||||
1. Preservation - The WiiU and the 3DS, just like every other console, have an EOL (End of Life.) There will be a point where Nintendo shuts the entirety of Nintendo Network that the WiiU and 3DS depend on for many features. One of the goals with this project is to keep Nintendo Network (NN) alive as Pretendo Network (PN), and to prepare for the EOL.
|
||||
2. Customization - With a custom server you have full control. Nintendo currently enforces certain things which may not be desirable to all (for example, requiring console-specific information to login and use services, as official accounts are tied to consoles). This could also become useful for tools like Cemu and Citra, as the Cemu currently supports online play but requires dumps of console-specific files to get online (as, again, official accounts are tied to consoles) and Citra wont connect to official NN servers out of fear of a DMCA. Custom servers could remove these barriers and allow anyone to go online with Cemu and Citra.
|
||||
## License
|
||||
|
||||
# Cool! How far along is it?
|
||||
Not far at all. Currently only NNID (PNID (Pretendo Network ID)) accounts work, and no games are currently supported
|
||||
This project is licensed under the Mozilla Public License 2.0 License - see the [LICENSE](LICENSE) file for details
|
||||
|
||||
# Supported games:
|
||||
- None yet
|
||||
## Acknowledgments
|
||||
|
||||
* PRUDP/NEX was originally designed and developed by [Quazal](http://www.quazal.com/index.html)
|
||||
* Huge thanks to [Kinnay](https://github.com/Kinnay) as without his reverse engineering work and documentation of PRUDP and NEX, I doubt Pretendo would be anywhere today.
|
||||
|
|
|
|||
Loading…
Reference in a new issue