Open main menu

Difference between revisions of "AGI/Specifications/Introduction"

m
wikid some of the markup
m (changed two anchor ids)
m (wikid some of the markup)
Line 22: Line 22:
==Conventions used in this document==
==Conventions used in this document==


    * Keyboard key names are given in fixed with font (e.g. ENTER).
* Keyboard key names are given in fixed with font (e.g. ENTER).
    * Metasyntatic variables are given in italics (e.g. n).
* Metasyntatic variables are given in italics (e.g. n).
    * File names are case sensitive and given in fixed width font (e.g. sierra.com).
* File names are case sensitive and given in fixed width font (e.g. sierra.com).
    * AGI resource names are given in all caps (e.g. LOGIC, VIEW).
* AGI resource names are given in all caps (e.g. LOGIC, VIEW).
    * AGI command names are given in fixed width font (e.g. print.at).
* AGI command names are given in fixed width font (e.g. print.at).
    * AGI variable n is noted as vn or Var(n) (e.g. v15, Var(18)).
* AGI variable n is noted as vn or Var(n) (e.g. v15, Var(18)).
    * AGI flag n is noted as fn or Flag(n) (e.g. f2, Flag(11)).
* AGI flag n is noted as fn or Flag(n) (e.g. f2, Flag(11)).


<span id="WhatsStillMissing"></span>
<span id="WhatsStillMissing"></span>
Line 35: Line 35:
Although this document has many details about the AGI specs, a few pieces of information are still missing:
Although this document has many details about the AGI specs, a few pieces of information are still missing:


    * Savegame file format
* Savegame file format
    * Some chunks of the memory organization
* Some chunks of the memory organization
    * Unknown view table entries
* Unknown view table entries
    * Unknown fields in the IIgs sound header
* Unknown fields in the IIgs sound header
    * The release date of many AGI games
* The release date of many AGI games
    * The purpose of commands 171, 172 and 174
* The purpose of commands 171, 172 and 174
    * The meaning of bit 0 in the argument byte
* The meaning of bit 0 in the argument byte
    * The meaning of bytes 0--1 in the VIEW resource header
* The meaning of bytes 0--1 in the VIEW resource header
    * Canonical names of commands 170--181
* Canonical names of commands 170--181
    * Canonical variable and flag names
* Canonical variable and flag names
    * More information about differences of AGI in other platforms (Amiga, Apple II, CoCo, etc)
* More information about differences of AGI in other platforms (Amiga, Apple II, CoCo, etc)
    * Any information about Donald Duck's Playground
* Any information about Donald Duck's Playground


<span id="ChangeLog"></span>
<span id="ChangeLog"></span>
Line 52: Line 52:
===Version 3.0 (22 May 1999)===
===Version 3.0 (22 May 1999)===


    * Documentation converted to SGML, to allow easy conversion to other formats such as HTML, LaTeX, GNU info or plain text.
* Documentation converted to SGML, to allow easy conversion to other formats such as HTML, LaTeX, GNU info or plain text.
    * Typos fixed.
* Typos fixed.
    * Removed redundant pieces of information.
* Removed redundant pieces of information.
    * Re-organized and re-ordered sections; added credits, audience and notation subsections.
* Re-organized and re-ordered sections; added credits, audience and notation subsections.
    * Adopted uniform notation (all code examples and function names in fixed width font, hexadecimal numbers, characters and strings in C format, case sensitive file names)
* Adopted uniform notation (all code examples and function names in fixed width font, hexadecimal numbers, characters and strings in C format, case sensitive file names)
    * ``Version control'' section renamed ``AGI interpreter versions''.
* "Version control" section renamed "AGI interpreter versions".
    * Removed sort-by-date and interpreter version cross-reference from ``AGI interpreter versions''.
* Removed sort-by-date and interpreter version cross-reference from "AGI interpreter versions".
    * Added cross-references in the LOGIC commands description.
* Added cross-references in the LOGIC commands description.
    * Added unknown170--unknown181 command descriptions written by Dark Minister.
* Added unknown170--unknown181 command descriptions written by Dark Minister.
    * Added IIgs SOUND resource format
* Added IIgs SOUND resource format
    * Added some bits of information to addn, step.size and other commands.
* Added some bits of information to addn, step.size and other commands.


===Version 2.0 (11 July 1998)===
===Version 2.0 (11 July 1998)===


    * Date corrected in section ``Game IDs''.
* Date corrected in section "Game IDs".
    * Added a note on the main page explaining what AGI specs is for. Hopefully this will reduce the confusion that some people have been having when using this to learn the logic programming language.
* Added a note on the main page explaining what AGI specs is for. Hopefully this will reduce the confusion that some people have been having when using this to learn the logic programming language.


====3 March 1998====
====3 March 1998====


    * Updated section ``Game IDs'' with some more info about game IDs and interpreter encryption.
* Updated section "Game IDs" with some more info about game IDs and interpreter encryption.
    * Corrected put and put.v commands in section Command list (the second argument of put and the first argument of put.v are supposed to be a vars).
* Corrected put and put.v commands in section Command list (the second argument of put and the first argument of put.v are supposed to be a vars).


====27 January 1998====
====27 January 1998====


    * Removed sections 4.2 (logic structure), 3.4 (dir/vol file format), 6.2 (view format), 8.2 (OBJECT format) and 8.3 (WORDS.TOK format). These were sections from the AGDS documentation which contained basically the same information as other more recent documentation in AGI specs. Section numbers above those removed have been moved down.
* Removed sections 4.2 (logic structure), 3.4 (dir/vol file format), 6.2 (view format), 8.2 (OBJECT format) and 8.3 (WORDS.TOK format). These were sections from the AGDS documentation which contained basically the same information as other more recent documentation in AGI specs. Section numbers above those removed have been moved down.
    * Added sections ``LOGIC syntax'' and ``Command list and argument types''.
* Added sections "LOGIC syntax" and "Command list and argument types".
    * Replaced sections ``How the interpreter works'' and ``PICTURE resource format'' with a better translations.
* Replaced sections "How the interpreter works" and "PICTURE resource format" with a better translations.
    * Added more info about the AGDS package in section ``The AGDS package''.
* Added more info about the AGDS package in section "The AGDS package".
    * Updated section ``Websites and people''
* Updated section "Websites and people"
    * Corrected the title of section ``Version 3 resource storage''.
* Corrected the title of section "Version 3 resource storage".
    * Updated the URL for the windows help version of AGI specs in section ``Introduction''.
* Updated the URL for the windows help version of AGI specs in section "Introduction".
    * Fixed up a small formatting error in section ``Version differences'' (the header for one of the tables was repeated so it was removed).
* Fixed up a small formatting error in section "Version differences" (the header for one of the tables was repeated so it was removed).


====5 December 1997====
====5 December 1997====


    * Info about windows help version added to section 1.1.
* Info about windows help version added to section 1.1.
    * Corrections made to info on brush patterns in picture documentation (section 5.1).
* Corrections made to info on brush patterns in picture documentation (section 5.1).
    * Fixed up some small formatting errors in sections 3.4, 3.5, 4.3 and 8.4.
* Fixed up some small formatting errors in sections 3.4, 3.5, 4.3 and 8.4.


====5 October 1997====
====5 October 1997====


    * Section 2.7 (version control) updated.
* Section 2.7 (version control) updated.
    * Section 6.1 (View format) updated.
* Section 6.1 (View format) updated.


====16 September 1997====
====16 September 1997====


    * I forgot to add the version differences section when I converted all the documentation to HTML. It's there now.
* I forgot to add the version differences section when I converted all the documentation to HTML. It's there now.
    * Fixed some problems in the index in section 3.x.
* Fixed some problems in the index in section 3.x.


====31 August 1997====
====31 August 1997====


    * AGI specs is now available!
* AGI specs is now available!
    * A not about the dates on documents: almost all of the original ASCII text versions of these documents did not have a date on them, so I have put the ``last updated'' date to be 31 August 1997, which is when they first appeared in the HTML version of AGI Specs.
* A not about the dates on documents: almost all of the original ASCII text versions of these documents did not have a date on them, so I have put the "last updated" date to be 31 August 1997, which is when they first appeared in the HTML version of AGI Specs.




Line 112: Line 112:
The following people (and probably more) have contributed to this document. Please contact the document maintainer to add more names to this list.
The following people (and probably more) have contributed to this document. Please contact the document maintainer to add more names to this list.


    * Peter Kelly
* Peter Kelly
    * Lance Ewing
* Lance Ewing
    * Alex Simkin
* Alex Simkin
    * Vassili Bykov
* Vassili Bykov
    * Anders M. Olsson
* Anders M. Olsson
    * Jeremy Hayes
* Jeremy Hayes
    * Joakim Möller
* Joakim Möller
    * Martin Tillenius
* Martin Tillenius
    * Stuart George
* Stuart George
    * Dark Minister
* Dark Minister
    * Kevin A. Lee
* Kevin A. Lee
    * Jens Christian Restemeier
* Jens Christian Restemeier
    * Paul Lunga
* Paul Lunga
    * Ian Schmidt
* Ian Schmidt
    * XoXus
* XoXus
    * Claudio Matsuoka
* Claudio Matsuoka
39

edits