Skip to content

Added doc for console access. #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions articles/console_access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Console Access
description: How do I get access to console versions of MonoGame?
---

MonoGame is free to use on all consoles from the [public repository](https://github.dev/MonoGame/monogame), however, the source code to the extensions for each platform is private and only accessible to authorized developers for each platform (managed by the vendors). These extensions provide additional capabilities to enable MonoGame to perform better on those platforms and include integrations with the vendor's private APIs.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SimonDarksideJ

Can you remove "to perform better on those platforms"? That is just not true.

The purpose of this private code is strictly to make MonoGame work on those platforms. It is not performance enhancements.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually i'll rewrite this really quick and submit a new PR.


> [!NOTE]
> You can independently publish your MonoGame title to the respective consoles without these extensions, but you will have to code the integrations manually.

## Application process

The process for access to the private console repositories is as follows:

1. Apply to the vendor developer program (required for publishing).
2. Through the program, request access to the MonoGame console extensions.

> [!IMPORTANT]
> MonoGame cannot directly give anyone access to the private Console repositories without prior approval from the vendor due to NDA requirements set out by each vendor.

The instructions below will help you gain access to each platform.

## Nintendo Switch

![Nintendo Switch](images/nintendo_switch.png)

Your first step is to register as [Nintendo Developer](https://developer.nintendo.com/register) for Nintendo Switch.

Once you are in the program, you can go to the middleware page and fill out the [MonoGame - Nintendo Developer Athorization](https://developer.nintendo.com/group/development/getting-started/g1kr9vj6/middleware/monogame) form.

We will then contact you with further instructions.

## PlayStation 4, PlayStation 5

![PlayStation Partners](images/ps_partners.png)

To access PlayStation platforms you must register as a [PlayStation Partner](https://partners.playstation.net/).

Once you are registered, you can submit a request in the [PlayStation 4 forums](https://ps4.develop.playstation.net/forums/thread/49561/) and the [PlayStation 5 forums](https://game.develop.playstation.net/forums/thread/251629/).

We will process these requests to give you access and further instructions.

## Xbox One, Xbox Series X

![ID@Xbox](images/idatxbox.png)

To publish on Xbox, you must first be a member of the [ID@Xbox Program](https://developer.microsoft.com/en-US/games/publish/).

Once you are active in the program you can email `[email protected]` and copy the MonoGame`[email protected]`account requesting Xbox Developer verification for access to MonoGame for Xbox.

Once Microsoft approves your development status we will respond with further instructions.

## Questions

If you have any further questions feel free to contact us at `[email protected]`.
Binary file added articles/images/idatxbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added articles/images/nintendo_switch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added articles/images/ps_partners.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@
href: samples.md
- name: Community Tutorials
href: tutorials.md
- name: Console Access
href: console_access.md
- name: Help and Support
href: help_and_support.md
- name: Contributing to documentation
Expand Down