Modern reimplementation of the Diablo 1 game engine
C++ CMake Other
Switch branches/tags
Clone or download
wheybags Merge pull request #373 from akuskis/fix_read_me
fixed explanation of building process in readme.md
Latest commit c15534a Jul 12, 2018

readme.md

Join the chat at https://gitter.im/freeablo/Lobby Build Status Build status

Hello my friend, stay a while and listen!

freeablo is a modern cross platform reimplementation of the game engine used in Diablo 1. As it is just an engine, you will need the original data files to play the game.

Currently, you can run around town, players and NPCs animate, and you can go down into the first few levels of the dungeon (which is randomly generated), and a couple of other things. This is just a base for a game so far, so if you can help, please see the contributing section below!

There is a website at http://freeablo.org

Installation

Build the engine yourself (instructions below), or grab a prebuilt binary for your platform from https://github.com/wheybags/freeablo/releases

Copy DIABDAT.MPQ and Diablo.exe from your diablo install into the folder with the freeablo executable. (NOTE: only version 1.09 of diablo is currently supported, so please patch to that version)

Controls

Mouse to walk around, just like the original, and click on doors to open them.

PgUp and PgDn keys will move up / down through dungeon levels.

n will turn off collision (player will be able to walk through walls).

q to quit

esc to open pause menu

The above will all be made configurable at some point.

Documentation

https://wheybags.github.io/freeablo

decisions.md contains a list of significant decisions taken over the project's lifetime.

Compilation

freeablo uses cmake and a c++ package manager called hunter, so it should be as simple as just compiling it like any normal cmake project. During the intitial run of cmake, some third-party dependencies will be downloaded and compiled. They can take a while, but they will be cached in ~/.hunter (C:\.hunter on windows) afterwards, so you should only have to do that once.

Detailed instructions

Get the source:

via git:

git clone https://github.com/wheybags/freeablo.git

or download from https://github.com/wheybags/freeablo/releases.

make a build directory:

cd freeablo
mkdir build
cd build

symlink the resources folder (linux/unix):

ln -s ../resources

symlink the resources folder (windows):

mklink /j resources ..\resources

call cmake:

cmake ..

Now you're ready to go, cmake has generated a makefile/vs solution, just run make/open in vs to compile.

Contributing

Have a look at the github issue tracker for something to do, send a pull request, and I'll probably accept it. Having dabbled a bit in OpenMW (http://openmw.org), I have decided to use their coding standards for this project, which you can see here: https://wiki.openmw.org/index.php?title=Policies_and_Standards

Bug reports

Please feel free to submit bug reports on the github issue tracker at https://github.com/wheybags/freeablo/issues

Changelog

v0.3 [5 Aug 2015]

  • Bugfix - monsters spawn on level stairs #112
  • Threading refactor #107
  • Hotkey selection GUI #106
  • level 3 dungeon generation #103
  • UI chroma key transparency #96
  • UI animation #95
  • Bugfix - gui clicks register as movement clicks #88
  • Initial version of launcher #33
  • sound #26
  • better celview gui #134
  • Bugfix - music memory leak #111
  • Bugfix - exit when DIABDAT.MPQ not found #114, #115

v0.2 [3 Dec 2014]

  • Bugfix - MPQ filename case sensitivity #78, #76
  • Bugfix - Deadlock on caertain command line args
  • Bugfix - Player-npc clipping #97
  • Bugfix - Reading freed memory in FAIO 6f098b1
  • Config File parsing #81
  • LibRocket Gui framework #82, #86
  • Improved CEL rendering #85, #91
  • Inventory and char menu placeholders #86
  • Pause menu #90
  • Main menu #94
  • Keybinding configuration framework #98
  • Music #99
  • SDL1 support removed d4da725
  • Dungeon level 2 generation #93

v0.1 [24 Apr 2014]

  • CEL / CL2 decoding
  • Level rendering
  • Level Generation
  • Level switching
  • Town NPCS
  • Mouse movement
  • Animation
  • Doors
  • Basic collision