sanctuary/notes

Name: notes

Owner: sanctuary

Description: Notes related to the inner workings of the Diablo 1 game engine.

Created: 2015-07-22 12:38:35.0

Updated: 2018-05-13 21:44:17.0

Pushed: 2018-05-13 21:47:15.0

Homepage: http://sanctuary.github.io/notes/

Size: 1681

Language: C

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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:

1. Provide ideas on how to better structure the information
2. Point out mistakes or inconsistencies in the notes
3. Improve the existing notes
4. Add documentation for
   • function declarations (e.g. drlg_l1_place_door: code, doc)
   • global variable declarations (e.g. items: code, doc)
   • structure definitions (e.g. Player: code, doc)
   • enumerate definitions (e.g. quest_level: code, doc)
5. Improve the Scripture documentation generation tool.
6. …

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.