minor updates in readme.rst; moved changelayer plugin to main plugin folder

develop
Robert Heinrich 2012-03-27 17:28:10 +08:00 committed by Petr Mrázek
parent 515a4467e8
commit cebdbff46d
4 changed files with 31 additions and 62 deletions

@ -110,9 +110,10 @@ tl;dr: You will end up with changing quite big areas in one go, especially if yo
Options
-------
:all_biomes: Change layer for all biomes on your map.
:all_biomes: Change selected layer for all biomes on your map.
Result may be undesirable since the same layer can AND WILL be on different z-levels for different biomes. Use the tool 'probe' to get an idea how layers and biomes are distributed on your map.
:all_layers: Change all layers on your map. Candy mountain, anyone? Will make your map quite boring, but tidy.
:all_layers: Change all layers on your map (only for the selected biome unless 'all_biomes' is added).
Candy mountain, anyone? Will make your map quite boring, but tidy.
:force: Allow changing stone to soil and vice versa. !!THIS CAN HAVE WEIRD EFFECTS, USE WITH CARE!!
Note that soil will not be magically replaced with stone. You will, however, get a stone floor after digging so it will allow the floor to be engraved.
Note that stone will not be magically replaced with soil. You will, however, get a soil floor after digging so it could be helpful for creating farm plots on maps with no soil.
@ -121,23 +122,27 @@ Options
Examples:
---------
``changelayer GRANITE`` : Convert layer at cursor position into granite.
``changelayer SILTY_CLAY force`` : Convert layer at cursor position into clay even if it's stone.
``changelayer MARBLE all_biomes all_layers`` : Convert all layers of all biomes which are not soil into marble.
``changelayer GRANITE``
Convert layer at cursor position into granite.
``changelayer SILTY_CLAY force``
Convert layer at cursor position into clay even if it's stone.
``changelayer MARBLE all_biomes all_layers``
Convert all layers of all biomes which are not soil into marble.
.. note::
.. Notes::
* If you use changelayer and nothing happens, try to pause/unpause the game for a while and try to move the cursor to another tile.
* If you use changelayer and nothing happens, try to pause/unpause the game for a while and try to move the cursor to another tile. Then try again. If that doesn't help try temporarily changing some other layer, undo your changes and try again for the layer you want to change. Saving and reloading your map might also help.
* You should be fine if you only change single layers without the use of 'force'. Still it's advisable to save your game before messing with the map.
* When you force changelayer to convert soil to stone you might experience weird stuff (flashing tiles, tiles changed all over the map, ...). Try reverting the changes manually or even better use an older savegame. You did save your game, right?
* When you force changelayer to convert soil to stone you might experience weird stuff (flashing tiles, tiles changed all over place etc). Try reverting the changes manually or even better use an older savegame. You did save your game, right?
changevein
==========
Changes material of the vein under cursor to the specified inorganic RAW material.
Example:
---------
``changevein NATIVE_PLATINUM`` : Convert vein at cursor position into platinum ore.
--------
``changevein NATIVE_PLATINUM``
Convert vein at cursor position into platinum ore.
cursecheck
==========
@ -157,14 +162,10 @@ Options
Examples:
---------
Check one single map tile if one of the creatures on it is cursed (in-game cursor required):
* cursecheck
Count all active cursed creatures who roam around on your map (no in-game cursor) without giving more details:
* cursecheck
Give detailed info about all cursed creatures including deceased ones (no in-game cursor):
* cursecheck detail all
Give a nickname all living/active cursed creatures on the map(no in-game cursor):
* cursecheck nick
``cursecheck detail all``
Give detailed info about all cursed creatures including deceased ones (no in-game cursor).
``cursecheck nick``
Give a nickname all living/active cursed creatures on the map(no in-game cursor).
.. note::

@ -90,6 +90,7 @@ if (BUILD_SUPPORTED)
DFHACK_PLUGIN(fixpositions fixpositions.cpp)
DFHACK_PLUGIN(follow follow.cpp)
DFHACK_PLUGIN(changevein changevein.cpp)
DFHACK_PLUGIN(changelayer changelayer.cpp)
DFHACK_PLUGIN(advtools advtools.cpp)
DFHACK_PLUGIN(tweak tweak.cpp)
DFHACK_PLUGIN(feature feature.cpp)
@ -104,10 +105,3 @@ OPTION(BUILD_SKELETON "Build the skeleton plugin." OFF)
if(BUILD_SKELETON)
add_subdirectory(skeleton)
endif()
# this is the changelayer plugin.
OPTION(BUILD_CHANGELAYER "Build the changelayer plugin." ON)
if(BUILD_CHANGELAYER)
add_subdirectory(changelayer)
endif()

@ -71,7 +71,9 @@ const string changelayer_help =
const string changelayer_trouble =
"Known problems with changelayer:\n\n"
" Nothing happens, the material stays the old.\n"
" Try pausing/unpausing the game or moving the cursor a bit.\n\n"
" Pause/unpause the game and/or move the cursor a bit. Then retry.\n"
" Try changing another layer, undo the changes and try again.\n"
" Try saving and loading the game.\n\n"
" Weird stuff happening after using the 'force' option.\n"
" Change former stone layers back to stone, soil back to soil.\n"
" If in doubt, use the 'probe' tool to find tiles with soil walls\n"
@ -221,7 +223,7 @@ command_result changelayer (color_ostream &out, std::vector <std::string> & para
// 2) call ReadGeology here, modify the data in the vectors without having to do all that map stuff
// 3) write Maps::WriteGeology, pass the vectors, let it do it's work
// Step 1) is optional, but it would make implementing 3) easier.
// Otherwise that "check which geolayer is used by biome X" loop would need to be done again.
// Otherwise that "check which geo_index is used by biome X" loop would need to be done again.
// no need to touch the same geology more than once
// though it wouldn't matter much since there is not much data to be processed
@ -291,7 +293,7 @@ command_result changelayer (color_ostream &out, std::vector <std::string> & para
vector <df::world_geo_layer*> &geolayers = geo_biome->layers;
// complain if layer is out of range
// geology has up to 16 layers currently, but size can be < 15 sometimes!
// geology has up to 16 layers currently, but can have less!
if(layer >= geolayers.size() || layer < 0)
{
if(verbose)
@ -379,7 +381,10 @@ bool conversionAllowed(color_ostream &out, MaterialInfo mat_new, MaterialInfo ma
{
if(force)
{
out << "You've been warned, good luck." << endl;
if(!warned)
{
out << "You've been warned, good luck." << endl;
}
allowed = true;
}
else
@ -389,10 +394,11 @@ bool conversionAllowed(color_ostream &out, MaterialInfo mat_new, MaterialInfo ma
out << "Use the option 'force' if you REALLY want to do that." << endl
<< "Weird things can happen with your map, so save your game before trying!" << endl
<< "Example: 'changelayer GRANITE force'" << endl;
warned = true;
}
allowed = false;
}
// avoid multiple warnings for the same stuff
warned = true;
}
return allowed;
}

@ -1,32 +0,0 @@
PROJECT (changelayer)
# A list of source files
SET(PROJECT_SRCS
changelayer.cpp
)
# A list of headers
SET(PROJECT_HDRS
)
SET_SOURCE_FILES_PROPERTIES( ${PROJECT_HDRS} PROPERTIES HEADER_FILE_ONLY TRUE)
# mash them together (headers are marked as headers and nothing will try to compile them)
LIST(APPEND PROJECT_SRCS ${PROJECT_HDRS})
# option to use a thread for no particular reason
OPTION(CHANGELAYER_THREAD "Use threads in the changelayer plugin." ON)
#linux
IF(UNIX)
add_definitions(-DLINUX_BUILD)
SET(PROJECT_LIBS
# add any extra linux libs here
${PROJECT_LIBS}
)
# windows
ELSE(UNIX)
SET(PROJECT_LIBS
# add any extra linux libs here
${PROJECT_LIBS}
$(NOINHERIT)
)
ENDIF(UNIX)
# this makes sure all the stuff is put in proper places and linked to dfhack
DFHACK_PLUGIN(changelayer ${PROJECT_SRCS} LINK_LIBRARIES ${PROJECT_LIBS})