porygion

README

Porygion

Porygion is a procedural region map generator in the Gen-3 Pokémon style.

It's available online in the Porygion Playground.

This repository contains the library code for generating the region map, and the interactive website's code is located in the Porygion Playground repository.

Gallery

Below are some examples region maps that this library can generate.

Documentation

Index

• func RenderBaseRegionMap(regionMap RegionMap) image.Image
• func RenderFullRegionMap(regionMap RegionMap) image.Image
• func RenderRegionMapWithCities(regionMap RegionMap) image.Image
• type RegionMap
  • func GenerateBaseRegionMap(seed int64, pixelWidth, pixelHeight int) RegionMap
  • func GenerateRegionMap(seed int64, pixelWidth, pixelHeight int, numCities int) (RegionMap, error)
  • func GenerateRegionMapWithCities(seed int64, numCities int, regionMap RegionMap) RegionMap
  • func GenerateRegionMapWithRoutes(seed int64, regionMap RegionMap) (RegionMap, error)
• type Tile
  • func (t Tile) Distance(other Tile) int

Functions

func RenderBaseRegionMap

func RenderBaseRegionMap(regionMap RegionMap) image.Image

RenderBaseRegionMap renders a region map using only its elevations.

func RenderFullRegionMap

func RenderFullRegionMap(regionMap RegionMap) image.Image

RenderFullRegionMap renders a full region map.

func RenderRegionMapWithCities

func RenderRegionMapWithCities(regionMap RegionMap) image.Image

RenderRegionMapWithCities renders a region map using only its elevations and cities.

Types

type RegionMap

type RegionMap struct {
	PixelWidth  int
	PixelHeight int
	Elevations  [][]float64
	Cities      []Tile
	Routes      []Tile
}

RegionMap represents a generated region map.

func GenerateBaseRegionMap

func GenerateBaseRegionMap(seed int64, pixelWidth, pixelHeight int) RegionMap

GenerateBaseRegionMap generates a new region map containing only elevations.

func GenerateRegionMap

func GenerateRegionMap(seed int64, pixelWidth, pixelHeight int, numCities int) (RegionMap, error)

GenerateRegionMap generates a new complete region map.

func GenerateRegionMapWithCities

func GenerateRegionMapWithCities(seed int64, numCities int, regionMap RegionMap) RegionMap

GenerateRegionMapWithCities generates a new region map with new city locations, using the provided region map.

func GenerateRegionMapWithRoutes

func GenerateRegionMapWithRoutes(seed int64, regionMap RegionMap) (RegionMap, error)

GenerateRegionMapWithRoutes generates a new region map with new route locations, using the provided region map.

type Tile

type Tile struct {
	X, Y int
}

Tile is a 8x8-pixel section in a region map.

func (Tile) Distance

func (t Tile) Distance(other Tile) int

Distance computes the manhattan distance between two Tiles.