Update README

(cherry picked from commit 54ffe49ce54bec0227251760f84ce31e948d920c)

diff --git a/README b/README
index 2ecc7ef030b4fc9a1a8d01b8ac7ac13cb5508110..72e1f59552dc496ba688550e0a795b8089193ac3 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,62 @@
+To install and use NetHack and dgamelaunch, simply (tested as working on
+Debian 6.12.88-1, with prerequisites already installed):
+
+After downloading this version of dgamelaunch:
+
+cd dgamelaunch-nh500
+sudo ./install-dgl-nh500
+
+dgamelaunch will be installed at /opt/dgamelaunch, and NetHack 5.0.0 will be
+installed in /opt/dgamelaunch/opt/nh500.
+
+To test the system:
+
+sudo /opt/dgamelaunch/bin/dgamelaunch
+
+Try to register a new user, login, and play the game.
+If it works, brilliant! If it doesn't work, try the NetHack binary:
+
+sudo chroot /opt/dgamelaunch nh500
+
+If that fails, it might be a missing library. Check /opt/dgamelaunch/lib/ and /lib64, and
+compare the contents with the results of `ldd /opt/dgamelaunch/bin/nh500`.
+Then copy over libraries as necessary.
+
+
+If it's working, then you may wish to let people connect to the server just like other servers you see online.
+
+To do this, you will need to do something pretty dangerous -- let anyone run dgamelaunch, even though it has
+root privileges.
+
+sudo chmod a+s /opt/dgamelaunch/bin/dgamelaunch.<date>
+
+Replace <date> with the appropriate string of numbers, obviously. From here, any user can run dgamelaunch on
+your system, which might potentially create a vulnerability.
+
+Next, set up a new user. On Debian:
+
+adduser nethack
+
+And follow the prompts. Name the user whatever you like, and give bogus info for everything other than password.
+Now edit /etc/passwd. The new user's line will look like this:
+
+nethack:x:1001:1001:nethack,1,1,1,1:/home/nethack:/bin/bash
+
+You need to modify the new user's line like so:
+
+nethack:x:<uid>:<gid>:nethack,1,1,1,1:/home/nethack:/opt/dgamelaunch/bin/dgamelaunch.<date>
+
+What we are doing there is setting the user nethack's login shell to dgamelaunch. This way, when someone uses
+SSH to connect to your server, and logs in as nethack, they will be presented immediately with dgamelaunch, and
+will not see a shell when it exits.
+
+Congrats on your new server...
+
+More resources for troubleshooting:
+https://nethackwiki.com/wiki/User:Paxed/HowTo_setup_dgamelaunch
+
+Old readme below
+
 dgamelaunch
 ===========