Skip to content

Commit 7b45bf1

Browse files
committed
Add README
1 parent a20a23f commit 7b45bf1

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Three.js on the Terminal
2+
3+
This is an example of how you can run three.js in your terminal.
4+
Sysadmins can now run three.js in remote ssh sessions!
5+
6+
### Features
7+
- Shows off using three.js in node based environments.
8+
- Terminal / ASCII based rendering
9+
- Screen resize detection aka "Responsive Design"!
10+
- Support mouse events
11+
- Emulate keypress
12+
13+
### Internals
14+
This is built with some awesome libraries.
15+
- [three.js](https://github.com/mrdoob/three.js/) - Duh!
16+
- [blessed](https://github.com/chjj/blessed) - Loads of terminal goodies!
17+
- [node-canvas](https://github.com/Automattic/node-canvas) - Canvas emulation on node.js
18+
19+
### Development
20+
21+
Install dependencies
22+
```
23+
yarn install # or npm install
24+
```
25+
26+
Run
27+
```
28+
node play.js
29+
```
30+
31+
It's tricky to debug blessed apps (since console.log's gonna messup the terminal),
32+
so I'll pipe console.error messages to a log file and tail it elsewhere.
33+
34+
```
35+
node play.js 2>> logs.txt
36+
tail -f logs.txt
37+
```
38+
39+
### Made by
40+
Yet another random idea by the [Graphics Noob](https://twitter.com/BlurSpline)

0 commit comments

Comments
 (0)