Skip to content

jayschwa/CatacombWebGL

Repository files navigation

Catacomb WebGL

Catacomb WebGL is a project that I worked on at the Recurse Center in 2017. Catacomb 3-D is a first-person shooter from the early 1990s that I used to play as a kid. I thought it would be fun to attempt to recreate it using WebGL.

The project is unfinished and unlikely to be completed. Shortly after my stint at the Recurse Center, I bought the rights to the original game series and have been working on modernizing the original code base.

Licensing

Source code is open sourced under the GPLv2 license. Data assets like art and sound are not open sourced (yet).

Setup

Prerequisites

You must have Node.js installed.

Setup

After cloning the repository, run npm install.

How to Run

npm start will run a local web server that serves built assets at http://localhost:8080.

How to Build

npm run dev will run a process that monitors the source code for changes and rebuilds the assets that get served.

Notes

The code builds on top of three.js, which is a JavaScript library that adds nicer abstractions over the low-level WebGL API. The project has many nice examples, and is probably one of the best starting points for dabbling in 3D graphics.

The original game's source code is open, but I didn't refer to it much during this project, except for learning how to extract the game's art and map assets to convert them to easier formats (e.g. PNG and JSON). http://www.shikadi.net/moddingwiki/Catacomb_3-D was also an invaluable resource.

About

Catacomb 3-D partially rebuilt with WebGL. Made at the Recurse Center.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published