A-code documentation
I don't seriously expect anybody to be greatly interested in using A-code
to develop adventures. Still, you never know. The built-in browser mode,
plus the ability to create pure HTML/Javascript versions might attract a brave
soul or two. Hence this page.
Not included are a few things, which as a putative user you are expected to
provide on your own:
- A text editor of your choice
- An ANSI C compiler
- And if you wish to try your hand in creating new games:
a dash of creative imagination.
Firstly, let's deal with building runnable games from A-code source files
and the ways of running such games, once built.
A-code build modes explained
Acode games can be built in five distinct modes: console, browser, CGI (same
as PHP), HTML/JavaScript and library test. This document explains what all
these modes are and what they are for.
Using the advmake script to build A-code
games
Since this file is a part of my A-code framework bundle, you clearly have the
advmake script installed. This document explains how to use the script
to build A-code games in various modes.
Running A-code games
The A-code kernel understands a number of command line options,
though some of these need active support from the A-code source. E.g.
adv550 does not understand the name of a game save-file to restore being
supplied on the command line, and may land the player in limbo, with
no source of light.
The remaining documents describe the A-code language itself. I apologise
for the incompleteness of this documentation and in particular for the
description of the A-code langue in acode.html being grossly out of
date. As many programmers know, hacking code is so much more fun than
documenting it! :-) The description of the language being out of date is
somewhat alleviated by other, more recent files.
A-code 11 guide
(Very out of date, needs version 12 re-write)
Explains the concepts of the language and provides a reference guide
to its commands. The best way to learn A-code beyond that is to look at
the available A-code sources.
A-code 12 texts explained
This document explains the details of A-code texts in all their unique glory.
A minimal understanding of the A-code language is helpful but not
essential.
A-code 12 vocabulary
explained This document explains the unique aspects of A-code
vocabulary handling.
A-code 12 minor
directives
Because the A-code guide is by now grossly out of date, this document
gives a terse summary of the minor A-code directives as of A-code
version 12.73.
A-code 12 exec codes
As a
patrial remedy for the A-code guide is by now grossly out of date, this
document gives a terse summary of code values supported by the EXEC minor
directive as of A-code version 12.71.
Game-level
entities known to the A-code 12 kernel.
This document lists all game-level entities (i.e. objects, locations,
variables and flags), which are known to the A-code kernel (version
12.71 at the time of writing).
They are either used by the kernel to pass information to the level of
the game program, or can be used by the program to modify the behaviour
of the kernel.
|