MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix compile, intro, scripts 

- script-syntax.py now exits with 1 instead of silently catching the
error if lua or ruby are missing
- index paths are absolute (from the repo root)
- less strong suggestion for third-party packs
- re-added lua-example and test-perlin doc
- corrected and clarified Compile some more
develop
PeridexisErrant 2015-11-06 16:58:58 +11:00
parent bc91928f8d
commit 193e71793a
6 changed files with 62 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs/Compile.rst
Unescape Escape View File

@ -14,17 +14,8 @@ and `install the latest release instead <installing>`.
How to get the code How to get the code
=================== ===================
DFHack doesn't have any kind of system of code snapshots in place, so you will have to DFHack doesn't have any kind of system of code snapshots in place, so you will have to
get code from the github repository using git. get code from the github repository using git. How to get git is described under
The code resides at https://github.com/DFHack/dfhack the instructions for each platform.
On Linux and OS X, having a ``git`` package installed is the minimal requirement (see below for OS X instructions),
but some sort of git gui or git integration for your favorite text editor/IDE will certainly help.
On Windows, you will need some sort of Windows port of git, or a GUI. Some examples:
* http://msysgit.github.io - this is a command line version of git for windows.
Most tutorials on git usage will apply.
* http://code.google.com/p/tortoisegit - this puts a pretty, graphical face on top of msysgit
To get the code:: To get the code::
@ -34,16 +25,14 @@ To get the code::
If your version of git does not support the ``--recursive`` flag, you will need to omit it and run If your version of git does not support the ``--recursive`` flag, you will need to omit it and run
``git submodule update --init`` after entering the dfhack directory. ``git submodule update --init`` after entering the dfhack directory.
If you want to get really involved with the development, create an account on If you want to get involved with the development, create an account on
Github, make a clone there and then use that as your remote repository instead. Github, make a clone there and then use that as your remote repository instead.
Detailed instructions are beyond the scope of this document. If you need help, We'd love that; join us on IRC (#dfhack channel on freenode) if you need help.
join us on IRC (#dfhack channel on freenode).
Build types Build types
=========== ===========
``cmake`` allows you to pick a build type by changing the ``cmake`` allows you to pick a build type by changing the ``CMAKE_BUILD_TYPE`` variable::
``CMAKE_BUILD_TYPE`` environment variable::
cmake .. -DCMAKE_BUILD_TYPE:string=BUILD_TYPE cmake .. -DCMAKE_BUILD_TYPE:string=BUILD_TYPE
@ -62,23 +51,25 @@ Dependencies
------------ ------------
DFHack is meant to be installed into an existing DF folder, so get one ready. DFHack is meant to be installed into an existing DF folder, so get one ready.
For building, you need a 32-bit version of GCC. For example, to build DFHack on We assume that any Linux platform will have ``git`` available.
a 64-bit distribution like Arch, you'll need the multilib development tools and libraries.
Alternatively, you might be able to use ``lxc`` to To build DFHack you need a 32-bit version of GCC. On 64-bit distributions
(which is most of them), this means you'll need the multilib development tools
and libraries. Alternatively, you might be able to use ``lxc`` to
:forums:`create a virtual 32-bit environment <139553.msg5435310#msg5435310>`. :forums:`create a virtual 32-bit environment <139553.msg5435310#msg5435310>`.
Before you can build anything, you'll also need ``cmake``. It is advisable to also get Before you can build anything, you'll also need ``cmake``. It is advisable to also get
``ccmake`` on distributions that split the cmake package into multiple parts. ``ccmake`` on distributions that split the cmake package into multiple parts.
You also need perl and the XML::LibXML and XML::LibXSLT perl packages (for the code generation parts). You also need perl and the XML::LibXML and XML::LibXSLT perl packages (for the code generation parts).
You should be able to find them in your distro repositories (on Arch linux You should be able to find them in your distro repositories.
``perl-xml-libxml`` and ``perl-xml-libxslt``) or through ``cpan``.
To build Stonesense, you'll also need OpenGL headers. * On Arch linux, ``perl-xml-libxml`` and ``perl-xml-libxslt`` (or through ``cpan``)
* On 64-bit Ubuntu, ``apt-get install zlib1g-dev:i386 libxml-libxml-perl libxml-libxslt-perl``.
* On 32-bit Ubuntu, ``apt-get install zlib1g-dev libxml-libxml-perl libxml-libxslt-perl``.
* Debian-derived distros should have similar requirements.
On 64-bit Ubuntu, ``apt-get install zlib1g-dev:i386 libxml-libxml-perl libxml-libxslt-perl``. To build Stonesense, you'll also need OpenGL headers.
On 32-bit Ubuntu, ``apt-get install zlib1g-dev libxml-libxml-perl libxml-libxslt-perl``.
Debian-derived distros should have similar requirements.
Build Build
@ -100,14 +91,12 @@ Alternatively, you can use ccmake instead of cmake::
make install make install
This will show a curses-based interface that lets you set all of the This will show a curses-based interface that lets you set all of the
extra options. extra options. You can also use a cmake-friendly IDE like KDevelop 4
or the cmake-gui program.
You can also use a cmake-friendly IDE like KDevelop 4 or the cmake-gui
program.
Incompatible libstdc++
The libstdc++ version bug ~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~
When compiling dfhack yourself, it builds against your system libc. When compiling dfhack yourself, it builds against your system libc.
When Dwarf Fortress runs, it uses a libstdc++ shipped with the binary, which When Dwarf Fortress runs, it uses a libstdc++ shipped with the binary, which
comes from GCC 4.5 and is incompatible with code compiled with newer GCC versions. comes from GCC 4.5 and is incompatible with code compiled with newer GCC versions.
@ -116,14 +105,12 @@ This manifests itself with the error message::
./libs/Dwarf_Fortress: /pathToDF/libs/libstdc++.so.6: version ./libs/Dwarf_Fortress: /pathToDF/libs/libstdc++.so.6: version
`GLIBCXX_3.4.15' not found (required by ./hack/libdfhack.so) `GLIBCXX_3.4.15' not found (required by ./hack/libdfhack.so)
To fix this, simply remove the libstdc++ shipped with DF, it will fall back To fix this, you can compile DFHack with GCC 4.5 - or simply remove the
to your system lib and everything will work fine:: libstdc++ shipped with DF, and it will fall back to your system lib::
cd /path/to/DF/ cd /path/to/DF/
rm libs/libstdc++.so.6 rm libs/libstdc++.so.6
Alternatively, this issue can be avoided by compiling DFHack with GCC 4.5.
Mac OS X Mac OS X
======== ========
@ -201,16 +188,18 @@ On Windows, DFHack replaces the SDL library distributed with DF.
Dependencies Dependencies
------------ ------------
First, you need ``cmake``. Get the win32 installer version from You will need some sort of Windows port of git, or a GUI. Some examples:
`the official site <http://www.cmake.org/cmake/resources/software.html>`_.
* `Git for Windows <https://git-for-windows.github.io>`_ (command-line and GUI)
* `tortoisegit <https://tortoisegit.org>`_ (GUI and File Explorer integration)
You need ``cmake``. Get the win32 installer version from
`the official site <http://www.cmake.org/cmake/resources/software.html>`_.
It has the usual installer wizard. Make sure you let it add its binary folder It has the usual installer wizard. Make sure you let it add its binary folder
to your binary search PATH so the tool can be later run from anywhere. to your binary search PATH so the tool can be later run from anywhere.
You'll need a copy of Microsoft Visual C++ 2010. The Express version is sufficient. You'll need a copy of Microsoft Visual C++ 2010. The Express version is sufficient.
Grab it from Microsoft's site. Grab it from Microsoft's site. You'll also need the Visual Studio 2010 SP1 update.
You'll also need the Visual Studio 2010 SP1 update.
For the code generation parts, you'll need perl with XML::LibXML and XML::LibXSLT. For the code generation parts, you'll need perl with XML::LibXML and XML::LibXSLT.
`Strawberry Perl <http://strawberryperl.com>`_ works nicely for this. `Strawberry Perl <http://strawberryperl.com>`_ works nicely for this.

6
docs/Introduction.rst
Unescape Escape View File

@ -37,9 +37,6 @@ allows easier development of new tools. As an open-source project under
Installing DFHack Installing DFHack
================= =================
New players are encouraged to :wiki:`get a pack with DFHack preinstalled
<Utility:Lazy_Newb_Pack>`.
DFHack is available for the SDL version of Dwarf Frtress on Windows, DFHack is available for the SDL version of Dwarf Frtress on Windows,
any modern Linux distribution, and OS X (10.6.8 to 10.9). any modern Linux distribution, and OS X (10.6.8 to 10.9).
It is possible to use Windows DF+DFHack under Wine on Linux or OS X. It is possible to use Windows DF+DFHack under Wine on Linux or OS X.
@ -60,6 +57,9 @@ Uninstalling is basically the same, in reverse:
* On Windows, replace ``SDL.dll`` with ``SDLreal.dll``, then remove the DFHack files. * On Windows, replace ``SDL.dll`` with ``SDLreal.dll``, then remove the DFHack files.
* On Linux or OSX, remove the DFHack files. * On Linux or OSX, remove the DFHack files.
New players may wish to :wiki:`get a pack <Utility:Lazy_Newb_Pack>`
with DFHack preinstalled.
Getting started Getting started
=============== ===============

26
index.rst
Unescape Escape View File

@ -36,10 +36,10 @@ User Manual
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
docs/Introduction /docs/Introduction
docs/Core /docs/Core
docs/Plugins /docs/Plugins
docs/Scripts /docs/Scripts
Other Contents Other Contents
============== ==============
@ -47,9 +47,9 @@ Other Contents
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
docs/Authors /docs/Authors
LICENSE /LICENSE
NEWS /NEWS
For Developers For Developers
============== ==============
@ -57,9 +57,9 @@ For Developers
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
docs/Contributing /docs/Contributing
docs/Compile /docs/Compile
docs/Lua API /docs/Lua API
library/xml/SYNTAX /library/xml/SYNTAX
library/xml/how-to-update /library/xml/how-to-update
docs/Binpatches /docs/Binpatches

14
scripts/devel/lua-example.lua
Unescape Escape View File

@ -0,0 +1,14 @@
-- Example of a lua script.
--[[=begin
devel/lua-example
=================
An example lua script, which reports the number of times it has
been called. Useful for testing environment persistence.
=end]]
run_count = (run_count or 0) + 1
print('Arguments: ',...)
print('Command called '..run_count..' times.')

2
scripts/devel/test-perlin.lua
Unescape Escape View File

@ -5,8 +5,6 @@ devel/test-perlin
================= =================
Generates an image using multiple octaves of perlin noise. Generates an image using multiple octaves of perlin noise.
Used by `3dveins`?
=end]] =end]]
local args = {...} local args = {...}

6
travis/script-syntax.py
Unescape Escape View File

@ -24,9 +24,9 @@ def main():
except subprocess.CalledProcessError: except subprocess.CalledProcessError:
err = True err = True
except IOError: except IOError:
# catch error if not in Travis and Lua/Ruby is not available if not err:
if os.environ.get('TRAVIS', False): print('Warning: cannot check %s script syntax' % args.ext)
raise err = True
sys.exit(int(err)) sys.exit(int(err))