Mercurial > hg > rlgwebd
comparison README.txt @ 146:5baa2d4d798b
Add a README though it's still incomplete.
author | John "Elwin" Edwards |
---|---|
date | Wed, 01 Jan 2014 14:11:40 -0500 |
parents | |
children | 9f9bc41d5006 |
comparison
equal
deleted
inserted
replaced
145:3308eaa00c91 | 146:5baa2d4d798b |
---|---|
1 ===== RLGWebD ===== | |
2 | |
3 RLGWebD is a node.js app that enables playing roguelike games in the | |
4 browser. It is intended to be compatible with dgamelaunch. | |
5 | |
6 Node | |
7 --- | |
8 RLGWebD currently works with Node v0.10. | |
9 | |
10 It requires the 'posix', 'pty.js', and 'websocket' modules. | |
11 | |
12 Installation | |
13 --- | |
14 RLGWebD expects to be run in a dgamelaunch installation, and it makes | |
15 some assumptions about the configuration. It expects the dgamelaunch | |
16 playground to be at /dgldir inside the chroot. It expects the | |
17 in-progress files to be in /dgldir/inprogress/<gamename>. RLGWebD | |
18 creates in-progress files in those locations, and dgamelaunch must be | |
19 patched to prevent it from deleting them. | |
20 | |
21 It needs the devpts filesystem mounted inside the chroot. This can be | |
22 done with a line in /etc/fstab like the following: | |
23 devpts CHROOT/dev/pts devpts newinstance,ptmxmode=666 0 0 | |
24 | |
25 It creates a socket in the filesystem which is used to control the | |
26 server. | |
27 | |
28 sqlickrypt | |
29 --- | |
30 RLGWebD uses a separate program written in C to operate on the | |
31 dgamelaunch user database. Compile this with: | |
32 cc -o sqlickrypt sqlickrypt.c -lcrypt -lsqlite3 | |
33 | |
34 The binary should be placed in /bin inside the chroot. It requires | |
35 libcrypt and libsqlite3 to be installed in the chroot. Depending on | |
36 your system, these may have other dependencies. Make sure to check by | |
37 running ldd. | |
38 | |
39 sqlickrypt needs /dev/urandom to exist in the chroot. Run as root: | |
40 mknod CHROOT/dev/urandom c 1 9 | |
41 | |
42 Starting and stopping | |
43 --- | |
44 Run the 'rlgwebd' shell script as root. | |
45 | |
46 Stop by passing 'stop' as an argument. (This requires socat to be | |
47 installed.) |