From e192a3a1f5964ea628979962e10303b497e902b6 Mon Sep 17 00:00:00 2001 From: Skyebee Date: Sat, 13 Jun 2026 23:12:53 -0400 Subject: [PATCH] Move some documentation into wiki, and add wiki as submodule WIP README WIP README WIP README Reformat existing README sections README WIP WIP Create doc dir and some wiki pages Add wiki to repo as submodule Move resources.md to wiki --- .gitignore | 1 - .gitmodules | 3 ++ Makefile.in | 2 +- README.md | 48 ++++++++++++++++++++---------- README.bak => doc/README.bak | 0 dgamelaunch.8 => doc/dgamelaunch.8 | 0 doc/history.md | 16 ++++++++++ doc/wiki | 1 + 8 files changed, 53 insertions(+), 18 deletions(-) create mode 100644 .gitmodules rename README.bak => doc/README.bak (100%) rename dgamelaunch.8 => doc/dgamelaunch.8 (100%) create mode 100644 doc/history.md create mode 160000 doc/wiki diff --git a/.gitignore b/.gitignore index 0dc832b..306b8a8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ - # / /configure /Makefile diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..0bde9ca --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "doc/wiki"] + path = doc/wiki + url = git@github.com:zalethon/dgamelaunch.wiki.git diff --git a/Makefile.in b/Makefile.in index ea09bf8..89eb64b 100644 --- a/Makefile.in +++ b/Makefile.in @@ -51,7 +51,7 @@ install: all mkdir -p $(DESTDIR)$(sbindir) $(INSTALL) -m 755 $(NAME) $(DESTDIR)$(sbindir) mkdir -p $(DESTDIR)$(mandir)/man8 - $(INSTALL) -m 644 $(MAN8) $(DESTDIR)$(mandir)/man8 + $(INSTALL) -m 644 doc/$(MAN8) $(DESTDIR)$(mandir)/man8 indent: indent -nut -ts2 *.c *.h diff --git a/README.md b/README.md index 32f849f..2e18d6e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ -The main feature of the master branch of this fork is install-dgl-nh500, which does what it says on the tin. -It will fetch, compile, and install nethack 5.0.0, and do the same for DGL (although it is already fetched -by the time you're using the script), and put them into a chroot of your choosing. +The main feature of the master branch of this fork is install-dgl-nh500, which +does what it says on the tin. It will fetch, compile, and install +nethack 5.0.0, and do the same for DGL (although it is already fetched by the +time you're using the script), and put them into a chroot of your choosing. -autoconf branch is for making dgl's configure/makefile stuff work, without having to use these bash scripts -people have written over the years. +autoconf branch is for making dgl's configure/makefile stuff work, without +having to use these bash scripts people have written over the years. -I'm pretty interested in the history of this program -- so much so that I went through pains trying to make -sure I was forking a version of the repository that contained accurate commit hashes -- crawl's fork has -somehow mangled them such that its history appears entirely-unrelated to git. +I'm pretty interested in the history of this program -- so much so that I went +through pains trying to make sure I was forking a version of the repository +that contained accurate commit hashes -- crawl's fork has somehow mangled them +such that its history appears entirely-unrelated to git. Anyway, if you know anything of the history, reach out. @@ -156,13 +158,14 @@ will not see a shell when it exits. Congrats on your new server... -# Dungeon Crawl Stone Soup -First, though, here's how to install Dungeon Crawl Stone Soup: +# Hints +## Dungeon Crawl Stone Soup 1) obtain the source, navigate to that directory -2) `sudo make install prefix=/ DATADIR=/etc/dcss0341 SAVEDIR=/var/dcss0341 USE_DGAMELAUNCH=1` -Note: 2) instead of setting USE_DGAMELAUNCH, you can also edi -`/crawl-ref/source/AppHdr.h`, and `#define DGAMELAUNCH=1` there. (and tweak - other settings which interest you) +2) ... +```bash +sudo make install prefix=/ DATADIR=/etc/dcss0341 \ +SAVEDIR=/var/dcss0341 USE_DGAMELAUNCH=1 +``` 3) navigate to the directory with these scripts (dgamelaunch source dir) 4) ... ```bash @@ -170,7 +173,8 @@ Note: 2) instead of setting USE_DGAMELAUNCH, you can also edi sudo cp /etc/dcss0341 /opt/dgamelaunch/etc/ sudo cp /var/dcss0341 /opt/dgamelaunch/var/ ``` -5) (clean up in `/bin/crawl`, `/etc/dcss0341`, `/var/dcss0341` if you want to; don't need those files anymore) +5) (clean up in `/bin/crawl`, `/etc/dcss0341`, `/var/dcss0341` if you want to; +don't need those files anymore) 6) Modify `dgamelaunch.conf` to uncomment relevant lines 7) ... ```bash @@ -179,7 +183,19 @@ sudo chown -R games:games /opt/dgamelaunch/var ``` 8) Modify the main menu (it might help to `dcss-menu.patch` to it) -That's it! +## Angband +1) obtain source, navigate to the directory +2) ... +```bash +./configure --prefix=/. --bindir=/bin --datarootdir=/var --with-gamedata-in-lib +``` +3) `make DESTDIR=/opt/dgamelaunch install` +4) Try out `cpbin`, with `--libs-only`, to see if you can just automagically +transfer libraries +4a) otherwise do it by hand, check out the `ldd` command and other parts of +this readme for more. +5) Uncomment relevant lines in dgamelaunch.conf, and make/chown the inprogress +dir # Resources More resources for troubleshooting vis NetHack: diff --git a/README.bak b/doc/README.bak similarity index 100% rename from README.bak rename to doc/README.bak diff --git a/dgamelaunch.8 b/doc/dgamelaunch.8 similarity index 100% rename from dgamelaunch.8 rename to doc/dgamelaunch.8 diff --git a/doc/history.md b/doc/history.md new file mode 100644 index 0000000..3d29394 --- /dev/null +++ b/doc/history.md @@ -0,0 +1,16 @@ +# History +This is not an exhaustive or particularly-well-researched history, but I felt a desire to put it all in one place. Both what _very_ little I know about the history of the thing itself, and a bit about the git repo's history since I have direct access to that. + +I find git histories pretty interesting in general. I kind of botched this one at first, ngl. A reckless fast-forward and there's all this junk. But anyway, here's what I know. + +## Origin +``` + dgamelaunch is copyright (C) 2001-2003 M. Drew Streib + also parts (C) 2003-4 Joshua Kwan , + Brett Carrington , + Jilles Tjoelker +``` + +I have done no research here except to know that there's nothing of the original original repos around on a cursory search. + +## paxed diff --git a/doc/wiki b/doc/wiki new file mode 160000 index 0000000..c31b532 --- /dev/null +++ b/doc/wiki @@ -0,0 +1 @@ +Subproject commit c31b532862ffb7e1d964b25ea088dfe6527a58b4 -- 2.47.3