home · contact · privacy
d3ab1e73b08b8b19d6bcc81f3832d6a72811d963
[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 = {'fov': [], 'other': []}
122         self.io = GameIO(self, save_file)
123         self.login_requests = []
124         self.tasks = {}
125         self.thing_types = {}
126         self.sessions = {}
127         self.faces = {}
128         self.hats = {}
129         self.maps = {}
130         self.map_controls = {}
131         self.map_control_passwords = {}
132         self.annotations = {}
133         self.spawn_point = YX(0, 0), YX(0, 0)
134         self.portals = {}
135         self.player_chars = string.digits + string.ascii_letters
136         self.players_hat_chars = {}
137         self.player_char_i = -1
138         self.admin_passwords = []
139         self.send_gamestate_interval = datetime.timedelta(seconds=0.04)
140         self.last_send_gamestate = datetime.datetime.now() -\
141             self.send_gamestate_interval
142         self.terrains = {
143             '.': Terrain('.', 'floor'),
144             'X': Terrain('X', 'wall', blocks_light=True, blocks_sound=True,
145                          blocks_movement=True),
146             '=': Terrain('=', 'glass', blocks_sound=True, blocks_movement=True),
147             'T': Terrain('T', 'table', blocks_movement=True),
148         }
149         if os.path.exists(self.io.save_file):
150             if not os.path.isfile(self.io.save_file):
151                 raise GameError('save file path refers to non-file')
152
153     def register_thing_type(self, thing_type):
154         self._register_object(thing_type, 'thing_type', 'Thing_')
155
156     def register_task(self, task):
157         self._register_object(task, 'task', 'Task_')
158
159     def read_savefile(self):
160         if os.path.exists(self.io.save_file):
161             with open(self.io.save_file, 'r') as f:
162                 lines = f.readlines()
163             for i in range(len(lines)):
164                 line = lines[i]
165                 print("FILE INPUT LINE %5s: %s" % (i, line), end='')
166                 self.io.handle_input(line, god_mode=True)
167
168     def can_do_thing_with_pw(self, thing, pw):
169         if thing.protection in self.map_control_passwords.keys():
170             if pw != self.map_control_passwords[thing.protection]:
171                 return False
172         return True
173
174     def can_do_tile_with_pw(self, big_yx, little_yx, pw):
175         map_control = self.get_map(big_yx, 'control')
176         tile_class = map_control[little_yx]
177         if tile_class in self.map_control_passwords.keys():
178             tile_pw = self.map_control_passwords[tile_class]
179             if pw != tile_pw:
180                 return False
181         return True
182
183     def get_string_options(self, string_option_type):
184         if string_option_type == 'direction':
185             return self.map_geometry.directions
186         elif string_option_type == 'direction+here':
187             return ['HERE'] + self.map_geometry.directions
188         elif string_option_type == 'char':
189             return [c for c in
190                     string.digits + string.ascii_letters + string.punctuation + ' ']
191         elif string_option_type == 'map_geometry':
192             return ['Hex', 'Square']
193         elif string_option_type == 'thing_type':
194             return self.thing_types.keys()
195         return None
196
197     def get_map_geometry_shape(self):
198         return self.map_geometry.__class__.__name__[len('MapGeometry'):]
199
200     def get_player(self, connection_id):
201         if connection_id not in self.sessions:
202             return None
203         player = self.get_thing(self.sessions[connection_id]['thing_id'])
204         return player
205
206     def get_face(self, t):
207         if t.type_ == 'Player':
208             if t.name in self.faces:
209                 return self.faces[t.name]
210             else:
211                 return '/O  O\\' + '| oo |' + '\\>--</'
212         return None
213
214     def remove_thing(self, t):
215         if t.carrying:
216             t.uncarry()
217         self.things.remove(t)
218         self.record_change(t.position, 'other')
219         if t.blocks_light:
220             self.record_change(t.position, 'fov')
221
222     def add_thing(self, type_, position, id_=0):
223         t_old = None
224         if id_ > 0:
225             t_old = self.get_thing(id_)
226         t = self.thing_types[type_](self, id_=id_, position=position)
227         if t_old:
228             self.things[self.things.index(t_old)] = t
229         else:
230             self.things += [t]
231         self.record_change(t.position, 'other')
232         if t.blocks_light:
233             self.record_change(t.position, 'fov')
234         return t
235
236     def send_gamestate(self, connection_id=None):
237         """Send out game state data relevant to clients."""
238
239         # TODO: limit to connection_id if provided
240         from plomrogue.mapping import FovMap
241         import multiprocessing
242         if connection_id:
243             c_ids = [connection_id]
244         else:
245             c_ids = [c_id for c_id in self.sessions]
246         # Only recalc FOVs for players with ._fov = None
247         player_fovs = []
248         player_ids_send_fov = []
249         player_ids_send_other = []
250         for c_id in c_ids:
251             player = self.get_player(c_id)
252             if not player._fov:
253                 player.prepare_multiprocessible_fov_stencil()
254                 player_fovs += [player._fov]
255                 player_ids_send_fov += [player.id_]
256             if None in (player._seen_things,
257                         player._seen_annotation_positions,
258                         player._seen_portal_positions):
259                 player_ids_send_other += [player.id_]
260         new_fovs = []
261         single_core_until = 16  # since multiprocess has its own overhead
262         if len(player_fovs) > single_core_until:
263             pool = multiprocessing.Pool()
264             new_fovs = pool.map(FovMap.init_terrain, [fov for fov in player_fovs])
265             pool.close()
266             pool.join()
267         elif len(player_fovs) <= single_core_until:
268             for fov in player_fovs:
269                 new_fovs += [fov.init_terrain()]
270         for i in range(len(player_ids_send_fov)):
271             id_ = player_ids_send_fov[i]
272             player = self.get_thing(id_)
273             player._fov = new_fovs[i]
274         for c_id in c_ids:
275             self.io.send('TURN ' + str(self.turn), c_id)
276             player = self.get_player(c_id)
277             self.io.send('PLAYERS_HAT_CHARS ' + quote(player.get_cookie_chars()),
278                          c_id)
279             if player.id_ in player_ids_send_fov:
280                 self.io.send('FOV %s' % quote(player.fov_stencil.terrain), c_id)
281                 self.io.send('MAP %s %s %s' % (self.get_map_geometry_shape(),
282                                                player.fov_stencil.geometry.size,
283                                                quote(player.visible_terrain)), c_id)
284                 self.io.send('MAP_CONTROL %s' % quote(player.visible_control), c_id)
285             if player.id_ in player_ids_send_other:
286                 self.io.send('OTHER_WIPE', c_id)
287                 for t in player.seen_things:
288                     target_yx = player.fov_stencil.target_yx(*t.position)
289                     self.io.send('THING %s %s %s %s %s %s'
290                                  % (target_yx, t.type_, quote(t.protection), t.id_,
291                                     int(t.portable), int(t.commandable)),
292                                  c_id)
293                     if hasattr(t, 'name'):
294                         self.io.send('THING_NAME %s %s' % (t.id_, quote(t.name)), c_id)
295                         if t.type_ == 'Player' and t.name in self.hats:
296                             hat = self.hats[t.name]
297                             self.io.send('THING_HAT %s %s' % (t.id_, quote(hat)), c_id)
298                     face = self.get_face(t)
299                     if face:
300                         self.io.send('THING_FACE %s %s' % (t.id_, quote(face)), c_id)
301                     if hasattr(t, 'thing_char'):
302                         self.io.send('THING_CHAR %s %s' % (t.id_,
303                                                            quote(t.thing_char)), c_id)
304                     if hasattr(t, 'installable') and not t.portable:
305                         self.io.send('THING_INSTALLED %s' % (t.id_), c_id)
306                     if hasattr(t, 'design'):
307                         self.io.send('THING_HAT %s %s' % (t.id_,
308                                                           quote(t.design)), c_id)
309                 for t in [t for t in player.seen_things if t.carrying]:
310                     # send this last so all carryable things are already created
311                     self.io.send('THING_CARRYING %s %s' % (t.id_, t.carrying.id_),
312                                  c_id)
313                 for position in player.seen_portal_positions:
314                     target_yx = player.fov_stencil.target_yx(position[0],
315                                                              position[1])
316                     portal = self.portals[position[0]][position[1]]
317                     self.io.send('PORTAL %s %s' % (target_yx, quote(portal)), c_id)
318                 for position in player.seen_annotation_positions:
319                     target_yx = player.fov_stencil.target_yx(position[0],
320                                                              position[1])
321                     annotation = self.annotations[position[0]][position[1]]
322                     self.io.send('ANNOTATION %s %s' % (target_yx,
323                                                        quote(annotation)), c_id)
324             self.io.send('GAME_STATE_COMPLETE', c_id)
325
326     def record_change(self, position, type_):
327         big_yx, little_yx = position
328         self.changed_tiles[type_] += [self.map_geometry.undouble_yxyx(big_yx,
329                                                                       little_yx)]
330         self.changed = True
331
332     def login(self, nick, connection_id):
333         for t in [t for t in self.things
334                   if t.type_ == 'Player' and t.name == nick]:
335             self.io.send('GAME_ERROR ' + quote('name already in use'),
336                          connection_id)
337             return
338         t = self.add_thing('Player', self.spawn_point)
339         t.name = nick
340         t.thing_char = self.get_next_player_char()
341         self.sessions[connection_id] = {
342             'thing_id': t.id_,
343             'status': 'player'
344         }
345         self.io.send('PLAYER_ID %s' % t.id_, connection_id)
346         self.io.send('LOGIN_OK', connection_id)
347         self.io.send('CHAT ' + quote(t.name + ' entered the map.'))
348         for s in [s for s in self.things
349                   if s.type_ == 'SpawnPoint' and s.name == t.name]:
350             t.position = s.position
351             break
352
353     def run_tick(self):
354
355         # update player sessions
356         to_delete = []
357         for connection_id in self.sessions:
358             connection_id_found = False
359             for server in self.io.servers:
360                 if connection_id in server.clients:
361                     connection_id_found = True
362                     break
363             if not connection_id_found:
364                 t = self.get_player(connection_id)
365                 if hasattr(t, 'name'):
366                     self.io.send('CHAT ' + quote(t.name + ' left the map.'))
367                 self.remove_thing(t)
368                 to_delete += [connection_id]
369         for connection_id in to_delete:
370             del self.sessions[connection_id]
371         while len(self.login_requests) > 0:
372             login_request = self.login_requests.pop()
373             self.login(login_request[0], login_request[1])
374
375         # update game state
376         for t in [t for t in self.things]:
377             if t in self.things:
378                 try:
379                     t.proceed()
380                 except GameError as e:
381                     for connection_id in [c_id for c_id in self.sessions
382                                           if self.sessions[c_id]['thing_id'] == t.id_]:
383                         self.io.send('GAME_ERROR ' + quote(str(e)), connection_id)
384                 except PlayError as e:
385                     for connection_id in [c_id for c_id in self.sessions
386                                           if self.sessions[c_id]['thing_id'] == t.id_]:
387                         self.io.send('PLAY_ERROR ' + quote(str(e)), connection_id)
388
389         # send gamestate if it makes sense at this point
390         if self.changed:
391             self.turn += 1
392             # send_gamestate() can be rather expensive, due to among other reasons
393             # re-calculating players' FOVs, so don't send it out too often
394             if self.last_send_gamestate < \
395                datetime.datetime.now() -self.send_gamestate_interval:
396                 n_changes = 0
397                 for type_ in self.changed_tiles:
398                     n_changes += len(self.changed_tiles[type_])
399                 if n_changes > 0:
400                     for t in [t for t in self.things if t.type_ == 'Player']:
401                         fov_radius = 12  # TODO: un-hardcode
402                         absolute_position =\
403                             self.map_geometry.undouble_yxyx(t.position[0],
404                                                             t.position[1])
405                         y_range_start = absolute_position.y - fov_radius
406                         y_range_end = absolute_position.y + fov_radius
407                         x_range_start = absolute_position.x - fov_radius
408                         x_range_end = absolute_position.x + fov_radius
409                         # TODO: refactor with SourcedMap.inside?
410                         for type_ in self.changed_tiles:
411                             for position in self.changed_tiles[type_]:
412                                 if position.y < y_range_start\
413                                    or position.y > y_range_end:
414                                     continue
415                                 if position.x < x_range_start\
416                                    or position.x > x_range_end:
417                                     continue
418                                 t.invalidate(type_)
419                                 break
420                 self.send_gamestate()
421                 self.changed = False
422                 self.changed_tiles = {'fov': [], 'other': []}
423                 self.save()
424                 self.last_send_gamestate = datetime.datetime.now()
425
426     def get_command(self, command_name):
427
428         def partial_with_attrs(f, *args, **kwargs):
429             from functools import partial
430             p = partial(f, *args, **kwargs)
431             p.__dict__.update(f.__dict__)
432             return p
433
434         def cmd_TASK_colon(task_name, game, *args, connection_id):
435             t = self.get_player(connection_id)
436             if not t:
437                 raise GameError('Not registered as player.')
438             t.set_next_task(task_name, args)
439
440         def task_prefixed(command_name, task_prefix, task_command):
441             if command_name.startswith(task_prefix):
442                 task_name = command_name[len(task_prefix):]
443                 if task_name in self.tasks:
444                     f = partial_with_attrs(task_command, task_name, self)
445                     task = self.tasks[task_name]
446                     f.argtypes = task.argtypes
447                     return f
448             return None
449
450         command = task_prefixed(command_name, 'TASK:', cmd_TASK_colon)
451         if command:
452             return command
453         if command_name in self.commands:
454             f = partial_with_attrs(self.commands[command_name], self)
455             return f
456         return None
457
458     def new_thing_id(self):
459         if len(self.things) == 0:
460             return 1
461         return max([t.id_ for t in self.things]) + 1
462
463     def get_next_player_char(self):
464         self.player_char_i += 1
465         if self.player_char_i >= len(self.player_chars):
466             self.player_char_i = 0
467         return self.player_chars[self.player_char_i]
468
469     def get_foo_blockers(self, foo):
470         foo_blockers = ''
471         for t in self.terrains.values():
472             block_attr = getattr(t, 'blocks_' + foo)
473             if block_attr:
474                 foo_blockers += t.character
475         return foo_blockers
476
477     def get_sound_blockers(self):
478         return self.get_foo_blockers('sound')
479
480     def get_light_blockers(self):
481         return self.get_foo_blockers('light')
482
483     def get_movement_blockers(self):
484         return self.get_foo_blockers('movement')
485
486     def get_flatland(self):
487         for t in self.terrains.values():
488             if not t.blocks_movement:
489                 return t.character
490
491     def save(self):
492
493         def write(f, msg):
494             f.write(msg + '\n')
495
496         with open(self.io.save_file, 'w') as f:
497             write(f, 'TURN %s' % self.turn)
498             map_geometry_shape = self.get_map_geometry_shape()
499             write(f, 'MAP %s %s' % (map_geometry_shape, self.map_geometry.size,))
500             for terrain in self.terrains.values():
501                 write(f, 'TERRAIN %s %s %s %s %s' % (quote(terrain.character),
502                                                      quote(terrain.description),
503                                                      int(terrain.blocks_light),
504                                                      int(terrain.blocks_sound),
505                                                      int(terrain.blocks_movement)))
506                 if len(terrain.tags) > 0:
507                     for tag in terrain.tags:
508                         write(f, 'TERRAIN_TAG %s %s' % (quote(terrain.character),
509                                                         quote(tag)))
510             for big_yx in [yx for yx in self.maps if self.maps[yx].modified]:
511                 for y, line in self.maps[big_yx].lines():
512                     write(f, 'MAP_LINE %s %5s %s' % (big_yx, y, quote(line)))
513             for big_yx in self.annotations:
514                 for little_yx in self.annotations[big_yx]:
515                     write(f, 'GOD_ANNOTATE %s %s %s' %
516                           (big_yx, little_yx, quote(self.annotations[big_yx][little_yx])))
517             for big_yx in self.portals:
518                 for little_yx in self.portals[big_yx]:
519                     write(f, 'GOD_PORTAL %s %s %s' % (big_yx, little_yx,
520                                                       quote(self.portals[big_yx][little_yx])))
521             for big_yx in [yx for yx in self.map_controls
522                            if self.map_controls[yx].modified]:
523                 for y, line in self.map_controls[big_yx].lines():
524                     write(f, 'MAP_CONTROL_LINE %s %5s %s' % (big_yx, y, quote(line)))
525             for tile_class in self.map_control_passwords:
526                 write(f, 'MAP_CONTROL_PW %s %s' % (tile_class,
527                                                    self.map_control_passwords[tile_class]))
528             for pw in self.admin_passwords:
529                 write(f, 'ADMIN_PASSWORD %s' % pw)
530             for name in self.faces:
531                 write(f, 'GOD_PLAYER_FACE %s %s' % (quote(name),
532                                                     quote(self.faces[name])))
533             for name in self.hats:
534                 write(f, 'GOD_PLAYER_HAT %s %s' % (quote(name),
535                                                    quote(self.hats[name])))
536             for name in self.players_hat_chars:
537                 write(f, 'GOD_PLAYERS_HAT_CHARS %s %s' %
538                       (quote(name), quote(self.players_hat_chars[name])))
539             for t in [t for t in self.things if not t.type_ == 'Player']:
540                 write(f, 'THING %s %s %s %s' % (t.position[0],
541                                                 t.position[1], t.type_, t.id_))
542                 write(f, 'GOD_THING_PROTECTION %s %s' % (t.id_, quote(t.protection)))
543                 if hasattr(t, 'name'):
544                     write(f, 'GOD_THING_NAME %s %s' % (t.id_, quote(t.name)))
545                 if hasattr(t, 'installable') and (not t.portable):
546                     write(f, 'THING_INSTALLED %s' % t.id_)
547                 if t.type_ == 'Door' and t.blocks_movement:
548                     write(f, 'THING_DOOR_CLOSED %s %s' % (t.id_, int(t.locked)))
549                 elif t.type_ == 'Hat':
550                     write(f, 'THING_HAT_DESIGN %s %s' % (t.id_,
551                                                          quote(t.design)))
552                 elif t.type_ == 'MusicPlayer':
553                     write(f, 'THING_MUSICPLAYER_SETTINGS %s %s %s %s' %
554                           (t.id_, int(t.playing), t.playlist_index, int(t.repeat)))
555                     for item in t.playlist:
556                         write(f, 'THING_MUSICPLAYER_PLAYLIST_ITEM %s %s %s' %
557                               (t.id_, quote(item[0]), item[1]))
558                 elif t.type_ == 'Bottle' and not t.full:
559                     write(f, 'THING_BOTTLE_EMPTY %s' % t.id_)
560                 elif t.type_ == 'DoorKey':
561                     write(f, 'THING_DOOR_KEY %s %s' % (t.id_, t.door.id_))
562             write(f, 'SPAWN_POINT %s %s' % (self.spawn_point[0],
563                                             self.spawn_point[1]))
564
565     def get_map(self, big_yx, type_='normal'):
566         if type_ == 'normal':
567             maps = self.maps
568         elif type_ == 'control':
569             maps = self.map_controls
570         if big_yx not in maps:
571             maps[big_yx] = SaveableMap(self.map_geometry)
572             if type_ == 'control':
573                 maps[big_yx].draw_presets(big_yx.y % 2)
574         return maps[big_yx]
575
576     def new_world(self, map_geometry):
577         self.maps = {}
578         self.map_controls = {}
579         self.annotations = {}
580         self.portals = {}
581         self.admin_passwords = []
582         self.spawn_point = YX(0, 0), YX(0, 0)
583         self.map_geometry = map_geometry
584         self.map_control_passwords = {'X': 'secret'}
585         self.get_map(YX(0, 0))
586         self.get_map(YX(0, 0), 'control')
587         self.annotations = {}