Documentation

VM Labs SDK Internal Release 0.86.2
June 14
, 2001


Available documents

The following documents are currently available for the VM Labs SDK. Click on the red link-ball to download or view the particular document in the format of your choice. Please note that only one or two document formats are supported for each document at this time.

Title

Summary

Ascii text

Acrobat

HTML

Help

Release Changes Changes made to this release.  
 
Installing the SDK
Initial Setup Tips for the initial setup of your SDK installation.    
setting environment varialbles and plugging things in
 

Installation Instructions

instructions for installing the SDK.

   


 
OS Support What OS platforms are supported?  
OS Support info
   
Firmware

Flash ROM Info

Perform brain surgery on your development system!





nuon-flash documentation

How to flash your development system with the nuon-flash program.    
 

Debug Stub Info

Brain transplants for your debug card.




Controller

Controller Handling Changes

Change info for the controller data structure.



Controller handling changes


Programming Guides

The Hitchhikers Guide to NUON

General introduction to NUON programming.





The NUON Application Programming Guide.

What a game programmer needs to know before working on a NUON project.





NUON Programming Tutorials

Teach yourself NUON programming in 24 hours or less!





Sample Code Overview Samples and examples of NUON programming.    
Index of the code samples
 

Merlin Troubleshooting Guide

What to do till the doctor comes; first aid for hardware and software problems.





Running on MPE 3 With the ROM-Based BIOS

What you need to do before running the ROM BIOS



Converting to MPE3


Compiler, Assembler, and related information

C/C++ Compiler Changes

Change history for mgcc.




Using and Porting GNU CC

Compiler Manual.




LLAMA: An Optimizing Assembler for NUON

Assember user's manual





Makefile Fragments Details of the makefile fragments.  
Makefile Fragments
   

GNU Make

Manual for gmake.




GNU profiler Manual for gprof.  
Third party tools, plugins, libraries, and so on.
   
mtrace debug utility How to use the mtrace debug utility.  
mtrace
   

vmdump - coff file display and convertion

vmdump is an ad hoc tool for generating certain views of a coff file.


vmdump.pdf



Debugger

api.txt

X-lisp interface to the Puffin debugger


api.pdf



Puffin5: User Guide and Reference Manual

Manual for the new Puffin5 debugger.  
api.pdf
   

Puffin: A Debugger For NUON

Manual for command line based Puffin debugger.





Puffin2K User Manual

Manual for GUI based Puffin debugger.





puffin-api.txt

XLisp interface to the Puffin debugger.


puffin-api.pdf



puffin-colori.txt

 

puffin-colori.pdf

 

 

Easy XLISP/TK API Manual

GUI extensions to the Puffin Debugger's built-in XLisp scripting language.





XLISP An Object Oriented Lisp

Manual for XLISP (Puffin's scripting language).





XLisp Tutorial

An Introduction For C Programmers





Include Files

Include File Updates

changes to the SDK include files.


 



Libraries

Library Updates

changes to the SDK libraries.





NUON SDK Library Overview

Overview of the libraries bundled with the NUON SDK.



Library Overview


IMPULSE Portable Graphics Engine Impulse library documentation.  

 

 
IMPULSE library: AlphaMask Effects Classes Class description for Impulse library AlphaMask.  
 

M3DL

NUON 2D & 3D graphics library





Merlin 3D Library functions.

Programmer's manual for MML3D library.





mGL 3D Graphics Library

API manual for mGL 3D graphics.


libmgl.pdf



mGL Release Notes What's new with mGL? A lot!
mgl release notes
mgl release notes
   

MML2D Graphics Library

API manual for 2D graphics





NUON Audio Library Functions    
   

NUON BIOS Documentation

Bios





NUON Miscellaneous Utility Functions






The Independent JPEG Groups JPEG software README

README doc for libjpeg.a





Configuring the Dev System
Configuring Dev System Memory How to configure your development system to 8MB of RAM.    
DevRAMInfo.html
 
Joystick Info How to make your system work with the new style joysticks.    
Joystick info
 

RELEASE NOTES FOR THE OZ->ARIES TRANSITION

For those developers who are making the transition from a development system with the OZ chip revision to a system with the new ARIES revision.


OzToAries.pdf



Authentication
Authentication Very high-level information about application authentication.    
Information about authentication and blessing.
 
authinfo How to use the authinfo utility.    
Information about authentication and blessing.
 
Bundled Programs
Third Party Apps Tools and plugins not part of the core SDK.    
Third party tools, plugins, libraries, and so on.
 
Other Programs
vmcrlf How to use vmcrlf, a text file converter to MS-DOS and/or Unix end-of-line conventions.    
Third party tools, plugins, libraries, and so on.
 
General Information

Changing "Merlin" to "NUON"

The naming of things.



renaming Merlin to NUON


Document formats

Each document is provided in one of more of the following formats.

Note that effective with this release of the SDK, MS Word format is no longer used for documentation.

Viewing the Documents.

HTML documents are kept simple and may be viewed with the web browser of your choice.

Ascii text documents are intended to be readable on both Windows and Linux environments.

Adobe Acrobat documents require Acrobat Reader 4.0 from Adobe. You can get this in one of two ways:

Or

Note: Internet Explorer may have a problem displaying PDF files over the web server. A workaround is to disable to the Adobe Acrobat plug-in by doing the following:

  1. Exit from Internet Explorer.
  2. Start the Acrobat 4.0x viewer.
  3. Choose File > Preferences > General.
  4. Deselect Web Browser Integration in the Options section and then click OK.
  5. Exit from the Acrobat 4.0x viewer.
  6. Restart Internet Explorer. The next time you select a link to a PDF file in Internet Explorer, a dialog box will prompt you to specify what to do with the file. If you select "Open this file from its current location," Internet Explorer opens the PDF file in the Acrobat viewer as a helper appliction. If you select "Save this file to disk," Internet Explorer saves the PDF file to your hard disk, from where you can open it later.

 


Please email comments or questions to SDK-Release@vmlabs.com

This page © Copyright 2001 VM Labs, Inc. Mountain View, CA. All rights reserved.