Readme-NAR-2_0_1-en.html

NARLib version 2.0.1

Contents

  1. Introduction
  2. Notes
  3. Copyrights and Other Legal Disclaimers
  4. System Requirements
  5. Operating Environment
  6. Installation Procedure
  7. Known Bugs
  8. Package Structure
  9. Related Documents
  10. Revision History

1. Introduction

This package provides a library for implementing augmented reality (AR) applications. Use this package to apply AR effects to images from the camera.

This package includes the Guide to Developing Applications That Use AR Cards. It contains notes for making your own AR cards and for using the AR cards bundled with the Nintendo 3DS system. Use it as a reference when developing AR applications that use AR cards.

Guide to Developing Applications That Use AR Cards (PDF)

Back to top

2. Notes

Use this package only in a Nintendo 3DS environment.

Back to top

3. Copyrights and Other Legal Disclaimers

This middleware does not require a copyright notice.

Back to top

4. System Requirements

The following development environment is required in order to use this package.

The following software is required in order to use the tools included in this package.

Back to top

5. Operating Environment

This package has been confirmed to run with the following versions of the development environment.

The tools included in this package have been confirmed to operate in the following environments.

Back to top

6. Installation Procedure

Package Location

Extract this package to any directory. We recommend that you place it in a directory whose path does not include spaces or double-byte characters. Once you have put the package in the chosen directory, run setup.wsf to set the CTRMW_NAR_ROOT environment variable to the absolute path of the package's root directory.

Installing the Tools

This package includes several tools for converting images. The tools do not require any special installation procedure. See the API Reference for details on how to use the tools.

Incorporating This Middleware Into Your Application

Link to the following header files and libraries to include this middleware in an application.

Header File
include/mw/nar/nar.h
Library
libraries/(platform)/(target)/libmw_nar.(option).a

Back to top

7. Known Bugs

None. For The latest information, including bugs that have been discovered since the last release, see the Technical Information section of the Developer Support website.

Back to top

8. Package Structure

The structure of this package is shown below.
Note: Not all of the files are listed here.

CTR_MW-NAR/
    |
    +- documents/
    |    |
    |    +- API/
    |    |    |
    |    |    +- index.html  ... API Reference.
    |    |
    |    +- Manual/
    |         |
    |         +- CTR_MW_NAR_ApplicationDevelopGuide.pdf ... Guide to Developing Applications That Use AR Cards
    |         +- CTR_MW_NAR_ProgrammingManual.pdf ... Programming Manual
    |
    +- include/
    |    |
    |    +- mw/
    |         |
    |         +- nar/
    |               |
    |               +- nar.h ... Header file
    |
    +- libraries/
    |    |
    |    +- (Platform)/
    |         |
    |         +- (target)/
    |              |
    |              +- libmw_nar.fast.a ... Library files
    |              +- libmw_nar.small.a
    |
    +- sampledemos/ ... Sample demos
    |    |
    |    + (stdapp)/ Standard Application Sample Demos
    |    |    |
    |    |    +- simple: The simplest sample, rendering a cube over the marker
    |    |    +- stereo: Sample using the stereo camera
    |    |    +- marker_maker: Sample that creates the marker pattern
    |    |    +- multi_marker: Sample that recognizes multiple markers
    |
    |    + (extapp)/ Enhanced Application Sample Demos
    |	
    +- tools/
    |    |
    |    +- ar_marker_maker: Tool that creates simple data necessary for detecting the marker from the image file
    |
    +- resources/
    |    |
    |    +- ARCard ... The PDF file for the AR cards bundled with the Nintendo 3DS system. Print this file to use it.
    |    |    +- ARCard01_hatena.pdf
    |    |    +- ARCard02_mario.pdf
    |    |    +- ARCard03_link.pdf
    |    |    +- ARCard04_kirby.pdf
    |    |    +- ARCard05_samus.pdf
    |    |    +- ARCard06_pikmin.pdf
    |    |
    |    +- Image … "?" card data that can be used to describe AR features
    |         +- CTRN_HAR_char01_C.psd
    |         +- CTRN_HAR_char01_R.psd
    |
    +- Readme-NAR-2_0_1-en.html ... Readme file
    +- setup.wsf ... Script file for configuring environment variables

Back to top

9. Related Documents

If you are considering developing an AR application that uses AR cards, see the following document first.
Guide to Developing Applications That Use AR Cards (PDF)

For more information about this middleware's specifications and how to use the tools, see the Programming Manual.
AR Library Programming Manual (PDF)

For more information about each function and to learn how to run the sample demos, see the API Reference.
CTR NARLib Documentation

resources/Image holds the "?" card data used for describing the AR feature. Use this data to display an accurate "?" card image when describing this feature. It is also fine to use simplified illustrations or the like to describe the feature.

Notes for use:

Back to top

10. Revision History

● Version 2.0.1 (2014/09/19)
● Version 2.0.0 (2014/05/16)
Back to top

CONFIDENTIAL