home · contact · privacy
Make terrain types configurable.
[plomrogue2] / plomrogue / game.py
1 from plomrogue.errors import GameError, PlayError
2 from plomrogue.io import GameIO
3 from plomrogue.misc import quote
4 from plomrogue.mapping import YX, MapGeometrySquare, MapGeometryHex, Map
5 import string
6 import datetime
7
8
9
10 class GameBase:
11
12     def __init__(self):
13         self.turn = 0
14         self.things = []
15         self.map_geometry = MapGeometrySquare(YX(32, 32))
16         self.commands = {}
17
18     def get_thing(self, id_):
19         for thing in self.things:
20             if id_ == thing.id_:
21                 return thing
22         return None
23
24     def _register_object(self, obj, obj_type_desc, prefix):
25         if not obj.__name__.startswith(prefix):
26             raise GameError('illegal %s object name: %s' % (obj_type_desc, obj.__name__))
27         obj_name = obj.__name__[len(prefix):]
28         d = getattr(self, obj_type_desc + 's')
29         d[obj_name] = obj
30
31     def register_command(self, command):
32         self._register_object(command, 'command', 'cmd_')
33
34
35
36 class SaveableMap(Map):
37     modified = False
38
39     def __setitem__(self, *args, **kwargs):
40         super().__setitem__(*args, **kwargs)
41         self.modified = True
42
43     def set_line(self, *args, **kwargs):
44         super().set_line(*args, **kwargs)
45         self.modified = True
46
47     def inside(self, yx):
48         if yx.y < 0 or yx.x < 0 or \
49            yx.y >= self.geometry.size.y or yx.x >= self.geometry.size.x:
50             return False
51         return True
52
53     def draw_presets(self, alternate_hex=0):
54         old_modified = self.modified
55         if type(self.geometry) == MapGeometrySquare:
56             self.set_line(0, 'X' * self.geometry.size.x)
57             self.set_line(1, 'X' * self.geometry.size.x)
58             self.set_line(2, 'X' * self.geometry.size.x)
59             self.set_line(3, 'X' * self.geometry.size.x)
60             self.set_line(4, 'X' * self.geometry.size.x)
61             for y in range(self.geometry.size.y):
62                 self[YX(y, 0)] = 'X'
63                 self[YX(y, 1)] = 'X'
64                 self[YX(y, 2)] = 'X'
65                 self[YX(y, 3)] = 'X'
66                 self[YX(y, 4)] = 'X'
67         elif type(self.geometry) == MapGeometryHex:
68             # TODO: for this to work we need a map side length divisible by 6.
69
70             def draw_grid(offset=YX(0, 0)):
71                 dirs = ('DOWNRIGHT', 'RIGHT', 'UPRIGHT', 'RIGHT')
72
73                 def draw_snake(start):
74                     keep_running = True
75                     yx = start
76                     if self.inside(yx):
77                         self[yx] = 'X'
78                     while keep_running:
79                         for direction in dirs:
80                             if not keep_running:
81                                 break
82                             for dir_progress in range(distance):
83                                 mover = getattr(self.geometry, 'move__' + direction)
84                                 yx = mover(yx)
85                                 if yx.x >= self.geometry.size.x:
86                                     keep_running = False
87                                     break
88                                 if self.inside(yx):
89                                     self[yx] = 'X'
90
91                 if alternate_hex:
92                     draw_snake(offset + YX(0, 0))
93                 draw_snake(offset + YX((0 + alternate_hex) * distance,
94                            -int(1.5 * distance)))
95                 draw_snake(offset + YX((1 + alternate_hex) * distance,
96                            0))
97                 draw_snake(offset + YX((2 + alternate_hex) * distance,
98                            -int(1.5 * distance)))
99
100             distance = self.geometry.size.y // 3
101             draw_grid()
102             draw_grid(YX(2, 0))
103             draw_grid(YX(0, 2))
104             draw_grid(YX(1, 0))
105             draw_grid(YX(0, 1))
106             draw_grid(YX(-1, 0))
107             draw_grid(YX(0, -1))
108             draw_grid(YX(-2, 0))
109             draw_grid(YX(0, -2))
110         self.modified = old_modified
111
112
113
114 import os
115 class Game(GameBase):
116
117     def __init__(self, save_file, *args, **kwargs):
118         from plomrogue.misc import Terrain
119         super().__init__(*args, **kwargs)
120         self.changed = True
121         self.changed_tiles = []
122         self.io = GameIO(self, save_file)
123         self.tasks = {}
124         self.thing_types = {}
125         self.sessions = {}
126         self.faces = {}
127         self.hats = {}
128         self.maps = {}
129         self.map_controls = {}
130         self.map_control_passwords = {}
131         self.annotations = {}
132         self.spawn_point = YX(0, 0), YX(0, 0)
133         self.portals = {}
134         self.player_chars = string.digits + string.ascii_letters
135         self.player_char_i = -1
136         self.admin_passwords = []
137         self.send_gamestate_interval = datetime.timedelta(seconds=0.04)
138         self.last_send_gamestate = datetime.datetime.now() -\
139             self.send_gamestate_interval
140         self.terrains = {
141             '.': Terrain('.', 'floor'),
142             'X': Terrain('X', 'wall', blocks_light=True, blocks_sound=True,
143                          blocks_movement=True),
144             '=': Terrain('=', 'glass', blocks_sound=True, blocks_movement=True),
145             'T': Terrain('T', 'table', blocks_movement=True),
146         }
147         if os.path.exists(self.io.save_file):
148             if not os.path.isfile(self.io.save_file):
149                 raise GameError('save file path refers to non-file')
150
151     def register_thing_type(self, thing_type):
152         self._register_object(thing_type, 'thing_type', 'Thing_')
153
154     def register_task(self, task):
155         self._register_object(task, 'task', 'Task_')
156
157     def read_savefile(self):
158         if os.path.exists(self.io.save_file):
159             with open(self.io.save_file, 'r') as f:
160                 lines = f.readlines()
161             for i in range(len(lines)):
162                 line = lines[i]
163                 print("FILE INPUT LINE %5s: %s" % (i, line), end='')
164                 self.io.handle_input(line, god_mode=True)
165
166     def can_do_thing_with_pw(self, thing, pw):
167         if thing.protection in self.map_control_passwords.keys():
168             if pw != self.map_control_passwords[thing.protection]:
169                 return False
170         return True
171
172     def can_do_tile_with_pw(self, big_yx, little_yx, pw):
173         map_control = self.get_map(big_yx, 'control')
174         tile_class = map_control[little_yx]
175         if tile_class in self.map_control_passwords.keys():
176             tile_pw = self.map_control_passwords[tile_class]
177             if pw != tile_pw:
178                 return False
179         return True
180
181     def get_string_options(self, string_option_type):
182         if string_option_type == 'direction':
183             return self.map_geometry.directions
184         elif string_option_type == 'direction+here':
185             return ['HERE'] + self.map_geometry.directions
186         elif string_option_type == 'char':
187             return [c for c in
188                     string.digits + string.ascii_letters + string.punctuation + ' ']
189         elif string_option_type == 'map_geometry':
190             return ['Hex', 'Square']
191         elif string_option_type == 'thing_type':
192             return self.thing_types.keys()
193         return None
194
195     def get_map_geometry_shape(self):
196         return self.map_geometry.__class__.__name__[len('MapGeometry'):]
197
198     def get_player(self, connection_id):
199         if connection_id not in self.sessions:
200             return None
201         player = self.get_thing(self.sessions[connection_id]['thing_id'])
202         return player
203
204     def get_face(self, t):
205         if t.type_ == 'Player':
206             if t.name in self.faces:
207                 return self.faces[t.name]
208             else:
209                 return '/O  O\\' + '| oo |' + '\\>--</'
210         return None
211
212     def remove_thing(self, t):
213         if t.carrying:
214             t.uncarry()
215         self.things.remove(t)
216         self.record_fov_change(t.position)
217
218     def add_thing(self, type_, position, id_=0):
219         t_old = None
220         if id_ > 0:
221             t_old = self.get_thing(id_)
222         t = self.thing_types[type_](self, id_=id_, position=position)
223         if t_old:
224             self.things[self.things.index(t_old)] = t
225         else:
226             self.things += [t]
227         self.record_fov_change(t.position)
228         return t
229
230     def send_gamestate(self, connection_id=None):
231         """Send out game state data relevant to clients."""
232
233         # TODO: limit to connection_id if provided
234         from plomrogue.mapping import FovMap
235         import multiprocessing
236         if connection_id:
237             c_ids = [connection_id]
238         else:
239             c_ids = [c_id for c_id in self.sessions]
240         # Only recalc FOVs for players with ._fov = None
241         player_fovs = []
242         player_fov_ids = []
243         for c_id in c_ids:
244             player = self.get_player(c_id)
245             if player._fov:
246                 continue
247             player.prepare_multiprocessible_fov_stencil()
248             player_fovs += [player._fov]
249             player_fov_ids += [player.id_]
250         new_fovs = []
251         single_core_until = 16  # since multiprocess has its own overhead
252         if len(player_fovs) > single_core_until:
253             pool = multiprocessing.Pool()
254             new_fovs = pool.map(FovMap.init_terrain, [fov for fov in player_fovs])
255             pool.close()
256             pool.join()
257         elif len(player_fovs) <= single_core_until:
258             for fov in player_fovs:
259                 new_fovs += [fov.init_terrain()]
260         for i in range(len(player_fov_ids)):
261             id_ = player_fov_ids[i]
262             player = self.get_thing(id_)
263             player._fov = new_fovs[i]
264         for c_id in c_ids:
265             self.io.send('TURN ' + str(self.turn), c_id)
266             player = self.get_player(c_id)
267             if player.id_ in player_fov_ids:
268                 self.io.send('FOV %s' % quote(player.fov_stencil.terrain), c_id)
269                 self.io.send('MAP %s %s %s' % (self.get_map_geometry_shape(),
270                                                player.fov_stencil.geometry.size,
271                                                quote(player.visible_terrain)), c_id)
272                 self.io.send('MAP_CONTROL %s' % quote(player.visible_control), c_id)
273             if player.id_ in player_fov_ids:
274                 # FIXME: Many of the following updates are triggered by technically
275                 # inappropriate calls to game.record_fov_change, since they depict
276                 # states that might change independent of FOV changes.  They are
277                 # collected here as a shortcut, but a cleaner way would be to
278                 # differentiate the changes somehow.
279                 self.io.send('PSEUDO_FOV_WIPE', c_id)
280                 for t in player.seen_things:
281                     target_yx = player.fov_stencil.target_yx(*t.position)
282                     self.io.send('THING %s %s %s %s %s %s'
283                                  % (target_yx, t.type_, quote(t.protection), t.id_,
284                                     int(t.portable), int(t.commandable)),
285                                  c_id)
286                     if hasattr(t, 'name'):
287                         self.io.send('THING_NAME %s %s' % (t.id_, quote(t.name)), c_id)
288                         if t.type_ == 'Player' and t.name in self.hats:
289                             hat = self.hats[t.name]
290                             self.io.send('THING_HAT %s %s' % (t.id_, quote(hat)), c_id)
291                     face = self.get_face(t)
292                     if face:
293                         self.io.send('THING_FACE %s %s' % (t.id_, quote(face)), c_id)
294                     if hasattr(t, 'thing_char'):
295                         self.io.send('THING_CHAR %s %s' % (t.id_,
296                                                            quote(t.thing_char)), c_id)
297                     if hasattr(t, 'installable') and not t.portable:
298                         self.io.send('THING_INSTALLED %s' % (t.id_), c_id)
299                     if hasattr(t, 'design'):
300                         self.io.send('THING_HAT %s %s' % (t.id_,
301                                                           quote(t.design)), c_id)
302                 for t in [t for t in player.seen_things if t.carrying]:
303                     # send this last so all carryable things are already created
304                     self.io.send('THING_CARRYING %s %s' % (t.id_, t.carrying.id_),
305                                  c_id)
306                 for big_yx in self.portals:
307                     for little_yx in [little_yx for little_yx in self.portals[big_yx]
308                                       if player.fov_test(big_yx, little_yx)]:
309                         target_yx = player.fov_stencil.target_yx(big_yx, little_yx)
310                         portal = self.portals[big_yx][little_yx]
311                         self.io.send('PORTAL %s %s' % (target_yx, quote(portal)), c_id)
312                 for big_yx in self.annotations:
313                     for little_yx in [little_yx for little_yx in self.annotations[big_yx]
314                                       if player.fov_test(big_yx, little_yx)]:
315                         target_yx = player.fov_stencil.target_yx(big_yx, little_yx)
316                         annotation = self.annotations[big_yx][little_yx]
317                         self.io.send('ANNOTATION %s %s' % (target_yx,
318                                                            quote(annotation)), c_id)
319             self.io.send('GAME_STATE_COMPLETE', c_id)
320
321     def record_fov_change(self, position):
322         big_yx, little_yx = position
323         self.changed_tiles += [self.map_geometry.undouble_yxyx(big_yx,
324                                                                little_yx)]
325         self.changed = True
326
327     def run_tick(self):
328         to_delete = []
329         for connection_id in self.sessions:
330             connection_id_found = False
331             for server in self.io.servers:
332                 if connection_id in server.clients:
333                     connection_id_found = True
334                     break
335             if not connection_id_found:
336                 t = self.get_player(connection_id)
337                 if hasattr(t, 'name'):
338                     self.io.send('CHAT ' + quote(t.name + ' left the map.'))
339                 self.remove_thing(t)
340                 to_delete += [connection_id]
341         for connection_id in to_delete:
342             del self.sessions[connection_id]
343             # self.changed = True  already handled by remove_thing
344         for t in [t for t in self.things]:
345             if t in self.things:
346                 try:
347                     t.proceed()
348                 except GameError as e:
349                     for connection_id in [c_id for c_id in self.sessions
350                                           if self.sessions[c_id]['thing_id'] == t.id_]:
351                         self.io.send('GAME_ERROR ' + quote(str(e)), connection_id)
352                 except PlayError as e:
353                     for connection_id in [c_id for c_id in self.sessions
354                                           if self.sessions[c_id]['thing_id'] == t.id_]:
355                         self.io.send('PLAY_ERROR ' + quote(str(e)), connection_id)
356         if self.changed:
357             self.turn += 1
358             # send_gamestate() can be rather expensive, due to among other reasons
359             # re-calculating players' FOVs, so don't send it out too often
360             if self.last_send_gamestate < \
361                datetime.datetime.now() -self.send_gamestate_interval:
362                 if len(self.changed_tiles) > 0:
363                     for t in [t for t in self.things if t.type_ == 'Player']:
364                         fov_radius = 12  # TODO: un-hardcode
365                         absolute_position =\
366                             self.map_geometry.undouble_yxyx(t.position[0],
367                                                             t.position[1])
368                         y_range_start = absolute_position.y - fov_radius
369                         y_range_end = absolute_position.y + fov_radius
370                         x_range_start = absolute_position.x - fov_radius
371                         x_range_end = absolute_position.x + fov_radius
372                         # TODO: refactor with SourcedMap.inside?
373                         for position in self.changed_tiles:
374                             if position.y < y_range_start\
375                                or position.y > y_range_end:
376                                 continue
377                             if position.x < x_range_start\
378                                or position.x > x_range_end:
379                                 continue
380                             t.invalidate_map_view()
381                             break
382                 self.send_gamestate()
383                 self.changed = False
384                 self.changed_tiles = []
385                 self.save()
386                 self.last_send_gamestate = datetime.datetime.now()
387
388     def get_command(self, command_name):
389
390         def partial_with_attrs(f, *args, **kwargs):
391             from functools import partial
392             p = partial(f, *args, **kwargs)
393             p.__dict__.update(f.__dict__)
394             return p
395
396         def cmd_TASK_colon(task_name, game, *args, connection_id):
397             t = self.get_player(connection_id)
398             if not t:
399                 raise GameError('Not registered as player.')
400             t.set_next_task(task_name, args)
401
402         def task_prefixed(command_name, task_prefix, task_command):
403             if command_name.startswith(task_prefix):
404                 task_name = command_name[len(task_prefix):]
405                 if task_name in self.tasks:
406                     f = partial_with_attrs(task_command, task_name, self)
407                     task = self.tasks[task_name]
408                     f.argtypes = task.argtypes
409                     return f
410             return None
411
412         command = task_prefixed(command_name, 'TASK:', cmd_TASK_colon)
413         if command:
414             return command
415         if command_name in self.commands:
416             f = partial_with_attrs(self.commands[command_name], self)
417             return f
418         return None
419
420     def new_thing_id(self):
421         if len(self.things) == 0:
422             return 1
423         return max([t.id_ for t in self.things]) + 1
424
425     def get_next_player_char(self):
426         self.player_char_i += 1
427         if self.player_char_i >= len(self.player_chars):
428             self.player_char_i = 0
429         return self.player_chars[self.player_char_i]
430
431     def get_foo_blockers(self, foo):
432         foo_blockers = ''
433         for t in self.terrains.values():
434             block_attr = getattr(t, 'blocks_' + foo)
435             if block_attr:
436                 foo_blockers += t.character
437         return foo_blockers
438
439     def get_sound_blockers(self):
440         return self.get_foo_blockers('sound')
441
442     def get_light_blockers(self):
443         return self.get_foo_blockers('light')
444
445     def get_movement_blockers(self):
446         return self.get_foo_blockers('movement')
447
448     def get_flatland(self):
449         for t in self.terrains.values:
450             if not t.blocks_movement:
451                 return t.character
452
453     def save(self):
454
455         def write(f, msg):
456             f.write(msg + '\n')
457
458         with open(self.io.save_file, 'w') as f:
459             write(f, 'TURN %s' % self.turn)
460             map_geometry_shape = self.get_map_geometry_shape()
461             write(f, 'MAP %s %s' % (map_geometry_shape, self.map_geometry.size,))
462             for terrain in self.terrains.values():
463                 write(f, 'TERRAIN %s %s %s %s %s' % (quote(terrain.character),
464                                                      quote(terrain.description),
465                                                      int(terrain.blocks_light),
466                                                      int(terrain.blocks_sound),
467                                                      int(terrain.blocks_movement)))
468             for big_yx in [yx for yx in self.maps if self.maps[yx].modified]:
469                 for y, line in self.maps[big_yx].lines():
470                     write(f, 'MAP_LINE %s %5s %s' % (big_yx, y, quote(line)))
471             for big_yx in self.annotations:
472                 for little_yx in self.annotations[big_yx]:
473                     write(f, 'GOD_ANNOTATE %s %s %s' %
474                           (big_yx, little_yx, quote(self.annotations[big_yx][little_yx])))
475             for big_yx in self.portals:
476                 for little_yx in self.portals[big_yx]:
477                     write(f, 'GOD_PORTAL %s %s %s' % (big_yx, little_yx,
478                                                       quote(self.portals[big_yx][little_yx])))
479             for big_yx in [yx for yx in self.map_controls
480                            if self.map_controls[yx].modified]:
481                 for y, line in self.map_controls[big_yx].lines():
482                     write(f, 'MAP_CONTROL_LINE %s %5s %s' % (big_yx, y, quote(line)))
483             for tile_class in self.map_control_passwords:
484                 write(f, 'MAP_CONTROL_PW %s %s' % (tile_class,
485                                                    self.map_control_passwords[tile_class]))
486             for pw in self.admin_passwords:
487                 write(f, 'ADMIN_PASSWORD %s' % pw)
488             for name in self.faces:
489                 write(f, 'GOD_PLAYER_FACE %s %s' % (quote(name),
490                                                     quote(self.faces[name])))
491             for name in self.hats:
492                 write(f, 'GOD_PLAYER_HAT %s %s' % (quote(name),
493                                                    quote(self.hats[name])))
494             for t in [t for t in self.things if not t.type_ == 'Player']:
495                 write(f, 'THING %s %s %s %s' % (t.position[0],
496                                                 t.position[1], t.type_, t.id_))
497                 write(f, 'GOD_THING_PROTECTION %s %s' % (t.id_, quote(t.protection)))
498                 if hasattr(t, 'name'):
499                     write(f, 'GOD_THING_NAME %s %s' % (t.id_, quote(t.name)))
500                 if hasattr(t, 'installable') and (not t.portable):
501                     write(f, 'THING_INSTALLED %s' % t.id_)
502                 if t.type_ == 'Door' and t.blocking:
503                     write(f, 'THING_DOOR_CLOSED %s' % t.id_)
504                 elif t.type_ == 'Hat':
505                     write(f, 'THING_HAT_DESIGN %s %s' % (t.id_,
506                                                          quote(t.design)))
507                 elif t.type_ == 'MusicPlayer':
508                     write(f, 'THING_MUSICPLAYER_SETTINGS %s %s %s %s' %
509                           (t.id_, int(t.playing), t.playlist_index, int(t.repeat)))
510                     for item in t.playlist:
511                         write(f, 'THING_MUSICPLAYER_PLAYLIST_ITEM %s %s %s' %
512                               (t.id_, quote(item[0]), item[1]))
513                 elif t.type_ == 'Bottle' and not t.full:
514                     write(f, 'THING_BOTTLE_EMPTY %s' % t.id_)
515             write(f, 'SPAWN_POINT %s %s' % (self.spawn_point[0],
516                                             self.spawn_point[1]))
517
518     def get_map(self, big_yx, type_='normal'):
519         if type_ == 'normal':
520             maps = self.maps
521         elif type_ == 'control':
522             maps = self.map_controls
523         if big_yx not in maps:
524             maps[big_yx] = SaveableMap(self.map_geometry)
525             if type_ == 'control':
526                 maps[big_yx].draw_presets(big_yx.y % 2)
527         return maps[big_yx]
528
529     def new_world(self, map_geometry):
530         self.maps = {}
531         self.map_controls = {}
532         self.annotations = {}
533         self.portals = {}
534         self.admin_passwords = []
535         self.spawn_point = YX(0, 0), YX(0, 0)
536         self.map_geometry = map_geometry
537         self.map_control_passwords = {'X': 'secret'}
538         self.get_map(YX(0, 0))
539         self.get_map(YX(0, 0), 'control')
540         self.annotations = {}