aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
blob: 5bbeab4cbab8c131069b42fd75593e58d63bfb26 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
= XMascot version 2.6

TODO ... Get permission to redistribute this with modifications. :J

[literal]
....
TUT Computer Club "Project XMascot"
Copyright(c) 1996,1997 Go Watanabe   <go@cclub.tutcc.tut.ac.jp.
                       Tsuyoshi Iida <iida@cclub.tutcc.tut.ac.jp>
All Rights Reserved.
....

== Introduction

TODO add a translation for this
[quote]
____
「おお、えんでぃんぐだ...  いやーおもろかった。つぎはだれにしやう...
  ぬ、なにか“ますこっと”ってのがあるぞ...
  おぉ ゆれている、 おぉ のびるのびる、つつくとしゃべるし。
  ぬぬぬ、これって えっくす でほしいよなぁ。」
____

=== Translator's note

This README was translated using Google Translate and DeepL, comparing the different outputs and
making educated guesses about correctness, rewriting when possible.

I am not even a beginner when it comes to translating or speaking Japanese, and I am unfortunately
not well versed in the full breadth of translating.

Thusly, I apologize if any nuance is lost in the translation; regardless, I have done my best to
preserve the perceived _tone_ of the documentation when possible, keeping with the cutesy and
friendly sense of XMascot's style.

If you can speak or read Japanese and feel confident in giving feedback, please do!
The original README is still located in README.jp.orig; it's much more extensive than the original
English README, which is located at README.en.orig.
Talk to me (`somasis`), on irc://irc.libera.chat/#mutiny, and I'll do my best to improve it with
your help!

== What is XMascot?

XMascot is a program that displays a cute mascot on the X Window System display.

It has the following functions:

* It sways back and forth on the screen in a pretty way.

* The chain length can be made shorter or longer according to your preference.

When running, you can also configure it dynamically:

* Switch between multiple mascots depending on your mood;
  you can also create additional mascot selection menus.

* Set the gravity and damping coefficient;
  Xmascot emulates the motion of a pendulum faithfully.

=== Image formats

The following image formats are supported as mascot data:

* GIF (*.gif): up to 256 colors, transparent/interlace supported
* BMP (*.bmp): all formats (however, Xmascot currently malfunctions with 8bpp for 256 colors or more)
* MAG (*.mag): 16 colors or 256 colors

Not supported in 2.6 (as in, not processed by imagelib):

* TIFF (*.tif): 16 or 256 colors, in RAW or LZW compressed format

These work with true color:
* PPM (*.ppm): 256 color shades in raw format
* PGM (*.pgm): 256 grayscale raw format
* PBM (*.pbm): binary monochrome raw format
* FIXME * PNM (*.pnm): any of PPM, PGM, PBM

The image format is determined by the file data, not the extension.

FIXME (not sure about this translation) この機能は 2.6 alpha では TrueColor 以外で動作しない。(imagelib の不備による)

If any commands with the extensions *topnm, *toppm, *topgm, *topbm exist, they'll be called and
loaded on unfamiliar files. (for example: attempting to load `aaa.gif` will call `giftopnm` or
`giftoppm`)

FIXME (not sure about this translation) 透明色は自動的に判定されます。

=== Mascots

This version comes bundled with mascots.

TODO add list of mascots with explanations

TODO translate this
 です。適宜御利用下さい。

 contrib 以下に怪しいおまけソフトが入っています。
 これらについてはそれぞれの README を参照して下さい。

== Installation

To compile XMascot, you'll need a C toolchain, complete with the standard math library, `libm`.

Additionally, you'll need:
* libICE
* libSM
* libX11
* libXau
* libXext
* libXmu
* libXpm
* libXt
* libXaw
    ** libXaw3d is also supported;
       put `-DUSE_XAW3D` in your `$CFLAGS` and `-lXaw3d` in your `LDLIBS` when building Xmascot.

Building and installation is uncomplicated:

1. `make`.
2. `make install`.

Standard variables like `DESTDIR`, `prefix`, `datadir`, `mandir`, etc. are supported.
Change `xmascotdir` if you wish to install the mascot images in a different location.

This edition has been updated some to compile on new machines cleanly, free of 90s-era legacy
code. Patches for portability are welcome.

== Usage

See xmascot(1).

== Changes in this version

All customization from the original XMascot 2.6 has been removed since it seemed unnecessary,
consisting of minor things that reduced dependencies; this seems like it was necessary when
it was written, but no longer necessary these days.

== About this repository

There's some questionable software under `contrib`.

== TODO

What follow is stuff which I have not yet attempted translating.

[literal]
....
FIXME ****** Notice ******
FIXME XMascot は非常にマシンに対する負荷が高く、Pentiumクラス以上でないと、
FIXME 快適な動作は期待できません。
FIXME
 XMascot の最新版、および関連物は

  http://cclub.tutcc.tut.ac.jp/xmascot/
  ftp://cclub.tutcc.tut.ac.jp/pub/xmascot/

 で公開されています。

2.インストール方法

 コンパイルには、gcc 等 ansi 式の記述に対応したコンパイラが必要です。

 (a) config.tmpl の変更

  XMASDIR  
  
  標準のマスコットデータが格納されるディレクトリを設定します。
  ここに付属のマスコットや音声が格納されます。また、このディレクトリは
  標準でサーチパスの最後に追加されます。
  デフォルトは $(LIBDIR)/xmascot です。

 以下に示す項目を環境、要望にあわせて適宜 #define/#undef して下さい

  PERSONAL  個人のホームディレクトリにインストールします。

    PERSONAL を define すると、XMASCOT を個人のホームディレクトリに
    インストールします。 
    $HOME/bin/xmascot, $HOME/xmascot/* $HOME/XMascot
    ($HOME/$LANG/XMascot USE_I18Nの場合) としてインストールされます。
    $HOME/bin にパスを切って使用して下さい。
   
  NEED_DIFFTIME  difftime(3)が無い時に指定します。(SunOS4.1.Xなど)

  DUMMY_SETLOCALE
    
    OS の setlocale が日本語の locale をサポートしておらず、また X が
    -DX_LOCALE をつけずにコンパイルしてあって、国際化機能が利用できない
    場合に、むりやり国際化機能を有効にしたいときに指定します。

  USE_DOUBLE 倍精度演算

    位置計算回りを double を使用します。揺れがとまりそうなときに、
    「カクッ」と動くことがなくなります。あと、とまったと見せかけて実は
    整数演算の誤差のため揺れ続けているということもなくなるはずです。(たぶん)
    数値演算プロセッサ(みんなあるよね^^)のある場合はこっちのがたぶん幸せです。

  USE_CHAINPAT 鎖に絵をはる
 
    鎖に絵を貼れるようにします。

  USE_SHADOW   影をつける

    マスコットに影をつけます。

  USE_XAW3D

    Xaw3D や Xaw95 を使用する際に指定します。

 (b)コンパイル/インストール

   % xmkmf -a
   % make
   % su
   # make install
  
  でインストールが完了します。

 (c) 動作確認

   以下の組合せでの動作を確認しています。

  GATEWAY2000       Pentium 120  OpenBSD 1.2/i386 gcc 2.7.2  XFree86 3.3
  DEC 3000          Alpha ?      DEC OSF/1 V3.0   gcc 2.6.0  X11R5
  SparcStation IPC  Sparc ?      SunOS 4.1.3      gcc 2.7.2  X11R6
  HP 9000/715       ?            HP-UX A.09.07    gcc 2.7.2  X11R6

3.起動方法

  XMascot の起動方法は次の通りです。

  xmascot [option] [filename]

  ファイル名を指定した場合、そのファイルをマスコットとして
  読み込み表示します。ファイルはサポートされている形式の画像データです。
  このマスコットは切替えメニュー0番の一番最後に登録されます。
  ファイル名を指定しない場合は、メニューに登録されたマスコットで起動します。

4.起動時オプション

 -geometry, fg, bg などの 通常のXToolkit のオプションに加えて、
  以下のような起動時オプションがあります。

  ★透明色指定オプション Ver2.6 からは削除しました。どうしても
    指定したい場合はリソースを利用して下さい。

 -verbose        デバッグ用の冗長表示モード
 -gravity n      重力加速度の指定  単位は cm/sec^2 です。
 -chainlength n  鎖の長さを指定します。単位は mm
 -damping n      減衰係数を指定します。0 で揺れが止まらなくなります。
 -degree n       振り始めの角度を指定します。
 -menuno n       起動時のメニューの番号を指定します。
 -no n           起動時のマスコットの番号を指定します。
 -magnify n      マスコットの画像の拡大率を指定します。
 -pinpat fname   ピンの部分の画像を変更します。
 -random         起動時のマスコットをランダムに指定します。
 -changetime min 一定時間ごとにマスコットを切替えます。
                 通常は、1つのメニューセットの中で次々かわります。
                 -random 併用時は random に切替わります。
 -allmenu        上記の切替えが全メニューに及びます
 -searchpath     マスコットおよび音声データのサーチパスを指定します。
                 パスは : で区切ります。
 -chainnum       鎖の個数を指定します。
 -drawtiming n   描画をコマ落ちさせます。n 回に一回の描画になります。

USE_CHAINPAT 指定時のみ有効

 -chainpat fname 鎖の部分の画像を変更します。
....