diff --git a/Compile.html b/Compile.html index 07b128db5..dc3440a65 100644 --- a/Compile.html +++ b/Compile.html @@ -365,12 +365,6 @@ ul.auto-toc {
  • Using the library as a developer
    • @@ -469,10 +463,10 @@ This will take some time—maybe hours, depending on your machine.
    @@ -648,46 +642,6 @@ the dfhack repository is welcome and the right thing to do :)

    Currently the supported set of requests is limited, because the developers don't know what exactly is most useful.

    Protocol client implementations exist for Java and C#.

    -
    -

    Contributing to DFHack

    -

    Several things should be kept in mind when contributing to DFHack.

    -
    -

    Coding style

    -

    DFhack uses ANSI formatting and four spaces as indentation. Line -endings are UNIX. The files use UTF-8 encoding. Code not following this -won't make me happy, because I'll have to fix it. There's a good chance -I'll make you fix it ;)

    -
    -
    -

    How to get new code into DFHack

    -

    You can send patches or make a clone of the github repo and ask me on -the IRC channel to pull your code in. I'll review it and see if there -are any problems. I'll fix them if they are minor.

    -

    Fixes are higher in priority. If you want to work on something, but -don't know what, check out http://github.com/DFHack/dfhack/issues -- -this is also a good place to dump new ideas and/or bugs that need -fixing.

    -
    -
    -

    Memory research

    -

    If you want to do memory research, you'll need some tools and some knowledge. -In general, you'll need a good memory viewer and optionally something -to look at machine code without getting crazy :)

    -

    Good windows tools include:

    - -

    Good linux tools:

    - -

    Using publicly known information and analyzing the game's data is preferred.

    -
    -
    diff --git a/Contributing.html b/Contributing.html new file mode 100644 index 000000000..3aad05fd9 --- /dev/null +++ b/Contributing.html @@ -0,0 +1,410 @@ + + + + + + +Contributing to DFHACK + + + +
    +

    Contributing to DFHACK

    + +
    +

    Contents

    + +
    +
    +

    Contributing to DFHack

    +

    Several things should be kept in mind when contributing to DFHack.

    +
    +

    Code Format

    +
      +
    • Four space indents for C++. Never use tabs for indentation in any language.
      • +
    • LF (Unix style) line terminators
      • +
    • Avoid trailing whitespace
      • +
    • UTF-8 encoding
      • +
    • For C++:
        +
      • Opening and closing braces on their own lines or opening brace at the end of the previous line
        • +
      • Braces placed at original indent level if on their own lines
        • +
      • #includes should be sorted. C++ libraries first, then dfhack modules, then df structures, then local includes. Within each category they should be sorted alphabetically. This policy is currently broken by most C++ files but try to follow it if you can.
        • +
      +
      • +
    +
    +
    +

    How to get new code into DFHack

    +
      +
    • Submit pull requests to the develop branch, not the master branch. The master branch always points at the most recent release.
      • +
    • Use new branches for each feature/fix so that your changes can be merged independently.
      • +
    • If possible, compile on multiple platforms
      • +
    • Do update NEWS/Contributors.rst
      • +
    • Do NOT run fix-texts.sh or update .html files (except to locally test changes to .rst files)
      • +
    • Create a Github Pull Request once finished
      • +
    • Work done against issues that are tagged "bug report" gets priority
        +
      • Submit ideas and bug reports as issues on github. Posts in the forum thread are also acceptable but can get missed or forgotten more easily.
        • +
      +
      • +
    +
    +
    +

    Memory research

    +

    If you want to do memory research, you'll need some tools and some knowledge. +In general, you'll need a good memory viewer and optionally something +to look at machine code without getting crazy :)

    +

    Good windows tools include:

    +
      +
    • Cheat Engine
      • +
    • IDA Pro 5.0 (freely available for non-commercial use)
      • +
    +

    Good linux tools:

    +
      +
    • angavrilov's df-structures gui (visit us on IRC for details).
      • +
    • edb (Evan's Debugger)
      • +
    • IDA Pro 5.0 running under Wine
      • +
    • Some of the tools residing in the legacy dfhack branch.
      • +
    +

    Using publicly known information and analyzing the game's data is preferred.

    +
    +
    +
    + + diff --git a/Lua API.html b/Lua API.html index 2e338d8c1..f53dc4596 100644 --- a/Lua API.html +++ b/Lua API.html @@ -378,63 +378,64 @@ ul.auto-toc {
  • Buildings module
  • Constructions module
  • Screen API
    • -
  • Internal API
    • +
  • Filesystem module
    • +
  • Internal API
    • -
  • Core interpreter context
    • -
  • Lua Modules