minor gitignore additions
[summerhack] / README.md
1 Summerhack / The Lab
2 ====================
3 ![GNU/Linux build status](https://github.com/TheLabDemos/summerhack/actions/workflows/build_gnulinux.yml/badge.svg)
4 ![FreeBSD build status](https://github.com/TheLabDemos/summerhack/actions/workflows/build_freebsd.yml/badge.svg)
5
6 Summerhack was a short and sweet demo I've written during the summer of 2005
7 for a random on-line competition. Mainly it was a showcase of the 3D engine I
8 was writing back then with the help of Michael Georgoulopoulos: 3dengfx, and which was
9 hosted at: http://engfx3d.berlios.de (which has since gone off-line, see
10 archived: https://web.archive.org/web/20060210131739/http://engfx3d.berlios.de ).
11 You can find the last version of 3dengfx at: https://github.com/jtsiomb/3dengfx
12
13 ![screenshot](http://nuclear.mutantstargoat.com/sw/demos/shots/summerhack-thumb.jpg)
14
15 Pouet page: http://www.pouet.net/prod.php?which=18823
16
17 Release archive: http://nuclear.mutantstargoat.com/sw/demos/summerhack-thelab-repack.tar.gz
18
19 Video capture: https://www.youtube.com/watch?v=B9FuevPkDN8
20
21
22 Credits
23 -------
24  - Demo code: John Tsiombikas (Nuclear)
25  - 3D engine code: John Tsiombikas (Nuclear) and Michael Georgoulopoulos (Samurai)
26  - Sound code: Vasilis Vasaitis (Savvy)
27  - Music: Red Herring by Union Jack
28
29
30 Original readme file
31 --------------------
32 ```
33 Summer Hack / The Lab Demos
34 ---------------------------
35 Demo code: Nuclear
36 3d engine: Nuclear, Samurai
37 Sound sys: Savvy
38     Music: Tourmpadakis
39
40 Greets to everyone who watches this small demoish thingy.
41
42 About this thing...
43 Needs a video card that doesn't suck for fillrate. No shaders or other
44 high-end gimmicks are used this time.
45 Released under the GPL, do whatever you wish with it.
46
47 Contact info...
48 http://thelab.demoscene.gr - nuclear@siggraph.org
49 ```
50
51 Build instructions
52 ------------------
53 If you acquired the source code from the git repo, it does not include the
54 binary data files (images, 3D models, and music). Grab the data file archive
55 from: http://nuclear.mutantstargoat.com/sw/demos/summerhack-data.tar.gz and
56 extract it in the project root directory, so that you now have the `img`, `geom`
57 and `music` subdirectories in the `data` directory.
58
59 If you got the source code from a full release archive of the demo, the data
60 files are already there. Of course the release archive also contains
61 pre-compiled binaries for multiple platforms.
62
63 ### UNIX
64
65 The only dependencies are SDL 1.2 and OpenGL. After installing them, just type
66 `make` to build the demo. For example under Debian GNU/Linux:
67
68     sudo apt-get install libgl-dev libsdl1.2-dev
69     make
70
71 While on FreeBSD:
72
73     sudo pkg install mesa-libs sdl
74     gmake
75
76 ### Windows (MSVC)
77
78 The sticking point with compiling on windows, especially with MSVC, is how to
79 handle dependencies. OpenGL is not an issue, but SDL must be installed and the
80 compiler/linker needs to be informed of its location.
81
82 For new versions of MS Visual C++ (2015 or later), use vcpkg to install SDL 1.2.
83 It should work automatically.
84
85 For older versions of MSVC, download the pre-compiled SDL 1.2 package:
86 https://libsdl.org/release/SDL-devel-1.2.15-VC.zip
87 and unzip it in the libs directory of summerhack (so that the directory
88 `libs\SDL-1.2.15` exists).
89
90 Once SDL is taken care of, simply open the `summerhack.sln` project and hit F7
91 (Build->Build Solution).
92
93
94 ### MacOS X
95
96 TODO