Skip to main content

A pygame rendering engine for top-down tile sets.

Project description

Tile Forge

This is a package for rendering top-down maps from a provided tile set image.

Class Diagram

---
title: Class Relations
---

classDiagram
    Renderer *-- Tileset
    Renderer *-- Map
    class Tileset {
        + all_properties: dict[int, set[int]]
        + tile_size: int
        + path: str
        + load()
        + get_scaled_tiles(scale: int)
        + has_property(tile_index: int, property_id: int): bool
        + set_property(tile_index: int, property_index: int): void
        + remove_property(tile_index: int, property_index: int): void
        + toggle_property(tile_index: int, property_index: int): void
    }

    class Map {
        + width: int
        + height: int
        + layers: list[Layer]
        + set_layers(layers: list[Layer])
        + set_layer_count(count: int)
        + add_layer(layer: Layer)
        + cell_has_property(tileset: Tileset, pos: tuple[int, int], property_id: int): bool
    }

    class Renderer {
        - __map: Map
        - __tileset: Tileset
        + render_tile_size: int
        + tiles: list[Surface]
        + set_render_scale(scale: int)
        + render(surface: Surface, offset: [int, int], callback): void
    }

Usage

import pygame
from tileforge import Tileset, Map, Renderer

pygame.init()

# You need a pygame surface to render the map, so make sure to initialize pygame first
surface = pygame.Surface((640, 480))  # Create a surface to render on

# Load the tileset and map
tileset = Tileset("path/to/tileset.png", 32)
tileset.load()

# Create a map with the loaded tileset
map = Map(10, 10)  # 10x10

# Create a renderer and render the map
renderer = Renderer(tileset, map)
renderer.render(surface)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tileforge-0.1.12.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tileforge-0.1.12-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file tileforge-0.1.12.tar.gz.

File metadata

  • Download URL: tileforge-0.1.12.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for tileforge-0.1.12.tar.gz
Algorithm Hash digest
SHA256 59ed11e3aa07343bd0a0edf162adcd6ff10742fb4ec3239636a55dafe46bddb3
MD5 bc13bb7f8e874c9ce79d6844e41a13ea
BLAKE2b-256 fdfafb71138db8f94f09fffe260417a9394668241773b768f38daede2b4bb555

See more details on using hashes here.

File details

Details for the file tileforge-0.1.12-py3-none-any.whl.

File metadata

  • Download URL: tileforge-0.1.12-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for tileforge-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 fa0f01cdfa3795e28f1a4ef28fddde5ce305d895b76de58b779adc118272e31d
MD5 29004316d3bf9e7fc5f65d75e3da7214
BLAKE2b-256 abfafe7c21a3e72b0a2ef479799e60da862dd1563396a0dcff841eedfae59ec6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page