summaryrefslogtreecommitdiff
path: root/README.md
blob: e453e89bb0eb2b1cd94fee7dbd742d625a073de6 (plain)
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
bluerose
========

an interactive map-creation tool


running
-------

bluerose is written in vanilla js and doesn't require any building. Simply spin up a web server (I recommend python3's `http.server`) and load `index.html`!

To run the tests, just do `node test.js`.


organization
------------

`index.html` and `main.js` are in the top-level directory, and are the main entry points for the app -- `index.html` loads and runs `main.js`. Everything else lives in `modules/`.

* `modules/3rdparty/` contains stuff that was not written by yours truly.
* `modules/Geometry.js` contains (as you might suppose) geometric primitives, including AABBs and a QuadTree implementation.


credits
-------

bluerose was written by me! (sanine)

I've used [rhill's Javascript-Voronoi] algorithm in performing terrain generation.

The terrain and mapping algorithms were very heavily inspired by mewo2's Uncharted Atlas, which has an [excellent explanatory page].

The blue rose favicon image was adapted from a CC-BY-NC-SA [image by rosipaw].

[rhill's Javascript-Voronoi`]: https://github.com/gorhill/Javascript-Voronoi/
[excellent explanatory page]: https://mewo2.com/notes/terrain/
[image by rosipaw]: https://wordpress.org/openverse/image/97e93986-b710-4920-bd1f-4b62176c5ded