README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# gdx-boardgame
[![](https://jitpack.io/v/jeremyz/gdx-boardgame.svg)](https://jitpack.io/#jeremyz/gdx-boardgame)
[![Build Status](https://travis-ci.org/jeremyz/gdx-boardgame.svg?branch=master)](https://travis-ci.org/jeremyz/gdx-boardgame)

is a [libgdx](https://libgdx.badlogicgames.com/) based framework to build 2D hex map boardgames.

code is mainly extracted from [rustanddust](https://github.com/jeremyz/rustanddust).
check [godot-hexgrid](https://github.com/jeremyz/godot-hexgrid) for the [godot](https://godotengine.org/)/gdscript implementation.

base map made with [hexmap](https://github.com/jeremyz/hexmap) a [gimp](https://www.gimp.org) plugin.

## features

    - 3D line of sight, possible moves, shortest path
    - moveable, zoomable board with tile identification on touch
    - moveable, orientable pieces
    - various animations

## screenshots

![Line Of Sight - Move](data/los-move.png)
![Fire Animation](data/anim-fire.png)
![Move Animation](data/anim-move.png)
![UI Pack](data/ui-pack.png)

## install

Add the repository:
```groovy
	allprojects {
		repositories {
			maven { url 'https://jitpack.io' }
		}
	}
```
Add the dependency to all subprojects: (You can replace `master-SNAPSHOT` with a tag from github)
```groovy
	dependencies {
			implementation 'com.github.jeremyz:gdx-boardgame:master-SNAPSHOT'
	}
```
If you use the html module, you have to add also this module to its dependencies:
```groovy
	dependencies {
			implementation 'com.github.jeremyz:gdx-boardgame:master-SNAPSHOT:sources'
	}
```

For the html build, you have to add this line to your *.gwt.xml files in the html project:
```xml
<inherits name='ch.asynk.gdx.boardgame'/>
```

## javadoc

[Latest](https://javadoc.jitpack.io/com/github/jeremyz/gdx-boardgame/master-SNAPSHOT/javadoc/)