DarkFO, a post-nuclear RPG remake (of Fallout 2)
Clone or download
Latest commit bdf5942 Aug 19, 2018
Permalink
Failed to load latest commit information.
lib Remove lodash Jan 22, 2018
lut Include criticalTables.json LUT Dec 19, 2017
maps merge devwork, pt 2 Jan 11, 2015
src Continue tightening up null checks Aug 19, 2018
.gitignore move TypeScript files to src/, add tsconfig.json Oct 27, 2015
LICENSE.txt Relicense, with permission from authors, under the terms of the Apach… Jul 27, 2014
README.md Update README Aug 19, 2018
colortest.html add some color look-up tables and fix colortest Nov 24, 2017
convertAudio.py add convertAudio.py Apr 23, 2015
convertMaps.py remove fo2map.py Jul 12, 2016
dat2.py dat2: add verbose option to dumpFiles Dec 6, 2015
exportImages.py exportImages(Par): use lowercase file extensions Oct 25, 2015
exportImagesPar.py exportImagesPar: refactor conversion code into convertAll Dec 6, 2015
exportPRO.py (buildPRO -> exportPRO) now writes one master map file Feb 11, 2017
fomap.py fomap: refactor export code into exportMap Dec 6, 2015
frmpixels.py Switch to pillow library, fix import errors Jan 31, 2017
hex_outline.png add hex grid overlay May 17, 2014
mpserv.py net: Support object movement Nov 27, 2017
pal.py pal: fix palette reading Mar 25, 2015
parseCritTable.py Move criticalTables.json to lut/ Dec 19, 2017
parseElevatorTable.py Move elevators.json to lut/ Dec 17, 2017
play.html Remove lodash Jan 22, 2018
proto.py proto: don't parse damage type in FO1 mode Sep 27, 2015
screenshot.png update README.md Dec 30, 2015
setup.py Move criticalTables.json to lut/ Dec 19, 2017
stitchWorldmap.py Switch to pillow library, fix import errors Jan 31, 2017
tsconfig.json Tighten up some null checks and definitions Aug 19, 2018
ui.css ui.css: Use px unit suffix, as per standard. Dec 23, 2017

README.md

DarkFO

A post-nuclear RPG remake

This is a modern reimplementation of the engine of the video game Fallout 2, as well as a personal research project into the feasibility of doing such.

It is written primarily in TypeScript and Python, and targets a modern (HTML 5) Web browser.

Status

DarkFO is not a complete remake at this time. A lot of core functionality works, but major parts are missing or need work.

If you're looking for documentation on how Fallout 2 works, or documentation on certain file formats, or just want some tools to work with them, this project will be useful to you as well.

Here is a very rough list of what is known to work:

  • Map loading
  • Walking, running
  • Talking to NPCs
  • Bartering
  • Some quests (a lot of the scripting works, majors quests can be completed)
  • Some party members
  • Some skills (lockpicking and repair, and some passive skills)
  • Sound (scripted sound effects, music; not hardcoded sound effects, yet)

Some features are more middle ground:

  • Combat works at an extremely basic level but not to a great degree (only the SMG and spear is really tested, you cannot swap ammo, etc.)
  • No equippable armor
  • The world map is rough and buggy, and on the area screens entrances are misplaced
  • Random encounters work, but not all of the setups are implemented
  • Lighting works, but has some minor bugs and inaccuracies. It is also particularly slow, especially outside of the WebGL backend.
  • Saving and loading is at an alpha stage: it works to a basic degree, but is missing some features and is not tested. As such, consider it experimental.
  • Some animations are off, particularly related to combat
  • Leveling up (including XP, leveling stats/skills, etc) partially works

Some features are not implemented at all:

  • The PipBoy map

and other minor features here and there.

If you'd like to contribute, those might be major parts to look into.

Installation

To use this, you'll need a few things:

  • A copy of Fallout 2 (already installed)

  • Python 2.7

  • Pillow (just pip install pillow)

  • NumPy (Windows binaries available here.)

  • The TypeScript compiler, installed via npm install -g typescript (you'll need node.js).

You'll need an HTTP server to run (despite being all static content) due to the way browsers sandbox requests. If you're comfortable with setting up nginx, lighttpd, or Apache, go for that. If not, a simple way is to use Python:

  • Python 2: python -m SimpleHTTPServer (Python 2 is already required anyway)
  • Python 3: python -m http.server

Alternatively, Firefox can load directly from file://.

Once you've got all that, you can start trying it out.

Open a command prompt inside the DarkFO directory, and then run:

python setup.py path/to/Fallout2/installation/directory

This will take a few minutes, it's unpacking the game archives and converting relevant game data into a format DarkFO can use.

NOTE: You may need to use python2 instead, as some Linux distributions package python as Python 3. Run python --version to check!

Then run tsc to compile the source code.

Browse to http://localhost/play.html?artemple (or whatever port you're using). If all went well, it should begin the game. If not, check the JavaScript console for errors.

Review src/config.ts for engine options. Be sure to re-compile if you change them.

OPTIONAL: If you want sound, run python convertAudio.py. You'll need the acm2wav tool (you can get it from No Mutants Allowed).

FAQ

  • Q: Why TypeScript? Why a browser?

    A: Everyone has a browser: it's a portable platform for running code with more features than people expect. There are other projects that use native code already... and are already seeing segfaults. :)

    The project started out in JavaScript and was ported to TypeScript as it was continuing to grow. TypeScript strikes an excellent balance between useful and safe.

  • Q: But why Python?

    A: Python is actually quite fast when written well, despite many peoples' expectations. It is very elegant and allows me to write backend code like file parsers and exporters with tiny code, very few troubles, and that I know is portable and safe.

  • Q: Why do I need acm2wav for sound?

    A: Because it hasn't been ported to Python yet. If you're willing to contribute, give it a shot: the original Pascal source code is available online.

    Additionally, FFmpeg might be able to transcode ACM audio, so give that a shot. (See #30.)

  • Q: Why convert all assets up front, why not load them directly?

    A: Because it would require more processing time to load them each time they're needed rather than having them already in a sane, modern format.

    By converting, for example, FRMs (a proprietary Interplay format) to PNGs (a ubiquitous, open modern format) we allow normal browsers or image viewers to open them, as well as edit them -- a huge win for modders. Other games or tools could take advantage of the new formats as well.

  • Q: Why do this at all?

    A: Why not? It's a fun project, and I love Fallout. Fallout 1 and 2 do not run particularly well on modern machines, even with engine hacks. They're also hard to mod -- I'd like to change that.

License

DarkFO is licensed under the terms of the Apache 2 license. See LICENSE.txt for the full license text.

Contributing

Contributions are welcome!

Testing is more than welcome: if you have issues running DarkFO, or if you find bugs, glitches, or other inaccuracies, please don't hesitate to file an issue on GitHub and/or contact the developers!

To contribute code, simply submit a pull request with your changes. Take care to write sensible commit messages, and if you want to change major parts of the code, please discuss it with other developers first (see the Contact section below). I apologize in advance for any injury sustained while reading the code. :)

Thanks!

Contact

If you have an issue, please file it in the GitHub issue tracker.