Notes
The aim of this project is to organize and cross-reference a collection of notes related to the inner workings of the Diablo 1 game engine.
The notes are currently organized into the following categories.
- Functions: function declarations.
- Global variables (read-only): global variable declarations in the read-only data section.
- Global variables (read-write): global variable declarations in the read-write data section.
- Global variables (uninitialized): global variable declarations in the uninitialized data section.
- Structs: structure definitions.
- Enums: enumerate definitions.
- Storm ordinals: Storm.dll function declarations based on ordinal numbers.
- Variable naming conventions: variable naming convention based on context.
Online documentation
The collective notes of this repository are made available online at http://sanctuary.github.io/notes/
The online pages are generated by the Scripture tool, which produces searchable documentation of source code with type definitions cross-referenced from global variable and function declarations. A Git commit hook ensures that new updates to the notes repository are instantly mirrored to the online documentation pages.
Progress
| Category | Progess |
|---|---|
| Functions | |
| Global variables (read-only) | |
| Global variables (read-write) | |
| Global variables (uninitialized) | |
| Storm ordinals |
The README of each sub-project tracks the progress for each of its source files.
Contributing
Anyone interested in contributing to the project may do so in whichever way they desire. This may include:
- Provide ideas on how to better structure the information
- Point out mistakes or inconsistencies in the notes
- Improve the existing notes
- Add documentation for
- Improve the Scripture documentation generation tool.
- ...
Credits
None of this work would have been possible without Jarulf's Guide to Diablo and Hellfire, one of few truly amazing resources on the Internet.