Readme-NX_Pia.html

NX Pia 5.0.8

Contents

  1. Introduction
  2. Notes
  3. System Requirements
  4. Operating Environment
  5. Installation
  6. How to Use
  7. Building the Samples
  8. Known Bugs
  9. File List
  10. List of Attached Documents
  11. Revision History

1. Introduction

This package is NintendoSDK-Pia for NX 5.0.8, the game communication engine for the NX. It is called NX Pia throughout the rest of this document.

All modules in this package are the beta versions. Submitting master ROMs created using this package is prohibited.

The official version is planned to support only 64-bit builds. Contact Nintendo ahead of time if you plan to submit a master ROM as a 32-bit build.

Contact Nintendo ahead of time if you plan to implement voice chat using PiaChat with Internet or PiaInet communication.

Back to top

2. Notes

For more information about unsupported features, see the top page of each module in the Programming Manual.

Back to top

3. System Requirements

To use NX Pia, NintendoSDK must be installed. To conduct Internet communications, you must also install NX NEX. NX NEX will be released on a future date.

Back to top

4. Operating Environment

NintendoSDK NintendoSDK 0.15.1 NX Add-On 0.10.1
NX NEX NX NEX 4.0.0

The following table lists the maximum number of connected devices supported by each module.

session sync clone reckoning chat
Internet Matchmaking 4 4 4 4 2
Local Matchmaking 4 4 4 4 -
LAN Matchmaking 4 4 4 4 -

Back to top

5. Installation

Expand this package to a path that does not contain any multibyte characters or spaces. For the remainder of this document, this directory is referred to as NINTENDO_SDK_PIA_ROOT.

Back to top

6. How to Use

Set the directory path for this package as the environment variable NINTENDO_SDK_PIA_ROOT, and include the header files corresponding to the modules (nn\pia\common.h, nn\pia\inet.h, and so on). You do not need to set this environment variable if NINTENDO_SDK_ROOT has been set as an environment variable in NintendoSDK and the NintendoSDK, NX-NEX, and NX-Pia directories have been configured in parallel as follows.

If you plan to manually specify the include path and the libraries path, use the following paths.

If you will be using Pia from your own solution file, reference the NintendoSDK definitions as described in the NintendoSDK document Build System / Guide to Setting Up the Environment / Using NintendoSDK With an Existing Visual C++ Project.

Back to top

7. Building the Samples

To build sample demos, you must set the following environment variables.

NINTENDO_SDK_ROOT
The directory where NintendoSDK is installed.
NINTENDO_SDK_NEX_ROOT
The directory where NX NEX is installed.
Open and build using a version of Visual Studio that supports the solution file (SLN file) in the Project directory or the ProjectWithoutNex directory that has the various samples of $(NINTENDO_SDK_PIA_ROOT)\Samples. If you are using the ProjectWithoutNex directory, you do not need to install NX NEX.

Back to top

8. Known Bugs

For information about known bugs, see KnownIssue-NX_Pia.txt. For the latest information, including information about bugs identified after the release, see the Technical Information section of the Nintendo Developer Portal.

Back to top

9. File List

Build
Contains files for the Visual Studio build system.
Documents
Contains documents including the programming manual and the API reference.
Include
Contains the headers that can be included in applications.
Libraries
Contains the libraries that can be linked by applications.
Samples
Contains the samples.
Sources
Contains some Pia library source code for application developers to use for reference.
Tools
Contains various tools.

Back to top

10. List of Attached Documents

The following list includes the attached documents.

Programming Manual
Documents\index.html
API Reference
Documents\contents\PiaLibAPI\index.html

Back to top

11. Revision History

For the revision history, see Documents\ReleaseNotes\ChangeLog-NX_Pia.txt.

Back to top

CONFIDENTIAL