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.4.tar.gz (6.4 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.4-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tileforge-0.1.4.tar.gz
  • Upload date:
  • Size: 6.4 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.4.tar.gz
Algorithm Hash digest
SHA256 5c123acc9b88ea89aa0e8fb87c9799b84a4439c692b8daa78eb28d57aba1e756
MD5 07aa00477e967e1c20f2da1e5c7f5eac
BLAKE2b-256 6a609e5ffbdd0c7d65fc5e3a8a8bc76ae6a72ac38a32d07fbb820621a9c75cfb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tileforge-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 6.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bd723b19518d01df9e5e1da96e21b042cf6cffae6644af4b9bab6bb392261ead
MD5 e188fa0920c47bca573e1139e3198502
BLAKE2b-256 86f33d1f3513fce987c71bbfea6e4d2a8e107c039fe36006ba53b35411fb6130

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