46 |
47 |
52 |
53 |
Introduction
54 |
pyscroll is a generic module for making a fast scrolling image with PyGame. It
55 | uses a lot of magic to get reasonable framerates out of PyGame. It only exists
56 | to draw a map. It doesn’t load images or data, so you can use your own custom
57 | data structures, tile storage, ect.
58 |
The included class, BufferedRenderer, gives great framerates, supports layered
59 | rendering and can draw itself. It uses more memory than a typical map would,
60 | but gives much better performance.
61 |
pyscroll is compatible with pytmx (https://github.com/bitcraft/pytmx), so you
62 | can use your Tiled maps. It also has out-of-the-box support for PyGame Sprites.
63 |
64 |
65 |
Features
66 |
67 | - Fast and small footprint
68 | - Layered drawing for tiles
69 | - Drawing and scrolling shapes
70 | - Dirty screen updates
71 | - Pygame Group included
72 |
73 |
74 |
75 |
Shape Drawing
76 |
pyscroll has a new experimental feature for drawing shapes to the map and
77 | scrolling them as part of the map. This can be useful for game that need to
78 | draw arbitrary shaped objects.
79 |
The feature requires pytmx, and that the map files be created in the Tiled Map
80 | Editor. The advantage of of using pyscroll for shape drawing is that pyscroll
81 | can draw the shapes much more efficiently that simply drawing the shapes each
82 | frame.
83 |
This feature is experimental at best. Your comments and support is appreciated!
84 |
85 | - Currently, shapes will not draw over sprites.
86 |
87 |
88 |
89 |
New Game Tutorial
90 |
This is a quick guide on building a new game with pyscroll and pygame. It uses
91 | the PyscrollGroup for efficient rendering. You are free to use any other pygame
92 | techniques and functions.
93 |
Open quest.py in the tutorial folder for a gentle introduction to pyscroll and
94 | the PyscrollGroup for PyGame. There are plenty of comments to get you started.
95 |
The Quest demo shows how you can use a pyscroll group for drawing, how to load
96 | maps with PyTMX, and how pyscroll can quickly render layers. Moving under some
97 | tiles will cause the Hero to be covered.
98 |
It will also render a Shape on the map with experimental shape drawing.
99 |
100 |
101 |
Example Use with PyTMX
102 |
pyscroll and pytmx can load your maps from Tiled and use you PyGame Sprites.
103 |
# Load TMX data
104 | tmx_data = pytmx.load_pygame("desert.tmx")
105 |
106 | # Make data source for the map
107 | map_data = pyscroll.TiledMapData(tmx_data)
108 |
109 | # Make the scrolling layer
110 | screen_size = (400, 400)
111 | map_layer = pyscroll.BufferedRenderer(map_data, screen_size)
112 |
113 | # make the PyGame SpriteGroup with a scrolling map
114 | group = pyscroll.PyscrollGroup(map_layer=map_layer)
115 |
116 | # Add sprites to the group
117 | group.add(srite)
118 |
119 | # Center the layer and sprites on a sprite
120 | group.center(sprite.rect.center)
121 |
122 | # Draw the layer
123 | group.draw(screen)
124 |
125 |
126 |
127 |
128 |
Adapting Existing Games / Map Data
129 |
pyscroll can be used with existing map data, but you will have to create a
130 | class to interact with pyscroll or adapt your data handler to have these
131 | functions / attributes:
132 |
class MyData:
133 |
134 | @property
135 | def tilewidth(self):
136 | """ Return pixel width of map tiles
137 | """
138 |
139 | @property
140 | def tileheight(self):
141 | """ Return pixel height of map tiles
142 | """
143 |
144 | @property
145 | def width(self):
146 | """ Return number of tiles on X axis
147 | """
148 |
149 | @property
150 | def height(self):
151 | """ Return number of tiles on Y axis
152 | """
153 |
154 | @property
155 | def visible_layers(self):
156 | """ Return a list or iterator of layer numbers that are visible.
157 | If using a single layer map, just return [0]
158 | """
159 |
160 | def get_tile_image(self, position):
161 | """ Return a surface for this position.
162 | Return self.default_image if there is not map data for the position.
163 | position is x, y, layer tuple
164 | """
165 |
166 |
167 |
171 |
172 |
173 |
Indices and tables
174 |
179 |
180 |
181 |
182 |
