Go Back   Angband Forums > Angband > Development

Thread Tools Display Modes
Old December 26, 2019, 02:04   #1
Join Date: Jan 2011
Posts: 53
fruviad is on a distinguished road
Is there anything more up-to-date than the how-it-works documentation?

I found some interesting information in the "how-it-works" file, found under /docs/hacking, and also at:

Then I realized that this documentation is referring the reader to files that were removed back in 2015 (e.g. dungeon.c).

Are the broad outlines of that doc still valid, or should it be ignored completely? Is there an updated document that one should focus on, instead?
fruviad is offline   Reply With Quote
Old December 26, 2019, 02:22   #2
Vanilla maintainer
Nick's Avatar
Join Date: Apr 2007
Location: Canberra, Australia
Age: 55
Posts: 8,669
Donated: $60
Nick will become famous soon enough
The information in that file is not too bad as far as it goes, but it is massively incomplete and some of the detail (like dungeon.c - now essentially replaced with game-world.c) is incorrect.

There is not really a better document, either - unless you regard the source files themselves as documentation

Sadly, documentation always takes third place to bug-fixing and feature implementation. I have filed it as something to do in 4.2.x.
One for the Dark Lord on his dark throne
In the Land of Mordor where the Shadows lie.
Nick is offline   Reply With Quote
Old January 11, 2020, 02:32   #3
Join Date: Jan 2020
Posts: 1
RicardoGz2019 is on a distinguished road
how unfortunate
RicardoGz2019 is offline   Reply With Quote
Old January 11, 2020, 05:25   #4
Pete Mack
Join Date: Apr 2007
Location: Seattle, WA
Posts: 5,999
Donated: $40
Pete Mack is on a distinguished road
Ricardo--that document wasn't ever worth much. The comments at the beginning of the c files (when present) tend to be better. You are better off firing up a debug build and watching the control flow. Or just reading code.
Pete Mack is offline   Reply With Quote

Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)
Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
prf documentation tumbleweed Vanilla 24 June 20, 2015 17:39
Out of Date Artefact descriptions Ed_47569 Vanilla 4 November 15, 2012 14:02
Keymap documentation? Timo Pietilš Development 11 June 2, 2011 17:46
[FA] Give me a date ! Arralen Variants 5 April 6, 2009 02:33
[Un] Restuffing the documentation Bandobras Variants 39 March 2, 2008 07:02

All times are GMT +1. The time now is 08:23.

Powered by vBulletin® Version 3.8.11
Copyright ©2000 - 2021, vBulletin Solutions Inc.