Print

Please login or register.
1 Hour 1 Day 1 Week 1 Month Forever
Login with username, password and session length

[Dirst]

Accessibility utility
Version 1.04
By Dirst

Download from DFFD
Discussion thread
Backup location

A set of simple commands for the DFHack console to aid in navigating the map, suitable for DF 0.42 and 0.43.  Comments and suggestions are welcome.  The current version includes four DFHack scripts.

Installation is simple.  Unzip Accessibility.zip onto your Dwarf Fortress folder.

access.lua
This script prints instructions for using the Accessibility utility.

access
General instructions are printed if "access" is typed alone.

access help
More detailed documentation is available by typing "access help".

bookmark.lua
This script defines, updates and deletes persistent bookmarks on the map.

bookmark help
Prints a short summary of the bookmark comamands.

bookmark list
Lists all current bookmarks, if any.

bookmark drop foo
Deletes a bookmark named foo.

bookmark clear all
Deletes ALL bookmarks.  Note the space between "clear" and "all" as a safety feature.

bookmark foo
Creates or updates the bookmark named foo at the current cursor location.  If the cursor is not present, the bookmark will be set as the center of the on-screen map.

goto.lua
This script will move the map (and cursor if it is present) to a specific location.  The goto script has two modes: bookmark and coordinates.

goto help
Prints a short summary of the goto commands.

goto foo
Moves the map to the bookmark named foo, if it exists.

goto # # #
Moves the map to the specified X, Y, Z coordinates.

whereami.lua
This script reports your current location as X, Y, Z coordinates and a very terse description of the tile such as "SOIL WALL" or "POOL FLOOR".
whereami will also report if the current location is recorded as a bookmark.

Known issues:
Bookmarks saved with version 1.00 (if you somehow acquired it) have incorrect Z coordinates.
Screen center is incorrect if the Text Will Be Text plugin is active, although the cursor location is accurate.

[Abadrausar]

Always wished to have that!

Thanks!!!

Already included it in your modder dir inside HDFPS as a developper addon ("LoadPriority": 3100 and "Dev": true) normal playable addons like The Earth Strikes Back! have instead  ("LoadPriority": 1100 and "Dev": false) and are always visible after generation without clicking over the dev button.
Then when you click over generate raws you have:

Spoiler (click to show/hide)

_________________________________________   _______________________________Composable_Base_or_Total_mods______________________________________
Toady_One___Vanilla   Toady One Vanilla base raw files, rubble porting by Abadrausar, able of fine grained imports.
Abadrausar___Haiku_Extreme   DF in 41 active Vanilla objects with only 6 modified and all the features.
Abadrausar___Haiku_Vanilla   DF in 65 active Vanilla objects without any modification and all the features.
Abadrausar___Singularity   The entire multiverse is collapsing into a single singular world.
Button___Modest   Collection of vital Vanilla bugfixes and tweaks that everyone should be able to use comfortably and without reservation.
Dirst___The_earth_strikes_back   Any miner knows that the surest way to prosperity is to strike the earth. Wise miners know that sometimes the earth strikes back.
GM-X___Dark_Age_II   Dark Age has fallen upon the world of Dwarf Fortress.
IndigoFenix___Rise_of_the_Mushroom_Kingdom   Rise of the Mushroom Kingdom
Lovechild___All_races_playable   You can play as Vanilla dwarf, elf, human, goblin, kobold, or animalpeople.
Milo___First_Landing   SCI Themed 4x, explore and colonize foreign planets.
Putnam___Sparking   Complete dragonball lore.
Rhenaya___Drow   Drow civilization and lore.
__________________________________________   ______________________________Not_Composable_Base_or_Total_mods________________________________
Milo___First_Landing_FINAL   Makes First Landing final, incompatible with other bases because it removes candy and anticandy.
Select All None
Hide/Show DFHack - Dev +
Edit configuration variables Skip
Back to Menu

And clicking over Dev button you have:

Spoiler (click to show/hide)

_________________________________________   _______________________________Composable_Base_or_Total_mods______________________________________
Toady_One___Vanilla   Toady One Vanilla base raw files, rubble porting by Abadrausar, able of fine grained imports.
Abadrausar___Haiku_Extreme   DF in 41 active Vanilla objects with only 6 modified and all the features.
Abadrausar___Haiku_Vanilla   DF in 65 active Vanilla objects without any modification and all the features.
Abadrausar___Singularity   The entire multiverse is collapsing into a single singular world.
Button___Modest   Collection of vital Vanilla bugfixes and tweaks that everyone should be able to use comfortably and without reservation.
Dirst___The_earth_strikes_back   Any miner knows that the surest way to prosperity is to strike the earth. Wise miners know that sometimes the earth strikes back.
GM-X___Dark_Age_II   Dark Age has fallen upon the world of Dwarf Fortress.
IndigoFenix___Rise_of_the_Mushroom_Kingdom   Rise of the Mushroom Kingdom
Lovechild___All_races_playable   You can play as Vanilla dwarf, elf, human, goblin, kobold, or animalpeople.
Milo___First_Landing   SCI Themed 4x, explore and colonize foreign planets.
Putnam___Sparking   Complete dragonball lore.
Rhenaya___Drow   Drow civilization and lore.
__________________________________________   ______________________________Not_Composable_Base_or_Total_mods________________________________
Milo___First_Landing_FINAL   Makes First Landing final, incompatible with other bases because it removes candy and anticandy.
____________________________________________   ______________________________Modders_Toolbox________________________________________________
_Porting___Raws_to_Rubble   Adds SHARED_OBJECT tags to non-Rubble raws, semiautomatic only.
Abadrausar_No_more_animalpeople   Removes all animalpeople from active game, they will appears only in engravings and legends.
Abadrausar_No_multicivs   Removes all creatures from subterranean entity except AMPHIBIAN_MAN
Abadrausar___All_year_around_subterranean_crops   Subterranean crops are growable all year around.
Abadrausar___Bigger_containers   A wellbarrow can contain 2 pots, bins or barrels, and a minecart 10, and all of them at least tenfold more than vanilla.
Abadrausar___Circular_kitchen   You can dry low quality meals into flour and recook it again.
Abadrausar___Circular_kitchen2   you can dry low quality meals into flour and recook it again.
Abadrausar___Intensive_sprouting   Subterranean crops as Intensives or Sproutings.
Abadrausar___More_fishables   More ubiquitous fishable artificial hiveables.
Abadrausar___No_more_giants   Removes all giants from active game, they will appears only in engravings and legends.
Abadrausar___No_more_ubiquitous   Removes all ubiquitous vermin from all biomes.
Bisasam___Tileset   A simple addon that installs antialiased 20x20 pure ASCII-like Bisasam�s tileset.
Dirst___Accessibility   A set of simple commands for the DFHack console to aid in navigating the map. Comments and suggestions are welcome.
IndigoFenix___Mostly_mythical_monsters   Mostly mythical monsters
Kazoo___Silk_eggs   Some Spider egg shells are made of SILK,-> regular farming of silk with nest boxes.
Milo___Cheat_Reactions   A bunch of cheat reactions to allow for fast setup of testing forts.
Milo___Dummy_Reactions   Empty reactions registered to ADDON_HOOK_PLAYABLE.
Milo___Dummy_Workshops   How many dummy workshops should be generated?
Milo___Generic_Materials   Support for the Generic Animal Materials.
Milo___Graphics_Defense   Activate to keep Rubble from nuking your creature graphics.
Milo___Pop_Cap   Allows you to set a population cap that will override the default for this world.
Milo___Rubblize_Raws   Adds SHARED_OBJECT tags to non-Rubble raws, semiautomatic only.
Putnam___Materials_Plus   Adds a bunch of materials to the game.
Putnam___Microreduce   A mod that adds a few random secrets and curses that didn’t fit in any of my existing mods.
Putnam___Secrets_n_Curses   A mod that adds a few random secrets and curses that didn’t fit in any of my existing mods.
Uncle_Span___Leathery_Vegetables   Huskshroom and Leather-leaf, plants that gives you skin to tan or leather ready leafs
Uncle_Span___Tileset   Uncle Span tileset.
Wannabehero___Deep_Dwarven_Domestication   Diverse and thematic domestic animals. It also enables generic honey, the use of nail as a kind of horn, chitin as shell and feathers as pearls.
Yobbo___Tileset   A simple addon that installs Yobbo modification of antialiased 20x20 pure ASCII-like Bisasam�s tileset.
Intensive subterranean sprouting2.   Intensive subterranean sprouting.
Intensive subterranean sprouting3.   Intensive subterranean sprouting.
_____________________________________________   _______________________________Tutorials___________________________________________________
______________________________________________   _______________________________Tests______________________________________________________
Test/ISS   Intensive subterranean sprouting.
Test/ISS2   Intensive subterranean sprouting.
Test/IntensiveSprouting   some testing3.
Test/test01   some testing.
Test/test02   some testing2.
Test/test03   Intensive subterranean sprouting.
Test/test04   some testing 4.
Test/test05   Intensive subterranean sprouting.
Test/test06   test6
Test/test07   test6
Test/test08   test8
Test/test09   test9
Test/test10   test
Test/test11   test
Test/test12   test
Test/test13   test
Test/test14   test
Test/test15   test
Select All None
Hide/Show DFHack - Dev -
Edit configuration variables Skip
Back to Menu

I am an absolute lua noob here, so I am assuming that if I rename (bookmark.lua, goto.lua and whereami.lua) into (ACCESSIBILITY_bookmark.dfcom.lua, ACCESSIBILITY_goto.dfcom.lua and ACCESSIBILITY_whereami.dfcom.lua) the ACCESSIBILITY_ namespace part will not break the lua lib functionality.
Is it that true?

Argh! the calling namescript changes and is too verbose, reverted to your original defaults...

Spoiler (click to show/hide)

{"Tags": {"Library": false, "DocPack": false, "TileSet": false, "HasTests": false, "SaveSafe": false, "DFHack": true, "Dev": true, "NotNormal": false},
   "LoadPriority": 3100, "Name": "Dirst___Accessibility", "Version": "1.01", "Author": "Dirst", "Header": "A set of simple commands for the DFHack console to aid in navigating the map. Comments and suggestions are welcome.",
   "DescFile": "addon.md",
   "Activates": [
      "Libs/Base",
      "ACCESSIBILITY"],
"Vars": {
   "TESB_LIVING_STONE": {
      "Name": "Living Stone",
      "Values": [ "COMMON", "RARE", "NEVER" ]
      },
   "TESB_HIDDEN_GEMS": {
      "Name": "Hidden Gems",
      "Values": [ "COMMON", "RARE", "NEVER" ]
      # Setting this to NEVER will also convert Wyrm eyes to common gems.
      },
   "TESB_PET_ROCKS": {
      "Name": "Pet Rocks",
      "Values": [ "YES", "NO" ]
      # Independent of Living Stone setting.
      },
   "TESB_PLANTS": {
      "Name": "Gem Vines",
      "Values": [ "YES", "NO" ]
      # Suppressed if Hidden Gems are set to NEVER.
      },
   "TESB_SECRETS": {
      "Name": "Secrets",
      "Values": [ "YES", "NO" ]
      },
   "USE_GRAPHICS": {
      "Name": "Creature Graphics",
      "Values": [ "YES", "NO" ]
      }
   }
}

Finally the addon.md

Spoiler (click to show/hide)

[Addon Change log](/addonfile?addon=Dirst___Accessibility&file=addon_changes.md)
## So you think that you need some help, want to do a sugestion, inform about a bug or give thanks to modders or developpers, but not sure where to go.
1. If you want to patronize Toady One and the developpment of Dwarf Fortress go to: [Support Dwarf Fortress Vanilla](http://www.bay12games.com/support.html)
2. For questions about the rubble framework go to: [Rubble framework](http://www.bay12forums.com/smf/index.php?topic=154304.0)
3. Anything about HDFPS: Humble Dwarf Fortress Publishing System is there [HDFPS](http://www.bay12forums.com/smf/index.php?topic=157300.0)
4. If your question is addressed to the actual original maintainer of this mod then you have [Accessibility](http://www.bay12forums.com/smf/index.php?topic=157631.msg6941343#msg6941343)

# A set of simple commands for the DFHack console to aid in navigating the map. Comments and suggestions are welcome. The current version includes three DFHack scripts.

Installation is simple. Unzip Accessibility.zip onto your Dwarf Fortress folder.
# bookmark.lua
This script defines, updates and deletes persistent bookmarks on the map.

bookmark help
Prints a short summary of the bookmark comamands.

bookmark list
Lists all current bookmarks, if any.

bookmark drop foo
Deletes a bookmark named foo.

bookmark clear all
Deletes ALL bookmarks. Note the space between "clear" and "all" as a safety feature.

bookmark foo
Creates or updates the bookmark named foo at the current cursor location. If the cursor is not present, the bookmark will be set as the center of the on-screen map.
# goto.lua
This script will move the map (and cursor if it is present) to a specific location. The goto script has two modes: bookmark and coordinates.

goto help
Prints a short summary of the goto commands.

goto foo
Moves the map to the bookmark named foo, if it exists.

goto # # #
Moves the map to the specified X, Y, Z coordinates.
# whereami.lua
This script reports your current location as X, Y, Z coordinates. whereami will also report if the current location is recorded as a bookmark.

Known issues:
Bookmarks saved with version 1.00 (if you somehow acquired it) have incorrect Z coordinates.

[Dirst]

For those of you wondering what that whirlwind of jargon was, Abadrausar has been compiling an extensive collection of mods for use in the Rubble system.  Rubble is a great tool for mixing and matching mods, but a tad overpowered for this application.  If you use Rubble (and people do download the Rubble version of my other mod), by all means use the Rubble module that Abadrausar made.  If not, use the DFFD download link in the first post.

Ideally, this package will be useful and stable enough to get incorporated into the main DFHack distribution.

[Heretic]

I'm coding mostly on c++ and c# but idea looks great and scripts are mostly simple, so i will try to help if i would have time.
PTW, It's great!!!

[TheBiggerFish]

PTW'ing.

[Button]

PTW

[Dirst]

Version 1.02 has been posted.  whereami will now add a very terse description of the tile such as STONE FLOOR or AIR EMPTY or (HIDDEN).

This can be unzipped right on top of an existing install, even while the game is running.  Just remember to copy the files over to any existing saves you might have.

[Thundercraft]

This looks very useful. I'll have to try it out. I'm especially glad for the whereami script as I was looking for something like that.

BTW: Since this is a tool for navigating around maps and does not actually change the game itself, I believe it should be classified as a utility, rather than a mod. May I suggest moving this to the Utilities category of DFFD, to avoid confusion?

[Dirst]

This looks very useful. I'll have to try it out. I'm especially glad for the whereami script as I was looking for something like that.

BTW: Since this is a tool for navigating around maps and does not actually change the game itself, I believe it should be classified as a utility, rather than a mod. May I suggest moving this to the Utilities category of DFFD, to avoid confusion?

That's a really great idea... done

[Dirst]

Version 1.03 is up.  This one gives a meaningful error if you try to use it when no map happens to be loaded, and it now installs as a global set of scripts rather than being save-specific.

DFHack's search path gives save-specific scripts higher precedence, so the improved error handling will only work if you remove any v1.02 scripts from the raw/scripts folder.

[PeridexisErrant]

Please consider adding these to https://github.com/DFHack/scripts

[Dirst]

Please consider adding these to https://github.com/DFHack/scripts

Thanks PE, I apreciate that.

I don't use GitHub for any DF stuff to keep as solid a wall as possible between my DF and professional lives (I work in a regulated industry with more than its fair share of people with no sense of humor).  I am not at all against someone else uploading the scripts, but they would need built-in documentation for players who stumble upon them.

I've been working on that for v1.04, and anyone interested can peek at Accessibility_1_04_alpha.zip in Dropbox.  Still needs support for people who try the standard "command -help" syntax.  Once that is fixed and I've tested it to the "probably won't burn your house down" level of safety, 1.04 will get published on DFFD and announced here.

[PeridexisErrant]

About a month ago I improved support for in-script docs; see eg autolabor-artisans for an example.  https://github.com/DFHack/dfhack/issues/947 will further improve the situation.

[Dirst]

About a month ago I improved support for in-script docs; see eg autolabor-artisans for an example.  https://github.com/DFHack/dfhack/issues/947 will further improve the situation.

Was going for something a bit different.

bookmark -help
bookmark
Sets and manages persistent bookmarks on the map.
Enter bookmark foo to create a bookmark named foo at the current location.
Any one-word string may be used except the following reserved words:
bookmark help prints a command summary.
bookmark -help prints the same command summary.
bookmark list prints a list of existing bookmarks.
bookmark drop foo erases a bookmark named foo.
bookmark clear all erases all current bookmarks. Note the space between clear and all.

[PeridexisErrant]

Hmm, I see what you mean - semantic highlighting would be nice to have.  (I now want to see if this can be done for all docs based on existing markup...)

The advantage of dumping the raw reStructured text markup is it unifies all the documentation for scripts - comments in the file itself, the html docs, and console help.  FWIW, I've marked up a copy below as it would appear in the console / ready for copypasting.

Code: [Select]

-- then later print(helpstr) where apropriate
local helpstr = [====[

bookmark
========
Sets and manages persistent bookmarks on the map, for easier navigation
in Adventure mode.

Enter ``bookmark foo`` to create a bookmark named ``foo`` at the
current location.  Names may be any word or string of characters which
does not contain whitespace, and is not in the command list below.

:bookmark help:         (or ``-help``) prints this help text.
:bookmark *foo*:        creates a bookmark named *foo*
                        at the current location
:bookmark list:         prints a list of existing bookmarks.
:bookmark drop *foo*:   erases a bookmark named *foo*.
:bookmark clear all:    erases all current bookmarks.

This script is best used with the `goto` and `whereami` scripts.

]====]

I also added a note that it's for adventure mode, and cross-references at the bottom which will be linked in the html.