diff --git a/docs/Plugins.rst b/docs/Plugins.rst index 54bb5213e..24dd90c43 100644 --- a/docs/Plugins.rst +++ b/docs/Plugins.rst @@ -52,7 +52,7 @@ Options (If only region and name are given, export all): :place: Export stockpile commands to "-place.csv" :query: Export query commands to "-query.csv" -Goes very well with `fortplan`, for re-importing. +Goes very well with `quickfort`, for re-importing. .. _remotefortressreader: @@ -2355,8 +2355,12 @@ fortplan ======== Usage: ``fortplan [filename]`` +**Fortplan is deprecated.** Please use DFHack's more powerful `quickfort` +command instead. You can use your existing .csv files. Just move them to the +``blueprints`` folder in your DF installation, and instead of ``fortplan file.csv`` run ``quickfort run file.csv``. + Designates furniture for building according to a ``.csv`` file with -quickfort-style syntax. Companion to `digfort`. +quickfort-style syntax. The first line of the file must contain the following:: diff --git a/docs/changelog.txt b/docs/changelog.txt index 3cf180c23..3d327981d 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -33,6 +33,9 @@ changelog.txt uses a syntax similar to RST, with a few special sequences: # Future +## Documentation +- `fortplan`: fortplan has been replaced by `quickfort`. add deprecation warnings to command output and documentation. + # 0.47.05-beta1 ## Fixes diff --git a/plugins/fortplan.cpp b/plugins/fortplan.cpp index 3eca32c50..969c67d20 100644 --- a/plugins/fortplan.cpp +++ b/plugins/fortplan.cpp @@ -1,3 +1,8 @@ +/* + * Fortplan is deprecated. All functionality has moved to the DFHack quickfort + * script. Fortplan will be removed in a future DFHack release. + */ + #include #include @@ -194,8 +199,10 @@ std::vector> tokenizeFile(std::string filename) { } command_result fortplan(color_ostream &out, vector & params) { - auto & con = out; + con.print("Fortplan is deprecated. Please use DFHack's quickfort command" + " instead. Fortplan will be removed in a future DFHack release.\n"); + std::vector> layout(128, std::vector(128)); if (params.size()) { coord32_t cursor;