nickhayashi
/
hexyz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

remove bad readme text

master
Nicholas Hayashi 4 years ago
parent
70851bcf5d
commit
f1a260bf6c
1 changed files with 2 additions and 38 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 40
      README.md

40
README.md
View File

@ -1,48 +1,12 @@
## INTRODUCTION
AN: Basically everything in here it out of date until I remove this line.
This is a small and simple library for using hexagonal grids in amulet + lua. I wrote it for a tower defense game I'm making.
It's not really well documented. If you want an actual good resource, go to [amit's guide to hexagonal grids](https://redblobgames.com/grids/hexagons). So much of what is here I derived from amit's work.
## CONVENTIONS & TERMINOLOGY
If you have read amit's guide to hexagon grids, a lot of the terminology will be familiar to you - I utilize many conventions he does in his guide. That being said, I use some he doesn't, and because so many similar kinds of data structures with different goals are used in this library it can be hard to remember precisely what they all refer to. The following table shows what each table/vector/array refers to in the code:
| NAME | REFERS TO |
| ---- | ------------------------------------------------------------ |
| hex | xyz, *vector* used for most tasks, with constraint x+y+z=0 |
| pix | xy, *vector* true screen pixel coordinates |
| off | xy, 'offset', *vector* used for UI implementations |
| map | *table* of unit hexagon centerpoints arranged in a shape |
* note that 'hex' here is a catch-all term for cube/axial coordinates, as they can often be used interchangeably.
## MAPS & MAP STORAGE
The storage system used is based on the map shape - see chart:
| SHAPE | STORAGE TYPE | KEY | VALUE |
| ------------- | ---------------------- | ------------ | ------------- |
| ring | ordered, array-like | index | vec2(i, j) |
| spiral | ordered, array-like | index | vec2(i, j) |
| parallelogram | unordered, hash-like | vec2(i, j) | simplex noise |
| rectangular | unordered, hash-like | vec2(i, j) | simplex noise |
| hexagonal | unordered, hash-like | vec2(i, j) | simplex noise |
| triangular | unordered, hash-like | vec2(i, j) | simplex noise |
* note that a spiral map is just a hexagonal one with a particular order.
The noise values on the hashmaps are seeded. You can optionally provide a seed after the map's dimensions as an argument, otherwise it's a random seed.
This is a tower defense game.
## RESOURCES
* [Hex Map 1](https://catlikecoding.com/unity/tutorials/hex-map/) - unity tutorial for hexagon grids with some useful generalized math.
* [Hexagonal Grids](https://redblobgames.com/grids/hexagons) - THE resource on hexagonal grids on the internet.
* [Hexagonal Grids](https://redblobgames.com/grids/hexagons) - the best resource on hexagonal grids on the internet.
* [Amulet Docs](http://amulet.xyz/doc) - amulet documentation.
Write Preview
Loading…
Cancel
Save