compass

JavaScript mapping classes and random generation algorithms JavaScript mapping classes and random generation algorithms

Table of Contents

• Setup
• Usage
  • WebGL Canvas
  • 2d Canvas
• Examples
  • Basic
    • Clustered Rooms - Default
    • Clustered Rooms - Small
    • Clustered Rooms - Large
    • Clustered Rooms - Long Hallways
    • Organized Rooms
    • Patterned Rooms
  • Templates
    • Template - Ancient Crypt
    • Template - Basic
    • Template - Caverns
    • Template - Crypt Catacombs
    • Template - Marsh
    • Template - Passages
    • Template - Standard Crypt
    • Template - Tunnels
  • Landforms
    • Alluvial fan
    • Arroyo
    • Bornhardt
    • Braided Channel
    • Butte
    • Caldera
    • Caverns
    • Chine
    • Cliffs
    • Couloir
    • Cuesta
    • Draw
    • Hogback
    • Esker
    • Exhumed River Channel
    • Fjord
    • Floodplain
    • Glen
    • Gulch
    • Gully
    • Marsh
    • Mogote
    • Ravine
    • Strath
    • Tepui
    • Turlough
    • Uvala
    • Wadi

Setup

Getting started is as easy as npm i @ion-cloud/compass --save and then importing the required modules into your app with import {Map,Sector,maps} from '@ion-cloud/compass'.

Please see code example here.

Usage

WebGL Canvas

import {EaselWebGL} from '@ion-cloud/easel';
import {Map,maps,BasicWebGLDisplay} from '@ion-cloud/compass';

const easel = new EaselWebGL(),
      map = new Map({width:100,height:100}),
      display = new BasicWebGLDisplay({easel,map}),
      {generator} = maps.find(map=> map.name==='template - basic');

generator({map});
easel.onDraw = function(){ display.draw(); };
easel.redraw();

2d Canvas

import {Easel} from '@ion-cloud/core';
import {Map,maps,BasicDisplay} from '@ion-cloud/compass';

const easel = new Easel(),
      map = new Map({width:100,height:100}),
      display = new BasicDisplay({easel,map}),
      {generator} = maps.find(map=> map.name==='template - basic');

generator({map});
easel.onDraw = function(){ display.draw(); };
easel.redraw();

Examples

Basic

Clustered Rooms - Default

Clustered Rooms - Small

Clustered Rooms - Large

Clustered Rooms - Long Hallways

Organized Rooms

Patterned Rooms

Templates

Template - Ancient Crypt

Template - Basic

Template - Caverns

Template - Crypt Catacombs

Template - Marsh

Template - Passages

Template - Standard Crypt

Template - Tunnels

Landforms

Alluvial Fan

Arroyo

Bornhardt

Braided Channel

Butte

Caldera

Caverns

Chine

Cliffs

Couloir

Cuesta

Draw

Hogback

Esker

Exhumed River Channel

Fjord

Floodplain

Glen

Gulch

Gully

Marsh

Mogote

Ravine

Strath

Tepui

Turlough

Uvala

Wadi