Readme-CTR_Pia-4_11_3-en.html

CTR Pia 4.11.3 for SDK 11.5.1

Contents

  1. Introduction
  2. Notes
  3. System Requirements
  4. Operating Environment
  5. Installation
  6. How to Use
  7. Building Samples
  8. Building Tests
  9. Notes About Applying on OMAS
  10. Known Bugs
  11. File List
  12. List of Documents in This Package
  13. Revision History

1. Introduction

This package is CTR Pia 4.11.3, the peer-to-peer communication library for CTR.
Master submission of ROMs created using the following features of this package is prohibited.
Consult with Nintendo in advance when you need to submit a master ROM using non-release versions of these features.
The following table shows the current support status for each module.

Module Name Feature Status
clone ReliableLargeCloneElement Beta

Back to top

2. Notes

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

Make sure that flag definitions, used when including header files for this library, conform to the flag settings for the build system included with the CTR-SDK.

Specifically, for release builds, you must not define NN_BUILD_VERBOSE, NN_BUILD_DEVELOPMENT, NN_BUILD_DEBUG, or NN_BUILD_NOOPT flags.
For development builds, you must not define NN_BUILD_RELEASE, NN_BUILD_DEBUG, or NN_BUILD_NOOPT flags.
For debug builds, you must not define NN_BUILD_RELEASE or NN_BUILD_DEVELOPMENT flags.

For more information about flag definitions for each build, see the CTR-SDK build system. Applications may not run normally if they are built by using flag settings that differ from the build system included in the CTR-SDK.

Back to top

3. System Requirements

The CTR-SDK must be installed to use CTR Pia. CTR NEX must also be installed to use Internet communication. CTR NEX is not necessary if you are using local communication only.

Back to top

4. Operating Environment

CTR-SDK CTR-SDK 11.5.1
CTR NEX CTR NEX 3.10.1
Compiler ARM C/C++ Compiler, ARMCC 4.1 b1049 2012-10-26
Debugger [CTR] PARTNER-CTR Version 5.70 055 2016-04-06
[SNAKE] IS-CTR Software Package Version 3.81 2016-07-07

For more information about the confirmed operation status of the latest CTR-SDK and CTR NEX, see the Nintendo Developer Portal.

The following table lists the maximum number of connected devices supported by each module. The number in parentheses represents the maximum number of devices that can run, but it is not supported. We will consider increasing the number of supported devices if requested.

session sync clone reckoning chat
Internet Communication 12 8 12 12 12
Local Communications 8(12) 8 8(12) 8(12) -

Back to top

5. Installation

Expand this package in a directory with a name that includes neither spaces nor Japanese characters. To build sample demos, you must set the following environment variables.

CTRSDK_ROOT
The directory where CTR-SDK is installed.
CTRNEX_ROOT
The directory where CTR NEX is installed.
CTRPIA_ROOT
After expanding the package, double-click SetupCTR.wsf to run setup. The directory you run setup from is set as the CTRPIA_ROOT environment variable.

Back to top

6. How to Use

Set the following path as the include path, and include the header file that corresponds to the module you want to use (such as common.h, local.h, etc.).
$(CTRPIA_ROOT)\include\

Link the libraries in the following path according to the build target.
$(CTRPIA_ROOT)\libraries\

This package only includes the fast build of the library. P2P communication, where the CPU load can easily create a bottleneck, normally uses only the fast build. For this reason, and to fully verify the fast build, the small build is not included. If you need the small build, please contact Nintendo.

Back to top

7. Building Samples

Run omake in $(CTRPIA_ROOT)\sampledemos\.

Back to top

8. Building Tests

After building the samples, run omake in $(CTRPIA_ROOT)\tests\.

Back to top

9. Notes About Applying on OMAS

If you are developing an application that supports network services, you must apply on the Online Title Management System (OMAS). If you are using the Pia library, be sure to select Pia as the P2P library being used in the entry in the NEX Matchmaking section of the OMAS application.

Back to top

10. Known Bugs

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

11. File List

include\
Contains the header files that you can include in applications.
sources\
Contains Pia library source code that has been released for application developers to use for reference.
libraries\
Contains the library files that you can link to in applications.
sampledemos\
Contains the samples.
tests\
Contains the verification program. (Not a sample.)
documents\
Contains documents such as the Programming Manual and API Reference.
tools\
Contains various tools.

Back to top

12. List of Documents in This Package

The following list describes the documents included with this package.

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

Back to top

13. Revision History

For the revision history, see documents\ReleaseNotes\ChangeLog-CTR_Pia-4_11_3-en.txt.

Back to top