EN
-------------------------------------------------
       This document was translated using
          Yandex and Google Translators
-------------------------------------------------


           Burial Sprite Cutter v1.o5*
-------------------------------------------------
Based  on  the source  code of  the Burial Sprite
Cutter  v1.o4   (c) Sinn/Delirium  Tremens  from
Freedom'1999-o1
-------------------------------------------------


              Description  of the
      Burial Sprite Cutter v1.o5* plug-in


 Version 1.o5*  is further development of version
1.o4.  The module  is  functional in  BGE version
3.o5 and higher.

Changes:

1. The reaction  to the  keys and  mouse  is now
   slowed down  in  the sprite  selection  mode

2. Now , if there are no sprites  in the  AddPage
   memory page , when you select "Cut", a request
   is issued  to  create  a  new  set. And then a
   confirmation request.

 Attention: after creating a new set of sprites,
   the previous content AddPage will be lost.

3. Renamed  the "Compile SPR"  command  to  the
   "Save ASM(WRD)"  command.
   This  command  saves  sprites  as  text in the
   Assembler language with DB commands.

4. Added  a  simple static animator. With the
   ability to select multiple parameters.

5. Now it is possible to set the background color
   for viewing and selecting sprites.


Animator:

 "Animation" - displays the animation of sprites
in the upper left corner of the screen.
 For animation requires at least 2 sprites.

 The "Delay" parameter  defines  the  delay  in
interrupts (1/50 sec.) before the output of the
next frame.

 The "Mode" parameter  defines  the  sequence  of
frames:

  "Replay" is a cyclic repetition of a sequence
           from beginning to end.
           That is, if the sequence for example
           contains 4 frames (0,1,2,3) , then
           the animation order will be:
           0,1,2,3,0,1,2,3,0,1,2,3...

  "Pendulum" - repetition of a sequence of frames
           from beginning to end and vice versa.
           That is, with the same  4 frames (0,1,
           2,3), the animation order will be:
           0,1,2,3,2,1,0,1,2,3,2,1...

 The sequence selection mode determines the start
and end frames of the animation.
 If the  "All sprites"  mode  is  selected ,
the pointer will look like "000--END"
 If the "Select fragment" mode  is selected , the
pointer  will  show  the selected start  and  end
frames.
 When selecting the "Select fragment" option, the
starting frame is selected first , then  the last
one
(the  last  frame  cannot  be  earlier  than
the initial one)


 Background color ( BG: #** ):

 The "BG" parameter  sets  the  screen  color in
sprite or animation selection modes.
 It is  displayed  in  hexadecimal mode , and is
entered by the RGB color selection function.
It should be remembered  that  the selected color
will  also  be saved  in the  main editor format.
In addition , the border  color  is  not  set
separately, but  is selected by the color of the
paper from the specified one.


 The "Information"  option  provides  information
about the current set of sprites.


-------------------------------------------------

  Description structure of the sprites file SPR

-------------------------------------------------


       ORG #C000    ; Location from address #C000
                    ; (page 4 - AddPage)

Head     DB "SPR-"  ; title 4 byte

All      DB N       ; total number of sprites

FloatTab DW TABLICA ; address of the beginning of
                    ; free space in the sprite
                    ; table

Float    DW Sprites ; address of the beginning of
                    ; free space in memory

teksp    DB 0       ; the currently selected
                    ; sprite

TABLICA  DS 1275    ; sprite table 1275 bytes
                    ; 5 bytes per sprite:
                    ;----------------------------
                    ; next (2 bytes) - offset of
                    ;      the  next  sprite
                    ;      relative to the start
                    ;      of the sprites
                    ; size x (1 byte) - size X
                    ; size y (1 byte) - size Y
                    ; flag (1 bytes) - flag for
                    ;       the presence of color
                    ;       attributes
                    ;----------------------------

Sprites             ; from this address, the data
                    ; of the sprites themselves
                    ; begin
                    ; . . . . . . . . . . . . . .


-------------------------------------------------

 Compiling the module:

-------------------------------------------------

 The module is compile using SjASMplus v1.18.3

The main source file is SpriteCut.asm

It is  previously  required  to edit  the loading
paths of the necessary files and the save path of
the resulting plugin.
And also change  the contents  of the "local.asm"
file for the required localization.

When using russian localization, you need to use
the --dos866 key for compiling.

Example of a compilation command:

sjasmplus --dos866 --color=off SpriteCut.asm


-------------------------------------------------



