Repository navigation
Docs: V0.1
These are the docs for AVF 0.1.
An AVF file is made up of two basic parts: variables, and frames. The variables are, well, variables. They tell you information about the video. The frames are the actual images of the video, made up of text.
This is an example of a simple 'hello' animation:
speed 1000
height 5
width 9
version 1.0
begin
H
E
H
L
E
H
L
L
E
H
O
L
L
E
H
O
L
L
HE
O
L
HEL
O
HELL
HELLO
end
speed 2000
begin
-HELLO-
--HELLO--
end
It looks a bit complicated, but it's actually pretty simple. Let's break it down. Look at the first part:
speed 1000
height 5
width 9
version 1.0
These are the first variables. All variables have tabs before them to show they're variables. Each of these variables has a specific purpose, which will be explained later in the docs. Now the second part:
begin
H
E
H
L
E
H
L
L
E
H
O
L
L
E
H
O
L
L
HE
O
L
HEL
O
HELL
HELLO
end
The begin simply means we're starting frames. The height variable is the height of each frame. So, you simply take chunks of 5 lines in the text, in order, and play them, and you have a video! The final end part just means we're ending the frames.
speed 2000
This is just changing a variable, speed, midplay. This is useful so you don't have to repeat frames.
begin
-HELLO-
--HELLO--
end
This is just the rest of the file, playing at 2000 instead of 1000.
Now that you should generally understand the basics, let's take a closer look at the pieces.
These are lines of code that tell the player about the video. They have a default value, which is what they're set to if the video doesn't set it. They have valid values, which is just what you can put in the variable. Some can be changed between frame chunks, and some cannot.
This variable changes how many milliseconds are waited before moving on to the next frame.
Can be changed between frames: yes
Valid values: any number
Must be supported: yes
This variable changes how many lines high a frame is.
Can be changed between frames: no
Valid values: any number above 0, but we recommend keeping it small
Must be supported: yes
This variable changes how many characters are in each line. A line can be below this, but NOT ABOVE IT! This variable is mostly so that players can get screen sizes right.
Can be changed between frames: no
Valid values: Any number above 0, you should set this to the highest width your video uses
Must be supported: yes
This variable changes the text color of your video.
Can be changed between frames: yes, but may not be supported
Valid values: One of the following values: 'red', 'orange', 'yellow', 'green', 'purple'
Must be supported: no
This variable changes the background color of your video.
Can be changed between frames: yes, but may not be supported
Valid values: One of the following values: 'red', 'orange', 'yellow', 'green', 'purple'
Must be supported: no
This means if it can be changed midplay, or if it can only be changed at the beginning. You may allow these to be changed midplay in your player for full compatibility, but it's not required.
This means what you can put in the variable.
This is just if a player is required to support this variable. Any player wanting full compatibility should support these variables.