From 5c9e9f5dedc26aa894c5cf1672027c91dae28f00 Mon Sep 17 00:00:00 2001 From: churchianity Date: Mon, 18 Feb 2019 20:38:23 -0500 Subject: [PATCH] updated readme --- README.md | 86 +++++++++++++++++++++++++++---------------------------- 1 file changed, 43 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 891cae9..ba508c4 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,61 @@ ------ INTRODUCTION [1.1] --------------------------------------------------- ---[[ author@churchianity.ca +# hex.lua - this is a library for using hexagonal grids in amulet/lua. - it is extremely incomplete. the following list of features is - either implemented shoddily, or not at all. +## INTRODUCTION [1.1] - if you want an actual good resource, go to [1.9]. +this is a library for using hexagonal grids in amulet/lua. +it is extremely incomplete. the following list of features is +either implemented shoddily, or not at all. ------ COORDINATE SYSTEMS [1.2] ---------------------------------------------- +if you want an actual good resource, go to [1.9]. + +## GETTING STARTED [1.2] + +//TODO + +## COORDINATE SYSTEMS [1.3] + +as much coordinate manipulation as possible is done internally. +depending on the task, uses either Axial, Cube, or Doubled coordinates. + +three different ways of returning and sending coordinates: - * as much coordinate manipulation as possible is done internally. - depending on the task, uses either Axial, Cube, or Doubled coordinates. +* amulet vectors +* lua tables +* individual coordinate numbers - * three different ways of returning and sending coordinates: - - 1) amulet vectors - 2) lua tables - 3) individual coordinate numbers - - so you can use what your graphics library likes best! +so you can use what your graphics library likes best! ------ MAPS & MAP STORAGE [1.3] ------------------------------------------------- +## MAPS & MAP STORAGE [1.4] + +Some map shapes: parallelogram, rectangular, hexagonal, triangular. (and more) - some map shapes: parallelogram, rectangular, hexagonal, triangular. (and more) - * storage system based on map shape - see chart: +* storage system based on map shape - see chart: - ________________________________________________________________________ - | SHAPE : MAP STORAGE | - |------------------------------------------------------------------------| - | parallelogram : unordered, hash-like OR ordered, array-like | - | rectangular : unordered, hash-like OR ordered, array-like | - | hexagonal : unordered, hash-like OR ordered, array-like | - | triangular : unordered, hash-like OR ordered, array-like | - | ring : ordered, array-like | - | spiral : ordered, array-like** | - | arbitrary : unordered, hash-like | - |________________________________________________________________________| +* SHAPE : MAP STORAGE +* +* parallelogram : unordered, hash-like OR ordered, array-like +* rectangular : unordered, hash-like OR ordered, array-like +* hexagonal : unordered, hash-like OR ordered, array-like +* triangular : unordered, hash-like OR ordered, array-like +* ring : ordered, array-like +* spiral : ordered, array-like** +* arbitrary : unordered, hash-like + ** note that a spiral map is just a hexagonal one with a particular order. +## CONVENTIONS AND TERMINOLOGY [1.8] ------ CONVENTIONS AND TERMINOLOGY [1.8] ----------------------------------------- - - because so many different kinds of coordinate pairs, trios +because so many different kinds of coordinate pairs, trios ------ RESOURCES USED TO DEVELOP THIS LIBRARY, AND FOR WHICH I AM GRATEFUL [1.9] - +## RESOURCES USED TO DEVELOP THIS LIBRARY, AND FOR WHICH I AM GRATEFUL [1.9] - * https://catlikecoding.com/unity/tutorials/hex-map/ - -> unity tutorial for hexagon grids with some useful generalized math. +* [Hex Map 1](https://catlikecoding.com/unity/tutorials/hex-map/) - unity tutorial for hexagon grids with some useful generalized math. - * https://youtube.com/watch?v=fNk_zzaMoSs&list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab - -> amazing series on linear algebra by 3Blue1Brown +* [3Blue1Brown - Essence of Linear Algebra](https://youtube.com/watch?v=fNk_zzaMoSs&list=PLZHQObOWTQDPD3MizzM2xVFitgF8hE_ab) - amazing series on linear algebra by 3Blue1Brown - * https://redblobgames.com/grid/hexagons - -> now THE resource on hexagonal grids on the internet. +* [Hexagonal Grids](https://redblobgames.com/grid/hexagons) - THE resource on hexagonal grids on the internet. - * http://amulet.xyz/doc - -> amulet documentation. - ]] +* [Amulet Docs](http://amulet.xyz/doc) - amulet documentation. +