# $Header: /home/yav/catty/fkiss/RCS/fkiss.doc,v 1.26 2000/08/25 06:54:46 yav Exp $
# This document written in English and Japanese (Shift-JIS).
# To English:
# % sed -f english.sed fkiss.doc
# To Japanese:
# % sed -f japanese.sed fkiss.doc
----------------------------------------------------------------
			* French-KISS! *
----------------------------------------------------------------
* About

This software fkiss - French-KISS! is a sample implementation of
 fkiss - French-KISS! ϡX Window Systemư
KISekae Set system (KISS) for X Window System.
KISekae Set system (KISS)Ǥ
KISS is a software for playing Paper-doll on any computers.
KISSȤΤϥԥ塼夻ؤä򤷤Ƴڤ⤦
"Kisekae" means "changing clothes".
ȤեȥǤ

----------------------------------------------------------------
* Install

To make Makefile
ޤMakefileޤ
 % ./configure

To make executable binary
顤¹ԷΥХʥޤ
 % make

And executable binary "fkiss" is created.
ʤС"fkiss"Ȥ¹ԷΥХʥ꤬ǤȻפޤ

Move this executable binary to install directory you like.
Ǥ顤ΥХʥ /usr/local/bin ʤɤ˥󥹥ȡ뤷ޤ礦
Example
ʴǤ
 # mv fkiss /usr/local/bin
 or
 # make install

"fkiss.man" is a manual source file.
"fkiss.man"ȤΤޥ˥奢ΥեǤ
Copy this file to manual directory you like.
Υեޥ˥奢ǥ쥯ȥ˥ԡƤ
Example
ʤդˡ
 # cp fkiss.man /usr/local/man/man1/fkiss.1
 or
 # make install.man

Copy rc file to your home directory.
rcեۡǥ쥯ȥ˥ԡƤ
 % cp fkissrc.smp ~/.fkissrc


That's all. Let's try!
Ȥޤǥ󥹥ȡϽǤ

----------------------------------------------------------------
* Trouble in make

If you cannot to make fkiss or modified something to make,
⤷fkissmakeǤʤȤʤѹƤޤäϡ
Please tell me that:
ҤȤʲΤȤ򶵤Ƥ
  French-KISS! version
  Hardware and Operating system    
  Error messages
  (Your changes)

----------------
Troube! Error in configure!
configureǥ顼Ǥ롪

"configure" is a shell script file generated by GNU autoconf.
"configure"GNUautoconfˤä줿륹ץȤǤ
If error reported at "/bin/sh configure",
⤷"/bin/sh configure"ǥ顼褦ʤ顤
Check /bin/sh is really Bourne shell.
/bin/sh  Bourne shell Ǥ뤫ǧƤ
If you cannot to use Bourne shell (What's unix system!!),
(ȤǤ)⤷ Bourne shell ѤǤʤˤϡ
Use bash - GNU Bourne-Again SHell.
bash - GNU Bourne-Again SHell ѤƤ
For example, edit "configure" line 1
㤨С"configure"1
>#! /bin/sh
change to
򡤤Τ褦ѹޤ
>#! /usr/local/bin/bash

----------------
Trouble! Nothing opendir library!
äopendir饤֥ʤƤʤ
>dir.o: Undefined symbol _opendir referenced from text segment
>dir.o: Undefined symbol _readdir referenced from text segment
>dir.o: Undefined symbol _closedir referenced from text segment

Change following lines in "headers.h"
"headers.h"μιԤ
>/* directory access routine */
to
Τ褦ѹƤߤƤ
>/* directory access routine */
>#define USE_BSD_DIRLIB 0

----------------
Trouble! Compile error in message.c
message.cǥѥ륨顼Ǥ롪

Add "-DUSE_VARARGS" or "-DUSE_STDARG" to CFLAGS in Makefile,
MakefileCFLAGS "-DUSE_VARARGS""-DUSE_STDARG"ɲäơ
Try to re-compile.
⤦٥ѥ뤷Ƥߤ롥

----------------
Other troubles!
ʳΥȥ֥롪

Try to use GNU product software tools
ǽ餫ĤƤmake, cc, sed, awkʤɤˡ
instead of vender producted make, cc, sed, awk etc.
GNUΥġȤäƤߤȡ
Some problems will be cleared.
ޤ⤷ޤ
For compatibility and performance, I recommend to use GNU product softwares.
ߴǽθϤ顤GNUΥġλѤ򤪤ᤷޤ

----------------------------------------------------------------
* Startup

At first, get KISS data files from WWW and/or FTP-site.
ޤKISSΥǡWWWȤFTPȤꤷƤ

The Big KiSS page - http://otakuworld.com/kiss/

You can find some KISS datas
Webȡֵ̿رפˤKISSǡä֤Ƥޤ
and many favorite links on my web site "Kissin Institute of Softwear".
KISSǡ֤Ƥ륵ȤؤΥ󥯽ޤ
Let's visit!
ƤߤƤ

Kissin Institute of Softwear - http://www2s.biglobe.ne.jp/~yav/
̿ر - http://www2s.biglobe.ne.jp/~yav/

For "First KISS" users, Look sample KISS data archive "frkismi4.lzh"
"KISSϽ"ȤΤˡ"frkismi4.lzh"Ȥץ
contained in this package.
ƱƤޤΤǤ
I experiment some KISS sound/animation extensions in this.
ΥǡǤϡɤ䥢˥γĥμ¸򤷤Ƥޤ
But, these extensions are NOT KISS standards.
KISSɸǤϤޤ
And sound files are not contained.
ʤɥեƱƤޤ

A lot of KISS data files (*.lzh) are packed with LHa archiver.
¿KISSǡLHaΥ֤ۤƤޤ
Install LHa archiver and extract a archive file.
LHa򥤥󥹥ȡ뤷ơ֤Ÿȡ
And you find these files:
Τ褦ʥե뤬ǤϤǤ
	many "*.cel" (pixel)
	some "*.kcf" (color)
	some "*.cnf" (configuration)
These files are extracted, Let's
Υե뤬Ÿ줿顤
 % fkiss
to enjoy kisekae!!
Ȥä夻ؤ򤪳ڤߤ

None argument is specified, fkiss read "*.cnf" in a current directory.
ʤСfkissϥȥǥ쥯ȥ"*.cnf"ɤ߹ߤޤ

Another way to enjoy is more simple.
äȴñʻȤϡ
 % fkiss frkismi4.lzh
fkiss make a directory /tmp/fkiss(PID)
ʤɤȵư /tmp/fkiss(ץID) Ȥǥ쥯ȥäơ
and execute lha to extract files to there.
˥եŸ褦LHaưޤ
And search "*.cnf" in it.
ǡ"*.cnf"ɤ߹ߤޤ

There are some explanations about command line options in a manual.
ޥɥ饤󥪥ץβϥޥ˥奢ˤäȽ񤤤Ȥޤ
 % man fkiss
to read manual.
ȤäɤǤ

----------------------------------------------------------------
* Core dump!

If fkiss is stopeed core dump or X error,
⤷fkissפX errorǽλ顤
Please tell me that:
ʲΤȤ򶵤Ƥ
  Hardware and Operating system    
  Error messages
and fkiss debug information output.
ȡfkissΥǥХåνϤǤ
To save debug information file "fkisslog" do:
ǥХå"fkisslog"Ȥե˥֤ˤϡΤ褦ˤޤ
 $ fkiss -debug bugkiss.lzh 2> fkisslog
  or
 % fkiss -debug bugkiss.lzh >& fkisslog

----------------------------------------------------------------
* Sound

fkiss check /dev/audio device for playing sound.
fkissϲΤ /dev/audioȤǥХʤåޤ
If /dev/audio is exist, fkiss open it and write startup sound data.
/dev/audio ¸ߤ顤ץ󤷤ƥȥåץɤϤޤ
This action makes critical damege to netaudio and some systems.
ưϡnetaudioʤɤΥƥ˰ǽޤ
If you happen this trouble, execute fkiss with "-nosound" option.
꤬褦Ǥ顤-nosound ץĤ fkissưƤ

On Linux or FreeBSD, fkiss use /dev/dsp instead of /dev/audio,
LinuxFreeBSDǤϡ/dev/audioΤ /dev/dspѤ
and use ioctl to setup DSP sampling rate etc. Look sound.c!
ioctlȤäƥץ󥰥졼ꤷޤܤ sound.c򸫤Ƥ͡

If you have more better sound player, Try "-sound 2" option.
Ȥġ뤬С"-sound 2" ץƤߤޤ礦
"-sound 2" option is specified, fkiss execute "play soundfile"
"-sound 2"ꤵ줿顤fkiss "play ɥե"Ȥ
command to play sound. 
ޥɤ¹ԤƲޤޤäƤ

Version 0.32 or later, fkiss use EsounD to play sound.
Version 0.32EsounDλѤǤ륷ƥǤϡ
EsounDȤäƲԤ褦ˤʤޤ

----------------------------------------------------------------
* Conform

fkiss is conforming to KISS/GS2 (KISS General Specification 2),
fkiss KISS/GS2 (KISS General Specification 2) ˽򤷤Ƥޤ
and conforming to KISS/GS3, 4 draft.
ޤޤƤǤ KISS/GS3, 4 ˤ򤷤Ƥޤ

Maximum size of screen
̤礭
	Maximum value of int.
	κ͡

Maximum number of objects
֥ȿ
	MAXOBJ is defined in "fkiss.h". (<= Maximum value of short)
	"fkiss.h"Ƥ MAXOBJȤ͡(ûκͰʲ)

Maximum number of cells

	MAXCEL is defined in "fkiss.h". (<= Maximum value of short)
	"fkiss.h"Ƥ MAXCELȤ͡(ûκͰʲ)

----------------------------------------------------------------
* Reference

kissgs.doc - KISS/GS (KISS General Specification) Manual
Document of KISS standard written in Japanese and English.
KISSɸ˴ؤʸǤѸܸǽ񤤤Ƥޤ

----------------------------------------------------------------
* fkiss Extensions

I use some extensions (sound, animation) in a sample "frkismi4.lzh".
ץ"frkismi4.lzh"(,˥)ĤĥǽȤäƤޤ
These extensions are ONLY for checking technical problems yet.
γĥǽϤޤŪ򸡾ڤ뤿ΤΤǤ
Now we are reseaching:
߻ãϼΤ褦ʤȤƤƤޤ
  Which functions users need?
  桼ϤɤʵǽߤäƤ뤫
  What is smart, eazy, simple description style?
  ޡȤǻȤפƴñʵҷȤϡ
These problems are resolved, we'll define advanced KISS officially.
꤬褵С˼KISSǤ礦
BUT, THAT'S FUNCTIONS AND DESCRIPTION STYLE WILL BE DIFFERENT FROM THIS!
εǽ䵭ҷϺΤΤȤϰۤäΤˤʤϤǤ

----------------------------------------------------------------
* Magic

Add following lines at /etc/magic to identify KISS files.
ιԤ /etc/magic ɲäKISSΥե̤Ǥޤ

--------8<--------8<--------8<--------
# KISS magic number
# Old type cel and kcf are not supported, sorry!
#  yav <yav@bigfoot.com>
0	string		KiSS		KISS/GS
>4	byte		16		color
>>5	byte		x		%d bit
>>8	leshort		x		%d colors
>>10	leshort		x		%d groups
>4	byte		32		cell
>>5	byte		x		%d bit
>>8	leshort		x		%d x
>>10	leshort		x		%d
>>12	leshort		x		+%d
>>14	leshort		x		+%d
--------8<--------8<--------8<--------

----------------------------------------------------------------
* Changes

v0.32 -> v0.33 (Haruka)
GPL
-midiplayer <MIDI player>

v0.31 -> v0.32 (Onpu)
automake is used to make Makefile.in.
Makefile.inΤautomakeȤ褦ˤ
EsounD is used to play sound.
EsounDDzĤ餹褦ˤ
Control-Button1 change cell mapping bug fix.
Control-Button1 ɽѹΥХ

v0.30 -> v0.31
Effective area of true-colored cel calcuration bug fix.
ե륫顼ͭϰϤη׻bug
cnf and doc menu select ButtonRelease trig.
cnfdoc˥塼ButtonReleaseȥꥬˤ
unlimited timer channels.
timerΥͥ¤ʤ
unlimited number of colors specified in kcf file.
kcfǻꤹ뿧¤ʤ

v0.29 -> v0.30
FKiSS2.1 is implemented.
FKiSS2.1εǽ
MAXPATH is not used.
MAXPATH򻲾Ȥʤ褦ˤ
dir_ls recursive.
dir_lsƵˤ
lha xfiqw -> lha xfqw (Extract with directory)
lha xfiqw -> lha xfqw (ǥ쥯ȥդŸ)
if colcnt equal to zero, spx[SPX_BG] pixel for background imggc
colcnt0ΤȤϡspx[SPX_BG]طʥԥȤƻѤ褦ˤ
Object position adjust at all set position.
֥ȤκɸåȤΰ֤褦ˤ
%x (x is any alphabet) started token is not treated as comment in comment line.
%x (xǤդΥե٥å) ǻϤޤȡϥȤȤưʤ
selcnf.c:
 sys/stat.h -> stat.h
sub.c:
 stlen -> strlen
 dos_filename2
sound.c:
 sound file binary mode fopen

v0.28 -> v0.29
Dirk Schenkewitz tell me fix value over-flow bug
Dirk Schenkewitz 󤫤ͤΥСեΥХ
and MAXTIMER expansion advices.
MAXTIMERʤɤν˴ؤѥåäƤΤǤѤ
Someone teach me to open sound_device O_NONBLOCK on Linux.
Supprt True color cell.
ե륫顼Υǡб
gen_arcommand security hole fix
gen_arcommandΥƥۡ٤

v0.27 -> v0.28
Clean temporary files and exit on signal detection.
ʥȤȥƥݥեäƽλ褦ˤ
Request WM_DELETE_WINDOW message for window manager.
WM_DELETE_WINDOWȤȽλ褦ˤ
Use uname library function.
uname饤֥ؿѤ褦ˤ
Support automatic object position adjustment.
֥Ȱ֤μưǽɲá

v0.26 -> v0.27
-noimage mode core dump bug fix.
-noimage ⡼ɤǥפХ
Add document file suffix add or del option -suffix, -nosuffix.
ɥȥեΥեåɲäȺΥץɲá
kisseve.c: TOKEN_LEN_MAX deleted,
kisseve.c: TOKEN_LEN_MAX 
Now no limit for fkiss event extension token length.
fkiss٥ȳĥǽΥȡŤʤʤä
Support environment variable substitution in comment string.
ʸǴĶѿŸ褦ˤ
Add backslash escape character '\$' - dollar.
ХååǥפǤʸȤ'\$' - ɥ뵭ɲá
Trigger first set event.
ǽ˥åȥ٥Ȥȯ褦ˤ
Read options in "$HOME/.fkissrc".
"$HOME/.fkissrc" ˽񤤤ץɤ߹褦ˤ
RIFF-WAVE (*.wav) analyze bug fix.
RIFF-WAVE (*.wav) βϤΥХ

v0.25 -> v0.26
Document file browse function prototype.
ɥȥեαǽλ
Press [Doc] menu or type 'd' key to browse document files.
[Doc]˥塼'd'򲡤ȥɥȥե

v0.24 -> v0.25 (Ruri)
After change set, first drug ignore bug fix.
setѹľΥɥå̵뤵Х
Type mismatch on SUN fix.
SUNǤ Type mismatch 
Set 0 not exist (litks04c.cnf) X error fix.
Set 0 ¸ߤʤ X errorȯƤΤ
sound_play error report.
sound_playǥ顼𤹤褦ˤ

v0.23 -> v0.24
Sound routine sync bug fix.
Cel comment display function is supported.
windowsize viewport function is supported.
Support mouse button function assign changing.
Fix the BUG that sets no information in cnf is not displayed.

v0.22 -> v0.23 (Ellis)
Sound cache bug fix.
Support pseudo transparency mode.

v0.21 -> v0.22 (Rei)
Optimize map change set.
WKISS bug emulation -wkiss option.
Optimize redraw area at change mapping.
Support RIFF-WAVE (*.wav) pcm file.

v0.20 -> v0.21 (Ayanami)
C-Button1 unmap bugfix
Support varargs.h style variable argument function.
Report visual class

v0.19 -> v0.20
Support randomtimer quit event extensions.
Use sound cache buffer.
Sample data frkismi1.lzh updated.

v0.18 -> v0.19
Change message.c to support for FreeBSD.

v0.16 -> v0.18
C-Button1 unmap function add.
Use autoconf to make configure script.

v0.16
First public release.
Sample data frkismi.lzh contained with.

----------------------------------------------------------------
* BUGS (or homeworks for you and me)

If you execute following, will be core dumped.
Τ褦ʤȤȥ򿩤餤Ĥ롥
% fkiss /

TrueColor or DirectColor visual class server is required to display
ե륫顼ΥǡޤKISSǡɽ뤿ˤϡ
True-colored CEL data.
TrueColor ⤷ DirectColor  X serverɬפǤ

Transrucent image operation is emulated with dither stipple pattern.
ȾƩϥǥѥȤäƵŪ˽ޤ

Not correspond with Network Audio System.
Network Audio SystemˤбƤޤ

".Xdefaults" settings are ignored.
".Xdefaults"̵뤵ޤ

Supported only $USER or ${USER} environment variable in comment string.
ʸǻȤΤϡ$USER  ${USER} ȤδĶѿǤ
${USER:-you}, ${USER:=}, ${USER:?} nor ${USER:+} not complete.
${USER:-you}, ${USER:=}, ${USER:?}, ${USER:+} ԴǤ
For example, ${USER-$YOU} do not work.
㤨С${USER-$YOU} Ϥưޤ

----------------------------------------------------------------
* Special thanks

MIO.H <mio.h@bigfoot.com> - KISS original author
DE-TE- <ueno@sds.abk.nec.co.jp> - xkiss author
Clis Hayasaka <yuki@is.s.u-tokyo.ac.jp> - Kiss FAQ author
Cocoa <cocoa@is.s.u-tokyo.ac.jp> - xkiss++ author
Jonathan Couper <couper@metdp2.met.co.nz> - XCheckTypedEvent technical advice
Ken "Mian" Stone <sasami@blaze.net.au> - kissgs.doc English advice
Hannu Savolainen <hsavolai@cs.helsinki.fi> - Linux Sound Driver ulaw.h
YASU. <LDS02540@niftyserve.or.jp> - yasukis1.lzh Lovery Yohko-san :-)
WACHIGAI - fkiss sample data frkismi.lzh Deform. Kismi-chan
Yohko Teppozuka - Lovely cute voice ;-)
Masaki Saeki <HZN83424@biglobe.ne.jp> - NEC EWS4800 bug report
yosinari yabuki/ATO <yabuki@sendai.advantest.co.jp> - SunOS 5.4 bug report
Minoru Iwamoto <iwamo@nims.nec.co.jp> - NEC EWS4800 bug report
Naoyuki Shinbo <j2292106@ed.kagu.sut.ac.jp> - SunOS 4.1.3 bug report
RERE <PXK07402@niftyserve.or.jp> - Solaris 2.4 bug report
Takahiro Suzuki <takahiro@plasma.q.t.u-tokyo.ac.jp> - Browse document function
EMK <VYV03354@niftyserve.or.jp> - no image mode paint_gc bug fix
Takashi Oe <toe@unlinfo.unl.edu> - no image mode paint_gc bug fix
Shuichi OONO <jr5pdx@debian.or.jp> - Temporary file cleaning
yochi@debian.or.jp - use uname library
Dirk Schenkewitz - MAXTIMER, MAXEVENT patch (TELL ME E-MAIL ADDRESS!)
? - Sound device O_NONBLOCK open (TELL ME NAME AND E-MAIL ADDRESS!)
Eric Armstrong <eric_peter_armstrong@yahoo.com> - Illegal cnf bug fix
Amaya <amaya@debian.org> - License advices
Junichi Uekawa <dancer@debian.org> - License advices
Ben <collver@linuxfreemail.com> - midiplay patches

----------------------------------------------------------------
* Copying

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

If you have any advices, questions and BUG reports,
ɥХ䡤ХݡȤʤɤޤ顤
Please send E-mail to me.
ڤ˥᡼뤯


yav             E-mail  yav@bigfoot.com
                WWW     http://www2s.biglobe.ne.jp/~yav/

# End of file