****************
* INFORMATIONS *
****************

Le Framework a t test sur STF/STE/MSTE et non test suffisamment sur FALCON ce qui vaudra  une nouvelle mise  jour trs prochainement.

Le Framework est compatible et compilable sous Devpack 2.x & 3.x.

C'est la version 4.4 qui est en cours actuellement.

1/ Paramtres :
===============

1.1 Utilisation des overscans :
-------------------------------
Par dfaut, c'est le paramtre NO_BORDER qui est utilis.

a) Overscan Bas :
-----------------
BOTTOM_BORDER    equ 0
TOPBOTTOM_BORDER equ 1
NO_BORDER        equ 1

b) Overscan Haut & Bas :
------------------------
BOTTOM_BORDER    equ 1
TOPBOTTOM_BORDER equ 0
NO_BORDER        equ 1

c) Aucun Overscan :
-------------------
BOTTOM_BORDER    equ 1
TOPBOTTOM_BORDER equ 1
NO_BORDER        equ 0

Chaque partie BOTTOM_BORDER, TOPBOTTOM_BORDER & NO_BORDER est initialisable sparment !

1.2 Utilisation des paramtres:
-------------------------------

a) Pattern :
------------
Il permet de remplir les crans du plan que l'on veut, par exemple :
PATTERN          equ $FFFF0000
Remplit le fond de l'cran avec la couleur numro 6 de la palette.

Par dfaut, il doit tre initialis comme ceci :
PATTERN          equ $0
Pour que les crans soient bien ffacs sur 4 plans.

b) Nombre d'crans :
--------------------
Le parametre NB_OF_SCREEN permet d'utiliser un ou deux crans dans votre dmo. Par dfaut il utilise un ecran physique et logique ce qui vite des effets de clipping.

c) Temps Cpu :
--------------
Il permet de voir le temps pris (couleur violette) et le temps restant en noir en restant appuy sur la touche ALTERNATE.
SEEMYVBL         equ 0

Il est conseill de le mettre  "1" une fois le programme termin...

d) Erreurs systmes :
---------------------
Permet de rcuprer le type d'erreur et de l'afficher via un code couleur.
ERROR_SYS        equ 0
Le programme ne rend jamais la main.

Il est conseill de le mettre  "1" une fois le programme termin...

Source code from Mickal Pointier - http://www.defence-force.com

e) Fading :
-----------
Permet de passer de la couleur blanche du bureau au le noir.
FADE_INTRO       equ 1

f) Teste du STE :
-----------------
Permet de bloquer le lancement du programme sur un STF et initialise aussi la partie Falcon pour une meilleure compatibilit.
TEST_STE         equ 1

g) Top comptabilit !
---------------------
J'ai rajout dans le Framework la retro-comptabilit pour FALCON par Arnaud Carr - http://leonard.oxg.free.fr/SainT/saint.html

2/ Principales fonctionnalits :
================================
Assembler control with options of compilating : 
- Case Sensitivity avec control des labels en Minuscule et Majuscule,
- Pas de mode Debug activat,
- Aucune Optimsation du code  la compilation,
- N'affiche pas les messages d'Alertes,
- No Extend Debug mode activated in the final program.
Dtection du mode Superviseur.
Allocation de mmoire pour l'excution du programme.
Performances :
* Arrt du lecteur de disquette,
* Gestion du buffer clavier,
* Gestion du multiboot pour la compatibilit entre le gamme ST/STF/MST/MSTF/STE/MSTE/TT/FALCON,
* Les overscans sont stables sur tout tout type de machine et moniteur suivant le type de musique utilis. (Il n'y a pas de plantage mais un problme de stabilisation !),
Scurit:
* Efface la partie BSS avant de l'initialiser,
* Sauvegarde/restauration de toutes les donnes systmes,
* Gestion des crans :
 - Cration en BSS  la fin du programme,
 - Compatible STE,
 - 2 crans : logique & physique,
 - Sizing d'cran pour le type d'overscan utilis,
 - Remplissage automatique  la cration,
* Dtournement des exceptions,
* Renvoi l'tat de la pile au final.

3/ Comment ajouter du code ?
============================
Pour implmenter du code dans le template :
a) Il faut slectionner le type d'OVERSCAN utilis, par dfaut on utilisera le paramtre NO_BORDER,
b) Implmenter le code appel dans la boucle principale,  partir de la ligne 105,
c) Ajout vos routines  partir de la ligne 572,
d) Ajout vos donnes dans la section DATA  partir de la ligne 584,
e) Ajout vos donnes initialisables dans la section BSS  partir de la ligne 599.
Option Timer :
--------------
a) Rajouter une routine HBL avec la VBL : il faut ajouter l'initialisation des Timers et les appels de la HBL entre les lignes 426,
b) Vous pouvez ajouter du code dans la VBL,  partir de la ligne 253,
c) Dclarer le code de la routine HBL  partir de la ligne 276.

4/ Des exemples :
=================

4.1 example.LZ7 :
-----------------
Utilisation du compacteur LZ7 version 1.3 dans le programme et utilisation des donnes initialisables (partie BSS).

4.2 example.SPU :
-----------------
Affichage d'une image Spectrum 512/4096 couleurs.

4.3 example.STE :
-----------------
Utilisation du blitter (test du STE) et affichage de digits plus utilisation de l'overscan bas.

4.4 example.STF :
-----------------
Utilisation d'un Timer pour afficher des rasters avec un scrolling 8*8 1 plan.

5/ Pour finir :
===============
Et joint avec les fichiers :
- DEVPACK 2.25fr pour compiler la code ASM + MONST pour le dbogage,
- NEOCHROME 2.24 pour faire le dcoupage d'image et utilisation de la palette,
- LZ77-13.TTP pour l'utilisation de fichier LZ7.


Voila !

Frdric Sagez aka Zorro 2^NoExtra.

Update the 4 dec. 2016.
