# dtile-three-renderer

> A threejs renderer for tilemaps.

Latest version **0.13.1** (published 2017-09-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install dtile-three-renderer
pnpm add dtile-three-renderer
yarn add dtile-three-renderer
bun add dtile-three-renderer
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.13.1 |
| Published | 2017-09-30 |
| First published | 2016-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | magnonellie |
| Maintainers | magnonellie |
| Keywords | tilemap, game |

## Links

- npm: https://www.npmjs.com/package/dtile-three-renderer
- npm.io page: https://npm.io/package/dtile-three-renderer

## Dependencies (1)

- [three](https://npm.io/package/three.md) ^0.87.1

## Recent versions

- 0.13.1 (latest) — 2017-09-30
- 0.12.1 — 2017-01-15
- 0.11.0 — 2017-01-08
- 0.10.0 — 2017-01-06
- 0.9.2 — 2017-01-03
- 0.9.1 — 2017-01-03
- 0.9.0 — 2017-01-02
- 0.8.1 — 2016-11-29
- 0.7.0 — 2016-11-20
- 0.6.2 — 2016-11-17
- 0.6.1 — 2016-11-17
- 0.6.0 — 2016-11-17
- 0.5.1 — 2016-11-14
- 0.5.0 — 2016-11-01
- 0.4.0 — 2016-10-31
- … 3 more at https://npm.io/package/dtile-three-renderer/versions

## README

# DTile Three Renderer
[![Build Status](https://travis-ci.org/magnonellie/dtile-three-renderer.svg?branch=master)](https://travis-ci.org/magnonellie/dtile-three-renderer)
[![dependencies Status](https://david-dm.org/magnonellie/dtile-three-renderer/status.svg)](https://david-dm.org/magnonellie/dtile-three-renderer)
[![devDependencies Status](https://david-dm.org/magnonellie/dtile-three-renderer/dev-status.svg)](https://david-dm.org/magnonellie/dtile-three-renderer?type=dev)

dtile-three-renderer is a renderer made with [Three.js](https://threejs.org/)
for rendering tilemaps on the web.

### Design decisions
- Tiles are ***not*** rendered with sprites, but instead use planes. This allows us to bring DTile to the third dimension in the future.
- It's ***not*** continuously updating. You have to manually update the renderer when you make a change to camera, tiles, size, etc. This is to save performance when it's not in use. This may backfire in the future once we start involving animations, but for now, I think this works.
- There are ***no*** tests. I find it incredibly difficult to find a good way to test front-end stuff and since this is essentially just a layer over three, I decided tests wouldn't be too useful for now. Therefore, the test command just executes a lint.
- There is probably a whole lot more which belongs to this section, but I can't come to think of them right now. xP

## Contributing
Any contribution, be it bugs, suggestions, code or whatever, is ***hugely*** appreciated, so don't be shy, please!

To set up your development environment, follow these steps:

1. Clone the repo with `git clone https://github.com/magnonellie/dtile-three-renderer.git`.
2. Run `npm install`.
3. Run `npm run dev` to start a local web-server. You should then be able to open `localhost:8080/demo` in your browser where you can try out your changes.
4. Feel free to add stuff to `demo/index.html` so that it can be used as a full-featured demo!

You should also keep in mind that this project uses es6 without transpiling, so you need to have a recent browser that supports es6! I personally recommend Chrome. ;P

---
_Source: https://npm.io/package/dtile-three-renderer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._