[ViewVC] Annotation of: cvs/deliantra/gde/bin/gce

#!/opt/bin/perl

our $VERSION = '1.1';

BEGIN {
   if (%PAR::LibCache) {
      @INC = grep ref, @INC; # weed out all paths except pars loader refs

      while (my ($filename, $zip) = each %PAR::LibCache) {
         for ($zip->memberNames) {
            next unless /^\/root\/(.*)/;
            $zip->extractMember ($_, "$ENV{PAR_TEMP}/$1")
               unless -e "$ENV{PAR_TEMP}/$1";
         }
      }

      $ENV{CROSSFIRE_LIBDIR} ||= $ENV{PAR_TEMP};

      if ($^O eq "MSWin32") {
         $ENV{GTK_RC_FILES} = "$ENV{PAR_TEMP}/share/themes/MS-Windows/gtk-2.0/gtkrc";
      }
   }
}

use Gtk2 -init;

use Data::Dumper;
use File::Spec;

use Crossfire;

use GCE::MainWindow;

our $CFG;
our $MAINWIN;

our $DOCUMENTATION = join ("\n", do { local $/; <DATA> });

sub read_cfg {
   my ($file) = @_;

   open CFG, $file
      or return;

   $CFG = eval join '', <CFG>;

   close CFG;
}

sub write_cfg {
   my ($file) = @_;

   open CFG, ">$file"
      or return;

   {
      local $Data::Dumper::Purity = 1;
      $CFG->{VERSION} = $VERSION;
      print CFG Data::Dumper->Dump ([$CFG], [qw/CFG/]);
   }

   close CFG;
}

# following 2 functions are taken from CV :)
sub find_rcfile($) {
   my $path;

   for (@INC) {

      $path = "$_/GCE/$_[0]";
      return $path if -r $path;
   }

   die "FATAL: can't find required file $_[0]\n";
}

sub require_image($) {
   new_from_file Gtk2::Gdk::Pixbuf find_rcfile "images/$_[0]";
}

sub get_pos_and_size {
   my ($window) = @_;

   my ($x, $y) = $window->get_position;
   my ($w, $h) = $window->get_size;

   return [$x, $y, $w, $h];
}

sub set_pos_and_size {
   my ($window, $p_and_s, $default_w, $default_h, $default_x, $default_y) = @_;

   $window->set_default_size ($p_and_s->[2] || $default_w, $p_and_s->[3] || $default_h);

   # FIXME: This sucks, moving it after showing it can't be a good thing.
   $window->show_all;
   $window->move ($p_and_s->[0] || $default_x, $p_and_s->[1] || $default_y);
}

read_cfg "$Crossfire::VARDIR/gceconfig";

$ENV{CROSSFIRE_LIBDIR} = $CFG->{LIBDIR}
   if $CFG->{LIBDIR};

$CFG->{MAPDIR} ||= File::Spec->catfile ($ENV{CROSSFIRE_LIBDIR}, 'maps');

# must be done after changing the libdir path:
Crossfire::set_libdir ($ENV{CROSSFIRE_LIBDIR});
Crossfire::load_archetypes;
Crossfire::load_tilecache;

my $w = GCE::MainWindow->new;

$w->load_layout;

$w->show_all;

Gtk2->main;

__DATA__

=head1 NAME

  gce - gtk (perl) crossfire editor

=head1 SYNOPSIS

  gce [<map-filename>...]

=head1 FEATURES

gce is a map editor for crossfire.

Its main features are:

   - higher map editing comfort
   - intelligent placement tool
   - intelligent connection tool
   - intelligent erase tool
   - faster and smaller than the java editor
   - map normalizing (removal of old deprecated attributes)
   - exit following
   - world map navigation
   - easier installation (on windows)
   - auto joining of walls (see Placement tool -> auto setting)

=head1 DESCRIPTION

=head2 THE TOOLBOX WINDOW

The toolbox window is the main window of gce. It provides the display of
the currently selected object and the tools. The buttons select of the
editing tool:

=over 4

=item * Pick

This tool is the simplest of all. It lets the user select the topmost
object of a map cell in the map window and updates the stack view for the
current space.

Shortcut-key in map editor: i

=item * Place

This is the intelligent placement tool. It has many modes:

=over 4

=item auto

This mode implements DWIM (do-what-I-mean) by trying to do the the right
thing(tm) with the selected object:

If you place a floor arch, it will try to replace the existing floor or
set the floor below all items. If you place a monster or other arch, it
will place it on top. If you place a wall, it will put the wall above the
floor and propably replace other walls.

Autojoin also works only in this mode. To draw an wall with autojoining pick
the wall arch which name looks like: <wallname>_0.  It's the single point wall
tile which has no connections.
When you place this arch now, it will autoconnect the walls you are drawing.

=item top

Places the arch on the top of the stack of the map cell.

=item above floor

Places the arch just right above the floor (or the bottom of the stack).

=item below floor

Places the arch just right below the floor (or the bottom of the stack).

=item bottom

Places the arch on the bottom of the stack.

=back

Shortcut-key in map editor: p

=item * Erase

This is the tool that lets you erase an arch.

It has following modes:

=over 4

=item top

Erases the topmost object on the stack.

=item walls

Erases all walls in the stack (and only walls).

=item above floor

Erases the first object above the floor.

=item floor

Erases all floor from the stack (and only the floor).

=item below floor

Erases the first object below the floor.

=item bottom

Erases the first object on the bottom of the stack.

=item pick match

This erases all objects from the stack that match the currently selected
object.

=item protect walls (checkbox)

This protects walls from being erased (except when erasing walls).

=item protect monsters (checkbox)

This protects monsters from being erased.

=back

Shortcut-key in map editor: e

=item * Select

This is the selection tool. It can be used to select rectangular areas and
operate on that area in various ways:

=over 4

=item copy

This just copies all objects from the selected area into an internal
buffer for later paste operations.

Shortcut-key in map editor: c

=item paste

This function pastes the internal buffer into the map, beginning in the
top left corner of the selected area. The size of the selection has no
relevance to the result: IT always places the whole internal buffer onto
the map.

Shortcut-key in map editor: p

=item invoke

This function is a very powerful one. It can apply another tool (such as
the place tool) on all spaces of the selected area.

It can, for example, be used to fill a map with floor tiles or erase
everything.

Shortcut-key in map editor: n

=back

Shortcut-key in map editor: s

=item * Eval

This is a very special tool which isn't finished yet. It lets you specify
a perl snippet that can manipulate the stack.

Shortcut-key in map editor: l

=item * Connect

This tool connects two exits, teleporters or adds the configures
connection value to the connectors.

This tool has 3 modes:

=over 4

=item auto

The auto mode tries to find exits first, and if it found one, it will
go into the exit connect mode. If no exit is found but a connectable
object is found, it will just add the connection value to the object.
(Note: This maybe gets in the way if you want to connect teleporters.
 The auto mode will only connect teleporters as if they are exits and not
 touch the connection value).

=item exit

This mode wont set any connection values.

=item connect

In this mode the connect tool will only set connection values and not
try to connect exits.

=back

You can either connect two exits to each other, or just point an exit to
a certain location on a map.

After clicking on an exit the first time you will see a string like this
in the tool dialoge in the main window: 'src: (12,9) teleporter'.
It tells you that you selected a source destination and that the next click will
connect the exit with another exit or just let it point where you clicked (if there
is no connectable object (in auto mode)).

To connect two exits, just click at the first and then at the second, and
the editor will try to find a path (map path) that fits the crossfire conventions.
It will also adjust the (x,y) coords so that the exits point at each other.

If something doesn't work as expected make sure you saved both maps
in a subdirectory of the crossfire map path (which you configured via
File->Preferences in the main window).

If the tile you edited with the connect tool contained a connectable
object, the currently configured connect value (set by the spin buttons in
the main window) will be set on them.

Shortcut-key in map editor: t

=item * Follow Exit

With this tool you can follow exits and teleporters by opening the target
map in a new window (or presents an existing window).

Shortcut-key in map editor: f

=back

=head2 THE STACK VIEW

This window displays the stack of a map space/coordinate.

You can swap two objects on the stack and delete a object from the stack
by dragging one object over another.

By clicking on an item on the stack you can make it the currently selected
object.

=head2 THE MAP EDITOR

This window just displays the map and lets you use the tools. The shortcuts are
documented above in the tool descriptions.

You can pan the map using the middle mouse button and use the tool with
the left mouse button.

There are two modifiers: Holding down the Meta/Alt-key temporarily
switches to the pick tool. Holding down the Ctrl-key temporarily switched
to the erase tool. Both will use their current settings. To change them,
you need to select the tools using the toolbox first.

=head2 THE ATTRIBUTE EDITOR

The attribute editor display the archetype name followed by the object
name and the type of the object in parentheses.

The 'reset to defaults' button erases all changes on the object and resets
it's value to the values of the archetype.

Since there are often many attributes for a given object, they are sorted
into different categories/tabs.

The lore and msg tabs let you edit the text attributes of the object.

Both field labels and value widgets have tool tips enabled. Tool tips on
the labels explain the attribute in more detail. The tool tips on the
value widgets show the default value from the archetype.

On the right side of the attribute editor you will find the inventory, you
can drag stuff there or just use the context menu von the pick window (see below)
to add inventory.

=head2 THE PICK WINDOW

Pick windows are used to quickly pick archetypes from specific categories.

Left click creates an object from the archetype and makes it the currently
selected object for the tools and the attribute editor.

You can change the attributes of the currently selected object in the
attribute editor.

Right click opens the context menu, where you can add the selected arch as
inventory to the object which is currently visible in the attribute editor.

You can open multiple pick windows.

=head1 AUTHOR

 All of the editor GUI:

 Robin Redeker <elmex@ta-sa.org>
 http://www.ta-sa.org/

 The Crossfire map handling module and map widget:

 Marc Lehmann <schmorp@schmorp.de>
 http://home.schmorp.de/

=cut
Revision:	1.23
Committed:	Thu Jun 1 15:03:00 2006 UTC (18 years ago) by elmex
Branch:	MAIN
Changes since 1.22:	+46 -3 lines
Log Message:	Added some documentation for the connect tool. It's still not a good tool as it's IMHO quite complicated...
#	User	Rev	Content
1	root	1.1	#!/opt/bin/perl
2	root	1.16
3	elmex	1.20	our $VERSION = '1.1';
4	elmex	1.12
5			BEGIN {
6			if (%PAR::LibCache) {
7	root	1.16	@INC = grep ref, @INC; # weed out all paths except pars loader refs
8
9	elmex	1.12	while (my ($filename, $zip) = each %PAR::LibCache) {
10			for ($zip->memberNames) {
11			next unless /^\/root\/(.*)/;
12			$zip->extractMember ($_, "$ENV{PAR_TEMP}/$1")
13			unless -e "$ENV{PAR_TEMP}/$1";
14			}
15			}
16
17			$ENV{CROSSFIRE_LIBDIR} \|\|= $ENV{PAR_TEMP};
18
19			if ($^O eq "MSWin32") {
20			$ENV{GTK_RC_FILES} = "$ENV{PAR_TEMP}/share/themes/MS-Windows/gtk-2.0/gtkrc";
21			}
22			}
23			}
24
25			use Gtk2 -init;
26
27			use Data::Dumper;
28			use File::Spec;
29
30			use Crossfire;
31
32			use GCE::MainWindow;
33
34			our $CFG;
35			our $MAINWIN;
36
37			our $DOCUMENTATION = join ("\n", do { local $/; <DATA> });
38
39			sub read_cfg {
40			my ($file) = @_;
41
42			open CFG, $file
43			or return;
44
45			$CFG = eval join '', <CFG>;
46
47			close CFG;
48			}
49
50			sub write_cfg {
51			my ($file) = @_;
52
53			open CFG, ">$file"
54			or return;
55
56			{
57			local $Data::Dumper::Purity = 1;
58	elmex	1.19	$CFG->{VERSION} = $VERSION;
59	elmex	1.12	print CFG Data::Dumper->Dump ([$CFG], [qw/CFG/]);
60			}
61
62			close CFG;
63			}
64
65			# following 2 functions are taken from CV :)
66			sub find_rcfile($) {
67			my $path;
68
69			for (@INC) {
70
71			$path = "$_/GCE/$_[0]";
72			return $path if -r $path;
73			}
74
75			die "FATAL: can't find required file $_[0]\n";
76			}
77
78			sub require_image($) {
79			new_from_file Gtk2::Gdk::Pixbuf find_rcfile "images/$_[0]";
80			}
81
82			sub get_pos_and_size {
83			my ($window) = @_;
84
85			my ($x, $y) = $window->get_position;
86			my ($w, $h) = $window->get_size;
87
88			return [$x, $y, $w, $h];
89			}
90
91			sub set_pos_and_size {
92			my ($window, $p_and_s, $default_w, $default_h, $default_x, $default_y) = @_;
93
94			$window->set_default_size ($p_and_s->[2] \|\| $default_w, $p_and_s->[3] \|\| $default_h);
95
96			# FIXME: This sucks, moving it after showing it can't be a good thing.
97			$window->show_all;
98			$window->move ($p_and_s->[0] \|\| $default_x, $p_and_s->[1] \|\| $default_y);
99			}
100
101			read_cfg "$Crossfire::VARDIR/gceconfig";
102
103	elmex	1.22	$ENV{CROSSFIRE_LIBDIR} = $CFG->{LIBDIR}
104			if $CFG->{LIBDIR};
105
106			$CFG->{MAPDIR} \|\|= File::Spec->catfile ($ENV{CROSSFIRE_LIBDIR}, 'maps');
107	elmex	1.12
108			# must be done after changing the libdir path:
109	elmex	1.22	Crossfire::set_libdir ($ENV{CROSSFIRE_LIBDIR});
110	elmex	1.12	Crossfire::load_archetypes;
111			Crossfire::load_tilecache;
112
113			my $w = GCE::MainWindow->new;
114
115			$w->load_layout;
116
117			$w->show_all;
118
119			Gtk2->main;
120
121			__DATA__
122	root	1.7
123	root	1.1	=head1 NAME
124
125			gce - gtk (perl) crossfire editor
126
127	elmex	1.10	=head1 SYNOPSIS
128
129	root	1.11	gce [<map-filename>...]
130	elmex	1.10
131			=head1 FEATURES
132
133			gce is a map editor for crossfire.
134
135	root	1.11	Its main features are:
136
137			- higher map editing comfort
138	elmex	1.10	- intelligent placement tool
139			- intelligent connection tool
140			- intelligent erase tool
141			- faster and smaller than the java editor
142			- map normalizing (removal of old deprecated attributes)
143			- exit following
144			- world map navigation
145	root	1.11	- easier installation (on windows)
146	elmex	1.18	- auto joining of walls (see Placement tool -> auto setting)
147	elmex	1.10
148			=head1 DESCRIPTION
149
150	root	1.13	=head2 THE TOOLBOX WINDOW
151	elmex	1.10
152	root	1.13	The toolbox window is the main window of gce. It provides the display of
153			the currently selected object and the tools. The buttons select of the
154			editing tool:
155	elmex	1.10
156			=over 4
157
158			=item * Pick
159
160	root	1.11	This tool is the simplest of all. It lets the user select the topmost
161			object of a map cell in the map window and updates the stack view for the
162			current space.
163
164	elmex	1.10	Shortcut-key in map editor: i
165
166			=item * Place
167
168			This is the intelligent placement tool. It has many modes:
169
170			=over 4
171
172			=item auto
173
174	root	1.11	This mode implements DWIM (do-what-I-mean) by trying to do the the right
175			thing(tm) with the selected object:
176
177			If you place a floor arch, it will try to replace the existing floor or
178			set the floor below all items. If you place a monster or other arch, it
179			will place it on top. If you place a wall, it will put the wall above the
180			floor and propably replace other walls.
181	elmex	1.10
182	elmex	1.18	Autojoin also works only in this mode. To draw an wall with autojoining pick
183			the wall arch which name looks like: <wallname>_0. It's the single point wall
184			tile which has no connections.
185			When you place this arch now, it will autoconnect the walls you are drawing.
186
187	elmex	1.10	=item top
188
189	root	1.11	Places the arch on the top of the stack of the map cell.
190	elmex	1.10
191			=item above floor
192
193	root	1.11	Places the arch just right above the floor (or the bottom of the stack).
194	elmex	1.10
195			=item below floor
196
197	root	1.11	Places the arch just right below the floor (or the bottom of the stack).
198	elmex	1.10
199			=item bottom
200
201	root	1.11	Places the arch on the bottom of the stack.
202	elmex	1.10
203			=back
204
205			Shortcut-key in map editor: p
206
207			=item * Erase
208
209			This is the tool that lets you erase an arch.
210	root	1.11
211	elmex	1.10	It has following modes:
212
213			=over 4
214
215			=item top
216
217			Erases the topmost object on the stack.
218
219			=item walls
220
221	root	1.11	Erases all walls in the stack (and only walls).
222	elmex	1.10
223			=item above floor
224
225			Erases the first object above the floor.
226
227			=item floor
228
229	root	1.11	Erases all floor from the stack (and only the floor).
230	elmex	1.10
231			=item below floor
232
233			Erases the first object below the floor.
234
235			=item bottom
236
237			Erases the first object on the bottom of the stack.
238
239			=item pick match
240
241	root	1.11	This erases all objects from the stack that match the currently selected
242			object.
243	elmex	1.10
244	root	1.11	=item protect walls (checkbox)
245	elmex	1.10
246	root	1.11	This protects walls from being erased (except when erasing walls).
247	elmex	1.10
248	root	1.11	=item protect monsters (checkbox)
249	elmex	1.10
250	root	1.11	This protects monsters from being erased.
251	elmex	1.10
252			=back
253
254			Shortcut-key in map editor: e
255
256			=item * Select
257
258	root	1.11	This is the selection tool. It can be used to select rectangular areas and
259			operate on that area in various ways:
260	elmex	1.10
261			=over 4
262
263			=item copy
264
265	root	1.11	This just copies all objects from the selected area into an internal
266			buffer for later paste operations.
267	elmex	1.10
268			Shortcut-key in map editor: c
269
270			=item paste
271
272	root	1.11	This function pastes the internal buffer into the map, beginning in the
273			top left corner of the selected area. The size of the selection has no
274			relevance to the result: IT always places the whole internal buffer onto
275			the map.
276	elmex	1.10
277			Shortcut-key in map editor: p
278
279			=item invoke
280
281	root	1.11	This function is a very powerful one. It can apply another tool (such as
282			the place tool) on all spaces of the selected area.
283
284			It can, for example, be used to fill a map with floor tiles or erase
285			everything.
286	elmex	1.10
287			Shortcut-key in map editor: n
288
289			=back
290
291			Shortcut-key in map editor: s
292
293			=item * Eval
294
295	root	1.11	This is a very special tool which isn't finished yet. It lets you specify
296			a perl snippet that can manipulate the stack.
297	elmex	1.10
298			Shortcut-key in map editor: l
299
300	elmex	1.23	=item * Connect
301	elmex	1.10
302	elmex	1.23	This tool connects two exits, teleporters or adds the configures
303			connection value to the connectors.
304
305			This tool has 3 modes:
306
307			=over 4
308
309			=item auto
310
311			The auto mode tries to find exits first, and if it found one, it will
312			go into the exit connect mode. If no exit is found but a connectable
313			object is found, it will just add the connection value to the object.
314			(Note: This maybe gets in the way if you want to connect teleporters.
315			The auto mode will only connect teleporters as if they are exits and not
316			touch the connection value).
317
318			=item exit
319
320			This mode wont set any connection values.
321
322			=item connect
323
324			In this mode the connect tool will only set connection values and not
325			try to connect exits.
326
327			=back
328	root	1.11
329			You can either connect two exits to each other, or just point an exit to
330			a certain location on a map.
331	elmex	1.10
332	elmex	1.23	After clicking on an exit the first time you will see a string like this
333			in the tool dialoge in the main window: 'src: (12,9) teleporter'.
334			It tells you that you selected a source destination and that the next click will
335			connect the exit with another exit or just let it point where you clicked (if there
336			is no connectable object (in auto mode)).
337
338			To connect two exits, just click at the first and then at the second, and
339			the editor will try to find a path (map path) that fits the crossfire conventions.
340			It will also adjust the (x,y) coords so that the exits point at each other.
341
342			If something doesn't work as expected make sure you saved both maps
343			in a subdirectory of the crossfire map path (which you configured via
344			File->Preferences in the main window).
345
346			If the tile you edited with the connect tool contained a connectable
347			object, the currently configured connect value (set by the spin buttons in
348			the main window) will be set on them.
349
350			Shortcut-key in map editor: t
351	elmex	1.10
352			=item * Follow Exit
353
354	root	1.11	With this tool you can follow exits and teleporters by opening the target
355			map in a new window (or presents an existing window).
356	elmex	1.10
357			Shortcut-key in map editor: f
358
359			=back
360
361			=head2 THE STACK VIEW
362
363	root	1.11	This window displays the stack of a map space/coordinate.
364	elmex	1.10
365	root	1.11	You can swap two objects on the stack and delete a object from the stack
366			by dragging one object over another.
367
368			By clicking on an item on the stack you can make it the currently selected
369			object.
370	elmex	1.10
371			=head2 THE MAP EDITOR
372
373			This window just displays the map and lets you use the tools. The shortcuts are
374			documented above in the tool descriptions.
375
376	root	1.11	You can pan the map using the middle mouse button and use the tool with
377			the left mouse button.
378	elmex	1.10
379	root	1.11	There are two modifiers: Holding down the Meta/Alt-key temporarily
380			switches to the pick tool. Holding down the Ctrl-key temporarily switched
381			to the erase tool. Both will use their current settings. To change them,
382			you need to select the tools using the toolbox first.
383	elmex	1.10
384			=head2 THE ATTRIBUTE EDITOR
385
386	root	1.11	The attribute editor display the archetype name followed by the object
387			name and the type of the object in parentheses.
388
389	elmex	1.21	The 'reset to defaults' button erases all changes on the object and resets
390			it's value to the values of the archetype.
391
392	root	1.11	Since there are often many attributes for a given object, they are sorted
393			into different categories/tabs.
394	elmex	1.10
395	root	1.11	The lore and msg tabs let you edit the text attributes of the object.
396	elmex	1.10
397	root	1.11	Both field labels and value widgets have tool tips enabled. Tool tips on
398			the labels explain the attribute in more detail. The tool tips on the
399			value widgets show the default value from the archetype.
400	elmex	1.10
401	elmex	1.21	On the right side of the attribute editor you will find the inventory, you
402			can drag stuff there or just use the context menu von the pick window (see below)
403			to add inventory.
404	elmex	1.10
405			=head2 THE PICK WINDOW
406
407	root	1.11	Pick windows are used to quickly pick archetypes from specific categories.
408
409			Left click creates an object from the archetype and makes it the currently
410			selected object for the tools and the attribute editor.
411
412			You can change the attributes of the currently selected object in the
413			attribute editor.
414	elmex	1.10
415	elmex	1.21	Right click opens the context menu, where you can add the selected arch as
416			inventory to the object which is currently visible in the attribute editor.
417
418	elmex	1.10	You can open multiple pick windows.
419
420	elmex	1.12	=head1 AUTHOR
421	root	1.1
422	root	1.15	All of the editor GUI:
423	root	1.4
424	elmex	1.12	Robin Redeker <elmex@ta-sa.org>
425			http://www.ta-sa.org/
426	root	1.6
427	root	1.15	The Crossfire map handling module and map widget:
428	root	1.1
429			Marc Lehmann <schmorp@schmorp.de>
430			http://home.schmorp.de/
431
432			=cut