FriPoe - Protocol

 

FriPoe Rooms Specifications (Protocol 0.1)

################################################################################
                         FriPoe Room Files Protocol 0.1
################################################################################

You can easily create your own room files. Just follow the few instructions
below to create the files and copy them into the rooms directory that you
specified in the FriPoe configuration file.
All room files must have the extension .fripoe

The first five lines in each room file must be as follows:
1. name=<the name of the room>
2. description=<the description of the room>
3. size=<the size of the room, (width)x(height)>
4. background=<the URL of the default background image
5. interval=<interval in minutes, that defines how often the words are shuffled>

Following these lines is a list of all the words, one word per line.

All of these lines are required, but only the name and the size must be
specified. If the interval is nothing or zero, the words will never be shuffled.

Here is an example (shakespeare.fripoe):
name=Shakespeare
description=This is the Shakespeare room
size=800x600
BACKGROUND=http://fripoe.sf.net/trent.jpg
interval=240
word1
word2
word3
...

These are the suggested number of words for different room sizes:

    Size           Number of Words
----------------------------------
  640x480               ~80
  800x600              ~120
 1024x768              ~200

That's all. It's simple and straight-forward, so have fun creating you own
rooms.
SourceForge.net Logo