| @@ -0,0 +1,41 @@ | |||
| # | |||
| # Internal file for GetGitRevisionDescription.cmake | |||
| # | |||
| # Requires CMake 2.6 or newer (uses the 'function' command) | |||
| # | |||
| # Original Author: | |||
| # 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net> | |||
| # http://academic.cleardefinition.com | |||
| # Iowa State University HCI Graduate Program/VRAC | |||
| # | |||
| # Copyright Iowa State University 2009-2010. | |||
| # Distributed under the Boost Software License, Version 1.0. | |||
| # (See accompanying file LICENSE_1_0.txt or copy at | |||
| # http://www.boost.org/LICENSE_1_0.txt) | |||
|
|
|||
| set(HEAD_HASH) | |||
|
|
|||
| file(READ "@HEAD_FILE@" HEAD_CONTENTS LIMIT 1024) | |||
|
|
|||
| string(STRIP "${HEAD_CONTENTS}" HEAD_CONTENTS) | |||
| if(HEAD_CONTENTS MATCHES "ref") | |||
| # named branch | |||
| string(REPLACE "ref: " "" HEAD_REF "${HEAD_CONTENTS}") | |||
| if(EXISTS "@GIT_DIR@/${HEAD_REF}") | |||
| configure_file("@GIT_DIR@/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY) | |||
| else() | |||
| configure_file("@GIT_DIR@/packed-refs" "@GIT_DATA@/packed-refs" COPYONLY) | |||
| file(READ "@GIT_DATA@/packed-refs" PACKED_REFS) | |||
| if(${PACKED_REFS} MATCHES "([0-9a-z]*) ${HEAD_REF}") | |||
| set(HEAD_HASH "${CMAKE_MATCH_1}") | |||
| endif() | |||
| endif() | |||
| else() | |||
| # detached HEAD | |||
| configure_file("@GIT_DIR@/HEAD" "@GIT_DATA@/head-ref" COPYONLY) | |||
| endif() | |||
|
|
|||
| if(NOT HEAD_HASH) | |||
| file(READ "@GIT_DATA@/head-ref" HEAD_HASH LIMIT 1024) | |||
| string(STRIP "${HEAD_HASH}" HEAD_HASH) | |||
| endif() | |||
| @@ -0,0 +1,25 @@ | |||
| ## Our Pledge | |||
|
|
|||
| In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. | |||
|
|
|||
| ## Our Standards | |||
|
|
|||
| 1. Assume other participants are posting in good faith, even if you disagree with what they say. | |||
| 2. Make an effort to treat other participants with respect. | |||
| 1. Do not take a harsh tone towards other participants, and especially don't make personal attacks against them. | |||
| 2. Recognize that criticism of your statements is not a personal attack on you. | |||
| 3. Avoid statements about the presumed typical desires, capabilities or actions of some demographic group. | |||
| 3. Be especially kind to other contributors when saying they made a mistake. | |||
| 4. Don't argue unceasingly for your preferred course of action when a decision for some other course has already been made. | |||
| 5. If other participants complain about the way you express your ideas, please make an effort to cater to them. | |||
| 6. Don't raise unrelated political issues. | |||
| 7. If you feel these standards are being violated, please alert the project lead Kevin Granade at kevin.granade@gmail.com | |||
|
|
|||
| ## Attribution | |||
|
|
|||
| This Code of Conduct is adapted from the [Contributor Covenant][CoC homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][CoC version] and the [GNU Kind Communications Guidelines][GKCG homepage]. | |||
|
|
|||
|
|
|||
| [CoC homepage]: http://contributor-covenant.org | |||
| [CoC version]: http://contributor-covenant.org/version/1/4/ | |||
| [GKCG homepage]: https://www.gnu.org/philosophy/kind-communication.html | |||
| @@ -0,0 +1,339 @@ | |||
| #Disclaimer | |||
|
|
|||
| **WARNING**: CMake build is **NOT** official and should be used for *dev purposes ONLY*. | |||
|
|
|||
| For official way to build CataclysmDDA See: | |||
| * [COMPILING.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING.md) | |||
|
|
|||
|
|
|||
| #Contents | |||
|
|
|||
| 1. Prerequisites | |||
| 2. Build Environment | |||
| * UNIX Environment | |||
| * Windows Environment | |||
| 3. CMake Build | |||
| * MinGW,MSYS,MSYS2 | |||
| 5. Build Options | |||
| * CMake specific options | |||
| * CataclysmDDA specific options | |||
|
|
|||
| #1. Prerequisites | |||
|
|
|||
| You'll need to have these libraries and their development headers installed in | |||
| order to build CataclysmDDA: | |||
|
|
|||
| * General | |||
| * `cmake` >= 3.0.0 | |||
| * `gcc-libs` | |||
| * `glibc` | |||
| * `zlib` | |||
| * `bzip2` | |||
| * Optional | |||
| * `gettext` | |||
| * Curses | |||
| * `ncurses` | |||
| * Tiles | |||
| * `SDL` >= 2.0.0 | |||
| * `SDL_image` >= 2.0.0 (with PNG and JPEG support) | |||
| * `SDL_mixer` >= 2.0.0 (with Ogg Vorbis support) | |||
| * `SDL_ttf` >= 2.0.0 | |||
| * `freetype` | |||
| * Sound | |||
| * `vorbis` | |||
| * `libbz2` | |||
| * `libz` | |||
| * `libintl` | |||
| * `iconv` | |||
|
|
|||
|
|
|||
| #2. Build Environment | |||
|
|
|||
| You can obtain the source code tarball for the latest version from [git](https://github.com/CleverRaven/Cataclysm-DDA). | |||
|
|
|||
|
|
|||
| ## UNIX Environment | |||
|
|
|||
| Obtain packages specified above with your system package manager. | |||
|
|
|||
|
|
|||
| ## Windows Environment (MSYS2) | |||
|
|
|||
| 1. Follow steps from here: https://msys2.github.io/ | |||
| 2. Install CataclysmDDA build deps: | |||
|
|
|||
| ``` | |||
| pacman -S mingw-w64-i686-toolchain msys/git \ | |||
| mingw-w64-i686-cmake \ | |||
| mingw-w64-i686-SDL2_{image,mixer,ttf} \ | |||
| ncurses-devel \ | |||
| gettext-devel | |||
| ``` | |||
|
|
|||
| This should get your environment set up to build console and tiles version of windows. | |||
|
|
|||
| **NOTE**: This is only for 32bit builds. 64bit requires the x86_64 instead of the i686 | |||
| packages listed above: | |||
|
|
|||
| ``` | |||
| pacman -S mingw-w64-x86_64-toolchain msys/git \ | |||
| mingw-w64-x86_64-cmake \ | |||
| mingw-w64-x86_64-SDL2_{image,mixer,ttf} \ | |||
| ncurses-devel \ | |||
| gettext-devel | |||
| ``` | |||
|
|
|||
| **NOTE**: If you're trying to test with Jetbrains CLion, point to the cmake version in the | |||
| msys32/mingw32 path instead of using the built in. This will let cmake detect the | |||
| installed packages. | |||
|
|
|||
|
|
|||
| # CMake Build | |||
|
|
|||
| CMake has separate configuration and build steps. Configuration | |||
| is done using CMake itself, and the actual build is done using either `make` | |||
| (for Makefiles generator) or build-system agnostic `cmake --build . ` . | |||
|
|
|||
| There are two ways to build CataclysmDDA with CMake: inside the source tree or | |||
| outside of it. Out-of-source builds have the advantage that you can have | |||
| multiple builds with different options from one source directory. | |||
|
|
|||
| **WARNING**: Inside the source tree build is **NOT** supported. | |||
|
|
|||
| To build CataclysmDDA out of source: | |||
|
|
|||
| ``` | |||
| $ mkdir build && cd build | |||
| $ cmake .. -DCMAKE_BUILD_TYPE=Release | |||
| $ make | |||
| ``` | |||
|
|
|||
| The above example creates a build directory inside the source directory, but that's not required - you can just as easily create it in a completely different location. | |||
|
|
|||
| To install CataclysmDDA after building (as root using su or sudo if necessary): | |||
|
|
|||
| ``` | |||
| # make install | |||
| ``` | |||
|
|
|||
| To change build options, you can either pass the options on the command line: | |||
|
|
|||
| ``` | |||
| $ cmake .. -DOPTION_NAME=option_value | |||
| ``` | |||
|
|
|||
| Or use either the `ccmake` or `cmake-gui` front-ends, which display all options | |||
| and their cached values on a console and graphical UI, respectively. | |||
|
|
|||
| ``` | |||
| $ ccmake .. | |||
| $ cmake-gui .. | |||
| ``` | |||
|
|
|||
|
|
|||
| ## CMake Build for MSYS2 (MinGW) | |||
|
|
|||
| **NOTE**: For development purposes it is preferred to use `MinGW Win64 Shell` or `MinGW Win32 Shell` instead of `MSYS2 Shell`. In other case, you will need to set `PATH` variable manually. | |||
|
|
|||
| For Mingw,MSYS,MSYS2 you should set [Makefiles generator](https://cmake.org/cmake/help/v3.0/manual/cmake-generators.7.html) to "MSYS Makefiles". | |||
| Setting it to "MinGW Makefiles" might work as well, but might also require additional hackery. | |||
|
|
|||
| Example: | |||
|
|
|||
| ``` | |||
| $ cd <Path-to-CataclysmDDA-Sources> | |||
| $ mkdir build | |||
| $ cd build | |||
| $ cmake .. -G "MSYS Makefiles" | |||
| $ make # or $ cmake --build . | |||
| ``` | |||
|
|
|||
| The resulting binary will be placed inside the source code directory. | |||
|
|
|||
| Shared libraries: | |||
|
|
|||
| If you got `libgcc_s_dw2-1.dll not found` error you need to copy shared libraries | |||
| to directory with CataclysmDDA executables. | |||
|
|
|||
| **NOTE**: For `-DRELEASE=OFF` development builds, You can automate copy process with: | |||
|
|
|||
| ``` | |||
| $ make install | |||
| ``` | |||
|
|
|||
| However, it likely will fail b/c you have different build environment setup :) | |||
|
|
|||
| Currently known depends (Maybe outdated use ldd.exe to correct it for Your system) | |||
|
|
|||
| * MINGW deps: | |||
| * `libwinpthread-1.dll` | |||
| * `libgcc_s_dw2-1.dll` | |||
| * `libstdc++-6.dll` | |||
|
|
|||
| * LOCALIZE deps: | |||
| * `libintl-8.dll` | |||
| * `libiconv-2.dll` | |||
|
|
|||
| * TILES deps: | |||
| * `SDL2.dll` | |||
| * `SDL2_ttf.dll` | |||
| * `libfreetype-6.dll` | |||
| * `libbz2-1.dll` | |||
| * `libharfbuzz-0.dll` | |||
| * `SDL2_image.dll` | |||
| * `libpng16-16.dll` | |||
| * `libjpeg-8.dll` | |||
| * `libtiff-5.dll` | |||
| * `libjbig-0.dll` | |||
| * `liblzma-5.dll` | |||
| * `libwebp-5.dll` | |||
| * `zlib1.dll` | |||
| * `libglib-2.0-0.dll` | |||
|
|
|||
| * SOUND deps: | |||
| * `SDL2_mixer.dll` | |||
| * `libFLAC-8.dll` | |||
| * `libogg-0.dll` | |||
| * `libfluidsynth-1.dll` | |||
| * `libportaudio-2.dll` | |||
| * `libsndfile-1.dll` | |||
| * `libvorbis-0.dll` | |||
| * `libvorbisenc-2.dll` | |||
| * `libmodplug-1.dll` | |||
| * `smpeg2.dll` | |||
| * `libvorbisfile-3.dll` | |||
|
|
|||
|
|
|||
| ## CMake Build for Visual Studio / MSBuild | |||
|
|
|||
| CMake can generate `.sln` and `.vcxproj` files used either by Visual Studio itself or by MSBuild command line compiler (if you don't want | |||
| a full fledged IDE) and have more "native" binaries than what MSYS/Cygwin can provide. | |||
|
|
|||
| At the moment only a limited combination of options is supported (tiles only, no localizations, no backtrace). | |||
|
|
|||
| Get the tools: | |||
| * CMake from the official site - https://cmake.org/download/. | |||
| * Microsoft compiler - https://visualstudio.microsoft.com/downloads/?q=build+tools , choose "Build Tools for Visual Studio 2017". When installing chose "Visual C++ Build Tools" options. | |||
| * alternatively, you can get download and install the complete Visual Studio, but that's not required. | |||
|
|
|||
| Get the required libraries: | |||
| * `SDL2` - https://www.libsdl.org/download-2.0.php (you need the "(Visual C++ 32/64-bit)" version. Same below) | |||
| * `SDL2_ttf` - https://www.libsdl.org/projects/SDL_ttf/ | |||
| * `SDL2_image` - https://www.libsdl.org/projects/SDL_image/ | |||
| * `SDL2_mixer` (optional, for sound support) - https://www.libsdl.org/projects/SDL_mixer/ | |||
| * Unsupported (and unused in the following instructions) optional libs: | |||
| * `gettext`/`libintl` - http://gnuwin32.sourceforge.net/packages/gettext.htm | |||
| * `ncurses` - ??? | |||
|
|
|||
| Unpack the archives with the libraries. | |||
|
|
|||
| Open windows command line (or powershell), set the environment variables to point to the libs above as follows (adjusting the paths as appropriate): | |||
| ``` | |||
| > set SDL2DIR=C:\path\to\SDL2-devel-2.0.9-VC | |||
| > set SDL2TTFDIR=C:\path\to\SDL2_ttf-devel-2.0.15-VC | |||
| > set SDL2IMAGEDIR=C:\path\to\SDL2_image-devel-2.0.4-VC | |||
| > set SDL2MIXERDIR=C:\path\to\SDL2_mixer-devel-2.0.4-VC | |||
| ``` | |||
| (for powershell the syntax is `$env:SDL2DIR="C:\path\to\SDL2-devel-2.0.9-VC"`). | |||
|
|
|||
| Make a build directory and run cmake configuration step | |||
| ``` | |||
| > cd <path to cdda sources> | |||
| > mkdir build | |||
| > cd build | |||
| > cmake .. -DTILES=ON -DLOCALIZE=OFF -DBACKTRACE=OFF -DSOUND=ON | |||
| ``` | |||
|
|
|||
|
|
|||
| Build! | |||
| ``` | |||
| > cmake --build . -j 2 -- /p:Configuration=Release | |||
| ``` | |||
| The `-j 2` flag controls build parallelism - you can omit it if you wish. The `/p:Configuration=Release` flag is passed directly to MSBuild and | |||
| controls optimizations. If you omit it, the `Debug` configuration would be built instead. For powershell you'll need to have an extra ` -- ` after the first one. | |||
|
|
|||
| The resulting files will be put into a `Release` directory inside your source Cataclysm-DDA folder. To make them run you'd need to first move them to the | |||
| source Cataclysm-DDA directory itself (so that the binary has access to the game data), and second put the required `.dll`s into the same folder - | |||
| you can find those inside the directories for dev libraries under `lib/x86/` or `lib/x64/` (you likely need the `x86` ones even if you're on 64-bit machine). | |||
|
|
|||
| The copying of dlls is a one-time task, but you'd need to move the binary out of `Release/` each time it's built. To automate it a bit, you can configure cmake and set the desired binaries destination directory with `-DCMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE=` option (and similar for `CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG`). | |||
|
|
|||
| Run the game. Should work. | |||
|
|
|||
|
|
|||
| # Build Options | |||
|
|
|||
| A full list of options supported by CMake, you may either run the `ccmake` | |||
| or `cmake-gui` front-ends, or run `cmake` and open the generated CMakeCache.txt | |||
| from the build directory in a text editor. | |||
|
|
|||
| ``` | |||
| $ cmake -DOPTION_NAME1=option_value1 [-DOPTION_NAME2=option_value2 [...]] | |||
| ``` | |||
|
|
|||
|
|
|||
| ## CMake specific options | |||
|
|
|||
| * CMAKE_BUILD_TYPE=`<build type>` | |||
|
|
|||
| Selects a specific build configuration when compiling. `release` produces | |||
| the default, optimized (-Os) build for regular use. `debug` produces a | |||
| slower and larger unoptimized (-O0) build with full debug symbols, which is | |||
| often needed for obtaining detailed backtraces when reporting bugs. | |||
|
|
|||
| **NOTE**: By default, CMake will produce `debug` builds unless a different | |||
| configuration option is passed in the command line. | |||
|
|
|||
|
|
|||
| * CMAKE_INSTALL_PREFIX=`<full path>` | |||
|
|
|||
| Installation prefix for binaries, resources, and documentation files. | |||
|
|
|||
|
|
|||
| ## CataclysmDDA specific options | |||
|
|
|||
| * CURSES=`<boolean>` | |||
|
|
|||
| Build curses version. | |||
|
|
|||
|
|
|||
| * TILES=`<boolean>` | |||
|
|
|||
| Build graphical tileset version. | |||
|
|
|||
|
|
|||
| * SOUND=`<boolean>` | |||
|
|
|||
| Support for in-game sounds & music. | |||
|
|
|||
|
|
|||
| * USE_HOME_DIR=`<boolean>` | |||
|
|
|||
| Use user's home directory for save files. | |||
|
|
|||
|
|
|||
| * LOCALIZE=`<boolean>` | |||
|
|
|||
| Support for language localizations. Also enable UTF support. | |||
|
|
|||
|
|
|||
| * DYNAMIC_LINKING=`<boolean>` | |||
|
|
|||
| Use dynamic linking. Or use static to remove MinGW dependency instead. | |||
|
|
|||
|
|
|||
| * LANGUAGES=`<str>` | |||
|
|
|||
| Compile localization files for specified languages. Example: | |||
| ``` | |||
| -DLANGUAGES="cs;de;el;es_AR;es_ES" | |||
| ``` | |||
|
|
|||
| * GIT_BINARY=`<str>` | |||
|
|
|||
| Override default Git binary name or path. | |||
|
|
|||
| So a CMake command for building Cataclysm-DDA in release mode with tiles and sound support will look as follows, provided it is run in build directory located in the project. | |||
| ``` | |||
| cmake ../ -DCMAKE_BUILD_TYPE=Release -DTILES=ON -DSOUND=ON | |||
| ``` | |||
| @@ -0,0 +1,71 @@ | |||
| # Compilation guide for 64 bit Windows (using CYGWIN) | |||
|
|
|||
| This guide contains steps required to allow compilation of Cataclysm-DDA on Windows under CYGWIN. | |||
|
|
|||
| Steps from current guide were tested on Windows 10 (64 bit) and CYGWIN (64 bit), but should work for other versions of Windows and also CYGWIN (32 bit) if you download 32 bit version of all files. | |||
|
|
|||
| ## Prerequisites: | |||
|
|
|||
| * Computer with 64 bit version of modern Windows operating system installed (Windows 10, Windows 8.1 or Windows 7); | |||
| * NTFS partition with ~10 Gb free space (~2 Gb for CYGWIN installation, ~3 Gb for repository and ~5 Gb for ccache); | |||
| * 64 bit version of CYGWIN (installer can be downloaded from [CYGWIN homepage](https://cygwin.com/)); | |||
|
|
|||
| ## Installation: | |||
|
|
|||
| 1. Go to [CYGWIN homepage](https://cygwin.com/) and download 64 bit installer (e.g. [setup-x86_64.exe](https://cygwin.com/setup-x86_64.exe). | |||
|
|
|||
| 2. Run downloaded file and install CYGWIN (click `Next` button, select instalation source (e.g. `Install from Internet`), click `Next` button, specify directory where CYGWIN 64 bit will be installed (e.g. `C:\cygwin64`), select whether to install for all users or just you, click `Next` button again, select local package directory (e.g. `C:\Distr\Cygwin`), click `Next` button, select Internet connection settings, click `Next` button again, choose a download site from the list of available download sites, click `Next` button again). | |||
|
|
|||
| 3. After CYGWIN installation is complete select following packages and press `Next` button to download and install them: | |||
|
|
|||
| * `wget`. | |||
|
|
|||
| 4. System will tell you it will install following packages (you will install everything else later): | |||
|
|
|||
| ``` | |||
| ... | |||
| ``` | |||
|
|
|||
| 5. Check boxes to add shortcuts to Start Menu and/or Desktop, then press `Finish` button. | |||
|
|
|||
| ## Configuration: | |||
|
|
|||
| 1. Install `apt-cyg` for easier package installation with: | |||
|
|
|||
| ```bash | |||
| wget rawgit.com/transcode-open/apt-cyg/master/apt-cyg -O /bin/apt-cyg | |||
| chmod 755 /bin/apt-cyg | |||
| ``` | |||
|
|
|||
| 2. Install packages required for compilation with: | |||
|
|
|||
| ```bash | |||
| apt-cyg install git make astyle gcc-g++ libintl-devel libiconv-devel libSDL2_image-devel libSDL2_ttf-devel libSDL2_mixer-devel libncurses-devel xinit | |||
| ``` | |||
|
|
|||
| ## Cloning and compilation: | |||
|
|
|||
| 1. Clone Cataclysm-DDA repository with following command line: | |||
|
|
|||
| **Note:** This will download whole CDDA repository. If you're just testing you should probably add `--depth=1`. | |||
|
|
|||
| ```bash | |||
| git clone https://github.com/CleverRaven/Cataclysm-DDA.git | |||
| cd Cataclysm-DDA | |||
| ``` | |||
|
|
|||
| 2. Compile with following command line: | |||
|
|
|||
| ```bash | |||
| make CCACHE=1 RELEASE=1 CYGWIN=1 DYNAMIC_LINKING=1 SDL=1 TILES=1 SOUND=1 LOCALIZE=1 LANGUAGES=all LINTJSON=0 ASTYLE=0 RUNTESTS=0 | |||
| ``` | |||
|
|
|||
| **Note**: This will compile release version with Sound and Tiles support and all localization languages, skipping checks and tests and using ccache for faster build. You can use other switches, but `CYGWIN=1`, `DYNAMIC_LINKING=1` and probably `RELEASE=1` are required to compile without issues. | |||
|
|
|||
| ## Running: | |||
|
|
|||
| 1. Run from within CYGWIN XWin Server (found in Start Menu) with following command line: | |||
|
|
|||
| ```bash | |||
| ./cataclysm-tiles | |||
| ``` | |||
| @@ -0,0 +1,34 @@ | |||
| # Compiling Guide for Linux (Flatpak) | |||
|
|
|||
| ## Prerequisites | |||
|
|
|||
| - Install `flatpak` and `flatpak-builder` from your distribution's package manager. | |||
| - Install `freedesktop-platform` & `freedesktop-sdk` using `flatpak install flathub org.freedesktop.Platform//18.08 org.freedesktop.Sdk//18.08` | |||
|
|
|||
| ## Build | |||
|
|
|||
| Clone the source code and run `flatpak-builder --repo=repo --ccache --force-clean build-dir org.Cataclysm.DDA.json` or `flatpak-builder --repo=repo --ccache --force-clean build-dir org.Cataclysm.DDA.Tiles.json` to build the ncurses or tiles version of the application. | |||
|
|
|||
| ## Installation | |||
|
|
|||
| Run `flatpak --user install test-repo org.Cataclysm.DDA` (or) `flatpak --user install test-repo org.Cataclysm.DDA.Tiles` to install the game. | |||
| Note: If you are installing the game for first time you will have to set up local repo. Run this `flatpak --user remote-add --no-gpg-verify test-repo repo` | |||
|
|
|||
| ## Starting the game | |||
|
|
|||
| `flatpak run org.Cataclysm.DDA` (or) `flatpak run org.Cataclysm.DDA.Tiles` | |||
| **or** | |||
| Launch the Game from Applications -> Games -> Cataclysm: Dark Days Ahead (or) Cataclysm: Dark Days Ahead - Tiles. | |||
| **Note**: For the ncurses version, terminal will just show a blank screen on launch. Just press any button to start the game. | |||
|
|
|||
| ## Permissions | |||
|
|
|||
| - **Ncurses version** | |||
| - Home Directory | |||
| - **Tiles Version** | |||
| - Home Directory | |||
| - Wayland | |||
| - Fallback-X11 - (incase Wayland doesn't work) | |||
| - IPC - (Required for X11) | |||
| - PulseAudio | |||
| - DRI | |||
| @@ -0,0 +1,104 @@ | |||
| # Compilation guide for 64 bit Windows (using MSYS2) | |||
|
|
|||
| This guide contains steps required to allow compilation of Cataclysm-DDA on Windows under MSYS2. | |||
|
|
|||
| Steps from current guide were tested on Windows 10 (64 bit) and MSYS2 (64 bit), but should work for other versions of Windows and also MSYS2 (32 bit) if you download 32 bit version of all files. | |||
|
|
|||
| ## Prerequisites: | |||
|
|
|||
| * Computer with 64 bit version of modern Windows operating system installed (Windows 10, Windows 8.1 or Windows 7); | |||
| * NTFS partition with ~10 Gb free space (~2 Gb for MSYS2 installation, ~3 Gb for repository and ~5 Gb for ccache); | |||
| * 64 bit version of MSYS2 (installer can be downloaded from [MSYS2 homepage](http://www.msys2.org/)); | |||
|
|
|||
| **Note:** Windows XP is unsupported! | |||
|
|
|||
| ## Installation: | |||
|
|
|||
| 1. Go to [MSYS2 homepage](http://www.msys2.org/) and download 64 bit installer (e.g. [msys2-x86_64-20180531.exe](http://repo.msys2.org/distrib/x86_64/msys2-x86_64-20180531.exe)). | |||
|
|
|||
| 2. Run downloaded file and install MSYS2 (click `Next` button, specify directory where MSYS2 64 bit will be installed (e.g. `C:\msys64`), click `Next` button again, specify Start Menu folder name and click `Install` button). | |||
|
|
|||
| 3. After MSYS2 installation is complete press `Next` button, tick `Run MSYS2 64 bit now` checkbox and press `Finish` button. | |||
|
|
|||
| ## Configuration: | |||
|
|
|||
| 1. Update the package database and core system packages with: | |||
|
|
|||
| ```bash | |||
| pacman -Syu | |||
| ``` | |||
|
|
|||
| 2. If asked close MSYS2 window and restart it from Start Menu or `C:\msys64\msys2_shell.cmd`. | |||
|
|
|||
| 3. Update remaining packages with: | |||
|
|
|||
| ```bash | |||
| pacman -Su | |||
| ``` | |||
|
|
|||
| 4. Install packages required for compilation with: | |||
|
|
|||
| ```bash | |||
| pacman -S git git-extras-git make mingw-w64-x86_64-{astyle,ccache,gcc,libmad,libwebp,ncurses,pkg-config,SDL2} mingw-w64-x86_64-SDL2_{image,mixer,ttf} | |||
| ``` | |||
|
|
|||
| 5. Update paths in system-wide profile file (e.g. `C:\msys64\etc\profile`) as following: | |||
|
|
|||
| - find lines: | |||
|
|
|||
| ``` | |||
| MSYS2_PATH="/usr/local/bin:/usr/bin:/bin" | |||
| MANPATH='/usr/local/man:/usr/share/man:/usr/man:/share/man' | |||
| INFOPATH='/usr/local/info:/usr/share/info:/usr/info:/share/info' | |||
| ``` | |||
|
|
|||
| and | |||
|
|
|||
| ``` | |||
| PKG_CONFIG_PATH="/usr/lib/pkgconfig:/usr/share/pkgconfig:/lib/pkgconfig" | |||
| ``` | |||
|
|
|||
| - and replace them with: | |||
|
|
|||
| ``` | |||
| MSYS2_PATH="/usr/local/bin:/usr/bin:/bin:/mingw64/bin" | |||
| MANPATH='/usr/local/man:/usr/share/man:/usr/man:/share/man:/mingw64/share/man' | |||
| INFOPATH='/usr/local/info:/usr/share/info:/usr/info:/share/info:/mingw64/share/man' | |||
| ``` | |||
|
|
|||
| and | |||
|
|
|||
| ``` | |||
| PKG_CONFIG_PATH="/usr/lib/pkgconfig:/usr/share/pkgconfig:/lib/pkgconfig:/mingw64/lib/pkgconfig:/mingw64/share/pkgconfig" | |||
| ``` | |||
|
|
|||
| 6. Restart MSYS2 to apply path changes. | |||
|
|
|||
| ## Cloning and compilation: | |||
|
|
|||
| 1. Clone Cataclysm-DDA repository with following command line: | |||
|
|
|||
| **Note:** This will download whole CDDA repository. If you're just testing you should probably add `--depth=1`. | |||
|
|
|||
| ```bash | |||
| git clone https://github.com/CleverRaven/Cataclysm-DDA.git | |||
| cd Cataclysm-DDA | |||
| ``` | |||
|
|
|||
| 2. Compile with following command line: | |||
|
|
|||
| ```bash | |||
| make CCACHE=1 RELEASE=1 MSYS2=1 DYNAMIC_LINKING=1 SDL=1 TILES=1 SOUND=1 LOCALIZE=1 LANGUAGES=all LINTJSON=0 ASTYLE=0 RUNTESTS=0 | |||
| ``` | |||
|
|
|||
| **Note**: This will compile release version with Sound and Tiles support and all localization languages, skipping checks and tests and using ccache for faster build. You can use other switches, but `MSYS2=1`, `DYNAMIC_LINKING=1` and probably `RELEASE=1` are required to compile without issues. | |||
|
|
|||
| ## Running: | |||
|
|
|||
| 1. Run from within MSYS2 with following command line: | |||
|
|
|||
| ```bash | |||
| ./cataclysm-tiles | |||
| ``` | |||
|
|
|||
| **Note:** If you want to run compiled executable from Explorer you will also need to update user or system `PATH` variable with path to MSYS2 runtime binaries (e.g. `C:\msys64\mingw64\bin`). | |||
| @@ -0,0 +1,80 @@ | |||
| # Compilation guide for Windows (using Visual Studio and vcpkg) | |||
|
|
|||
| This guide contains steps required to allow compilation of Cataclysm-DDA on Windows using Visual Studio and vcpkg. | |||
|
|
|||
| Steps from current guide were tested on Windows 10 (64 bit), Visual Studio 2017 (64 bit) and vcpkg, but should as well work with slight modifications for other versions of Windows and Visual Studio. | |||
|
|
|||
| ## Prerequisites: | |||
|
|
|||
| * Computer with modern Windows operating system installed (Windows 10, Windows 8.1 or Windows 7); | |||
| * NTFS partition with ~15 Gb free space (~10 Gb for Visual Studio, ~1 Gb for vcpkg installation, ~3 Gb for repository and ~1 Gb for build cache); | |||
| * Git for Windows (installer can be downloaded from [Git homepage](https://git-scm.com/)); | |||
| * Visual Studio 2017 (or 2015 Visual Studio Update 3 and above); | |||
| * Latest version of vcpkg (see instructions on [vcpkg homepage](https://github.com/Microsoft/vcpkg)). | |||
|
|
|||
| **Note:** Windows XP is unsupported! | |||
|
|
|||
| ## Installation and configuration: | |||
|
|
|||
| 1. Install `Visual Studio` (installer can be downloaded from [Visual Studio homepage](https://visualstudio.microsoft.com/)). | |||
|
|
|||
| 2. Install `Git for Windows` (installer can be downloaded from [Git homepage](https://git-scm.com/)). | |||
|
|
|||
| 3. Install and configure `vcpkg` using instruction from [vcpkg homepage](https://github.com/Microsoft/vcpkg/blob/master/README.md#quick-start) with following command line: | |||
|
|
|||
| ```cmd | |||
| git clone https://github.com/Microsoft/vcpkg.git | |||
| cd vcpkg | |||
| .\bootstrap-vcpkg.bat | |||
| vcpkg integrate install | |||
| ``` | |||
|
|
|||
| 4. Install (or upgrade) neccessary packages with following command line: | |||
|
|
|||
| #### install 64 bit dependencies: | |||
|
|
|||
| ```cmd | |||
| vcpkg --triplet x64-windows install sdl2 sdl2-image sdl2-mixer[libflac,mpg123,libmodplug,libvorbis] sdl2-ttf gettext | |||
| ``` | |||
|
|
|||
| or (if you want to build statically linked executable) | |||
|
|
|||
| ```cmd | |||
| vcpkg --triplet x64-windows-static install sdl2 sdl2-image sdl2-mixer[libflac,mpg123,libmodplug,libvorbis] sdl2-ttf gettext | |||
| ``` | |||
|
|
|||
|
|
|||
| #### install 32 bit dependencies: | |||
|
|
|||
| ```cmd | |||
| vcpkg --triplet x86-windows install sdl2 sdl2-image sdl2-mixer[libflac,mpg123,libmodplug,libvorbis] sdl2-ttf gettext | |||
| ``` | |||
|
|
|||
| or (if you want to build statically linked executable) | |||
|
|
|||
| ```cmd | |||
| vcpkg --triplet x86-windows-static install sdl2 sdl2-image sdl2-mixer[libflac,mpg123,libmodplug,libvorbis] sdl2-ttf gettext | |||
| ``` | |||
|
|
|||
| #### upgrade all dependencies: | |||
|
|
|||
| ```cmd | |||
| vcpkg upgrade | |||
| ``` | |||
|
|
|||
| ## Cloning and compilation: | |||
|
|
|||
| 1. Clone Cataclysm-DDA repository with following command line: | |||
|
|
|||
| **Note:** This will download whole CDDA repository. If you're just testing you should probably add `--depth=1`. | |||
|
|
|||
| ```cmd | |||
| git clone https://github.com/CleverRaven/Cataclysm-DDA.git | |||
| cd Cataclysm-DDA | |||
| ``` | |||
|
|
|||
| 2. Open one of provided solutions (`msvc-full-features\Cataclysm-vcpkg.sln` for dynamically linked executable or `msvc-full-features\Cataclysm-vcpkg-static.sln` for statically linked executable) in `Visual Studio`, select configuration (`Release` or `Debug`) an platform (`x64` or `x86`) and build it. | |||
|
|
|||
| **Note**: This will compile release version with Sound, Tiles and Localization support (language files won't be automatically compiled). | |||
|
|
|||
| 3. See [COMPILING.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING.md#visual-studio-guide) for detail about building and debugging. | |||
| @@ -0,0 +1,84 @@ | |||
| { | |||
| "build_systems": | |||
| [ | |||
| { | |||
| "cmd": | |||
| [ | |||
| "make", | |||
| "USE_HOME_DIR=1", | |||
| "CLANG=1", | |||
| "CCACHE=1", | |||
| "RELEASE=1" | |||
| ], | |||
| "file_regex": "^(..[^:]*):([0-9]+):?([0-9]+)?:? (.*)$", | |||
| "name": "make RELEASE", | |||
| "working_dir": "${folder:${project_path:${file_path}}}" | |||
| }, | |||
| { | |||
| "cmd": | |||
| [ | |||
| "make", | |||
| "USE_HOME_DIR=1", | |||
| "CLANG=1", | |||
| "CCACHE=1" | |||
| ], | |||
| "file_regex": "^(..[^:]*):([0-9]+):?([0-9]+)?:? (.*)$", | |||
| "name": "make", | |||
| "working_dir": "${folder:${project_path:${file_path}}}" | |||
| }, | |||
| { | |||
| "cmd": | |||
| [ | |||
| "make", | |||
| "USE_HOME_DIR=1", | |||
| "CLANG=1", | |||
| "CCACHE=1", | |||
| "TILES=1" | |||
| ], | |||
| "file_regex": "^(..[^:]*):([0-9]+):?([0-9]+)?:? (.*)$", | |||
| "name": "make TILES", | |||
| "working_dir": "${folder:${project_path:${file_path}}}" | |||
| }, | |||
| { | |||
| "cmd": | |||
| [ | |||
| "make", | |||
| "USE_HOME_DIR=1", | |||
| "CLANG=1", | |||
| "CCACHE=1", | |||
| "TILES=1", | |||
| "RELEASE=1" | |||
| ], | |||
| "file_regex": "^(..[^:]*):([0-9]+):?([0-9]+)?:? (.*)$", | |||
| "name": "make RELEASE TILES", | |||
| "working_dir": "${folder:${project_path:${file_path}}}" | |||
| } | |||
| ], | |||
| "folders": | |||
| [ | |||
| { | |||
| "folder_exclude_patterns": | |||
| [ | |||
| "Cataclysm.app" | |||
| ], | |||
| "path": "." | |||
| }, | |||
| { | |||
| "path": "~/.cataclysm-dda" | |||
| }, | |||
| { | |||
| "path": "~/Library/Application Support/Cataclysm" | |||
| } | |||
| ], | |||
| "settings": | |||
| { | |||
| "AStyleFormatter": | |||
| { | |||
| "options_c++": | |||
| { | |||
| "additional_options_file": ".astylerc", | |||
| "use_only_additional_options": true | |||
| } | |||
| } | |||
| } | |||
| } | |||
| @@ -0,0 +1,71 @@ | |||
| # Guide to add Comestibles | |||
|
|
|||
| There are a large number of files in `json/items/comestibles`, and this guide will help you decide where to put your new comestible! | |||
|
|
|||
| ## List of special comestibles: | |||
| `med.json` -- comestible that has an addiction effect besides alcohol and caffeine, plus bandages and disinfectant type items. | |||
|
|
|||
| `mre.json` -- items and comestibles related to MREs | |||
|
|
|||
| `mutagen.json` -- comestible that has any mutagen effect | |||
|
|
|||
| `carnivore.json` -- item that would normally be butchered from an animal or monster, and their cooked versions. examples: chunks of meat, tainted bones, boiled stomach | |||
|
|
|||
| `protein.json` -- comestibles based on protein powder | |||
|
|
|||
| `spice.json` -- comestibles that normally do not have nutrients, but are used to flavor a dish. examples: salt, thyme, black pepper | |||
|
|
|||
| `frozen.json` -- comestibles best eaten frozen | |||
|
|
|||
| `brewing.json` -- items used in the brewing process | |||
|
|
|||
| ## List of normal comestibles, in order of priority: | |||
| When you have a comestible you want to add to the files, just go down this list, and the first filename you see in the list that matches the criteria is your choice! | |||
|
|
|||
| ### Liquid | |||
|
|
|||
| `alcohol.json` -- "Drink" comestible with alcohol addiction | |||
|
|
|||
| `soup.json` -- "Drink" comestible which is a soup. This is more of a "food" than a drink - you primarily want the calories from this | |||
|
|
|||
| `drink.json` -- "Drink" comestible. This is your drink of choice when you're thirsty! examples: tea, juice, water | |||
|
|
|||
| `drink_other.json` -- "Drink" comestible that does not fit any other criteria. example: vinegar, mustard | |||
|
|
|||
| ### Solid | |||
|
|
|||
| `junkfood.json` -- comestible with the "junk" material. examples: cake, sugary cereal, nachos | |||
|
|
|||
| `sandwich.json` -- a "sandwich" is generally two slices of "bread" with something in between. examples: BLT, PB&J sandwich, fish sandwich | |||
|
|
|||
| `offal_dishes.json` -- comestible made of various offals. the offal types are: liver, brain, kidney, sweetbread, stomach. This must be the primary part of the dish. | |||
|
|
|||
| `seed.json` -- seeds | |||
|
|
|||
| `meat_dishes_human.json` -- comestible made of human flesh. examples: hobo helper, tio taco | |||
|
|
|||
| `meat_dishes.json` -- comestible made with meat. | |||
|
|
|||
| `raw_veggy.json` -- comestible that is a vegetable in its raw form. | |||
|
|
|||
| `irradiated_veggy.json` -- comestible that is an irradiated vegetable. has an indefinite shelf life. | |||
|
|
|||
| `raw_fruit.json` -- comestible that is a fruit in its raw form. | |||
|
|
|||
| `irradiated_fruit.json` -- comestible that is an irradiated fruit. has an indefinite shelf life. | |||
|
|
|||
| `veggy_dishes.json` -- comestible made of vegetables. | |||
|
|
|||
| `bread.json` -- comestible that is either a bread starter, or a cooked bread. | |||
|
|
|||
| `wheat.json` -- either raw wheat, or made of wheat | |||
|
|
|||
| `egg.json` -- either an egg, or made of egg | |||
|
|
|||
| `dairy.json` -- made of milk | |||
|
|
|||
| `mushroom.json` -- a mushroom or made of mushrooms | |||
|
|
|||
| `nuts.json` -- a nut or made of nuts | |||
|
|
|||
| `other.json` -- if you made it here, your comestible doesn't fit any other category! | |||
| @@ -0,0 +1,55 @@ | |||
| # Issues | |||
|
|
|||
| ## How to create new issues properly | |||
|
|
|||
| GitHub issues are used for everything from bug reporting to suggesting long-term ideas. You can make everything run much smoother by following some simple rules. | |||
|
|
|||
| ### Rule zero | |||
|
|
|||
| Always give your issue a meaningful title as this is the first thing anyone will see. | |||
|
|
|||
| Note: `[CR]` and `[WIP]` "tags" are meaningful only for PRs. All open issues by definition are request for comments and work in progress. | |||
|
|
|||
| ### Bug reports | |||
|
|
|||
| Before you submit a bug always search the current list of issues to see if it has been reported already. | |||
|
|
|||
| Your bug report has to include: | |||
|
|
|||
| - On what OS did you experience the problem (Windows, Linux, OS X etc.) | |||
| - What version were you playing: | |||
| - Tiles or Curses (text-based) | |||
| - Version string (preferably full version e.g. "0.C-4547-g3f1c109", or Jenkins build number e.g. 3245) | |||
| - Description of the problem written in a way that enables anyone to try and recreate it | |||
|
|
|||
| Your bug report may include: | |||
|
|
|||
| - Screenshot(s) as some things are best explained visually | |||
| - Save file (e.g. link to a dropbox upload) | |||
|
|
|||
| Bonus points for: | |||
|
|
|||
| - Checking if the bug exists under latest experimental build | |||
| - Checking if it is OS specific | |||
|
|
|||
| The OS and CDDA version are very important - with the pace of changes here it is possible the bug you have encountered has already been fixed. After that reproducibility is the key, so write your report with all the necessary details. | |||
|
|
|||
| ### Enhancements and addition ideas | |||
|
|
|||
| We have hundreds of issues open - most of them are ideas and suggestions. If you have a general idea or anything that can't be easily described in terms of *current* code changes you'd be better off suggesting it in the appropriate section of [the forum](https://discourse.cataclysmdda.org/). You'll also get much broader exposure for your idea there. After developing a polished idea on the forum, it should be easy to make a GitHub issue for it. | |||
|
|
|||
| Please first search if something like what you have on mind has been already proposed. If so, feel free to join the discussion! If your idea is related but sufficiently different, open a new issue and refer to the older discussion (use GitHub's `#issue_number` reference system). | |||
|
|
|||
| Remember to take part in the discussion of your suggestions. | |||
|
|
|||
| ### Questions | |||
|
|
|||
| You should direct your questions to the forum or ask on IRC. You should also read the included documentation and additional text files, e.g. `COMPILING.md` if you have problems building. | |||
|
|
|||
| ## Bounties | |||
|
|
|||
| We keep the development and direction of the game community-driven so placing a bounty *does not* necessarily mean that change will be incorporated into the main game. But it may be incorporated as a mod (or not). As such feel free to post bounties on what you like, but remember we don't do "bounty-driven" development. Good way of thinking about bounties is as encouragement for contributors to work on a particular issue, and certainly not as "paying for features". | |||
|
|
|||
| ## Issue resolution | |||
|
|
|||
| We do not assign people to issues. If you plan to work on a bug fix or a validated idea feel free to just comment about that. Actual PRs are of much greater value than any assignments. In general the first correct PR about something will be the PR that will get merged, but remember: we are using Git - you can collaborate with someone else easily by sending them patches or PRs against their PR branch. | |||
| @@ -0,0 +1,9 @@ | |||
| Cataclysm is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA. | |||
|
|
|||
| The Square font (data/font/square.ttf) is copyright Wouter van Oortmerssen, licensed under Creative Commons Attribution 3.0 Unported License. See http://strlen.com/square for more information. | |||
|
|
|||
| GNU Unifont (data/font/unitfont.ttf) is licensed under GNU General Public License v2+ with the GNU font embedding exception. Visit http://unifoundry.com/LICENSE.txt for details. | |||
|
|
|||
| CATCH unit-test framework is licensed under the Boost Software License. Visit https://github.com/philsquared/Catch/blob/master/LICENSE.txt to read the license. | |||
|
|
|||
| getpost (tools/json_tools/format/getpost.h) is licensed under the MIT license, see file for text of license. | |||
| @@ -1,42 +1,69 @@ | |||
| [](https://travis-ci.org/CleverRaven/Cataclysm-DDA) | |||
| [](https://coveralls.io/github/CleverRaven/Cataclysm-DDA?branch=master) | |||
| [](https://www.codetriage.com/cleverraven/cataclysm-dda) | |||
|
|
|||
| # Cataclysm: Dark Days Ahead | |||
|
|
|||
| Cataclysm: Dark Days Ahead is a roguelike set in a post-apocalyptic world. While some have described it as a "zombie game", there's far more to Cataclysm than that. Struggle to survive in a harsh, persistant, procedurally generated world. Scavenge the remnants of a dead civilization for for food, equipment, or, if you're lucky, a vehicle with a full tank of gas to get you the hell out of Dodge. Fight to defeat or escape from a wide variety of powerful monstrosities, from zombies to giant insects to killer robots and things far stranger and deadlier, and against the others like yourself, that want what you have... | |||
| Cataclysm: Dark Days Ahead is a roguelike set in a post-apocalyptic world. While some have described it as a "zombie game", there is far more to Cataclysm than that. Struggle to survive in a harsh, persistent, procedurally generated world. Scavenge the remnants of a dead civilization for food, equipment, or, if you are lucky, a vehicle with a full tank of gas to get you the hell out of Dodge. Fight to defeat or escape from a wide variety of powerful monstrosities, from zombies to giant insects to killer robots and things far stranger and deadlier, and against the others like yourself, who want what you have... | |||
|
|
|||
|
|
|||
| ## Download | |||
|
|
|||
| The following binary releases are available: | |||
|
|
|||
| * [Windows Executable](http://www.cataclysmdda.com/Downloads/CataDDA0.4.zip) | |||
| * [OS X 10.6+ Executable](http://www.cataclysm.glyphgryph.com/Downloads/CataDDA0.4.tar.gz) | |||
| Visit [our website](http://cataclysmdda.org) for download links to all stable and experimental releases. | |||
|
|
|||
| The source can either be downloaded as [an archive](https://github.com/TheDarklingWolf/Cataclysm-DDA/archive/master.zip), or you can clone it from [our GitHub repository](https://github.com/TheDarklingWolf/Cataclysm-DDA/). | |||
| The source can either be downloaded as [an archive](https://github.com/CleverRaven/Cataclysm-DDA/archive/master.zip), or you can clone it from [our GitHub repository](https://github.com/CleverRaven/Cataclysm-DDA/). | |||
|
|
|||
|
|
|||
| ## Compile | |||
|
|
|||
| The latest instructions on how to compile can be found on [our wiki](http://www.wiki.cataclysmdda.com/index.php?title=How_to_compile). | |||
| Please read [COMPILING.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING.md) - it covers general information and more specific recipes for Linux, OS X, Windows and BSD. See [doc/COMPILER_SUPPORT.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/doc/COMPILER_SUPPORT.md) for details on which compilers we support. And you can always dig for more information in [doc/](https://github.com/CleverRaven/Cataclysm-DDA/tree/master/doc). | |||
|
|
|||
| We also have the following build guides: | |||
| * Building on Windows with `MSYS2` at [COMPILING-MSYS.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING-MSYS.md) | |||
| * Building on Windows with `vcpkg` at [COMPILING-VS-VCPKG.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING-VS-VCPKG.md) | |||
| * Building with `cmake` at [COMPILING-CMAKE.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING-CMAKE.md) (*unofficial guide*) | |||
|
|
|||
| ## Contribute | |||
|
|
|||
| Please see [CONTRIBUTING.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/CONTRIBUTING.md) for details. | |||
| Cataclysm:Dark Days Ahead is the result of contributions from over 800 volunteers under the Creative Commons Attribution ShareAlike 3.0 license. The code and content of the game is free to use, modify, and redistribute for any purpose whatsoever. See http://creativecommons.org/licenses/by-sa/3.0/ for details. | |||
| Some code distributed with the project is not part of the project and is released under different software licenses, the files covered by different software licenses have their own license notices. | |||
|
|
|||
| [](https://www.bountysource.com/trackers/146201-clever-raven-cataclysm-dda?utm_source=146201&utm_medium=shield&utm_campaign=TRACKER_BADGE) | |||
|
|
|||
| Please see [CONTRIBUTING.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/.github/CONTRIBUTING.md) for details. | |||
|
|
|||
| ## Community | |||
|
|
|||
| Forums: | |||
| https://discourse.cataclysmdda.org | |||
|
|
|||
| Wiki: | |||
| http://cddawiki.chezzo.com/cdda_wiki/index.php | |||
|
|
|||
| GitHub repo: | |||
| https://github.com/CleverRaven/Cataclysm-DDA | |||
|
|
|||
| IRC: | |||
| `irc.freenode.net` ; `#CataclysmDDA` | |||
| http://webchat.freenode.net/?channels=#CataclysmDDA | |||
|
|
|||
| Official Discord: | |||
| https://discord.gg/jFEc7Yp | |||
|
|
|||
| ## Frequently Asked Questions | |||
|
|
|||
| #### Is there a tutorial? | |||
|
|
|||
| Yes, you can find the tutorial in the **Special** menu at the main menu. You can also access documentation in-game via the **?** key. | |||
| Yes, you can find the tutorial in the **Special** menu at the main menu (be aware that due to many code changes the tutorial may not function). You can also access documentation in-game via the `?` key. | |||
|
|
|||
| #### How can I change the key bindings? | |||
|
|
|||
| Press the `?` key, followed by the `1` key to see the full list of key commands. Press the `+` key to add a key binding, select which action with the corresponding letter key `a-w`, and then the key you wish to assign to that action. | |||
|
|
|||
| #### How can I start a new world? | |||
|
|
|||
| **Reset** on the main menu will generate a fresh world for you. | |||
| **World** on the main menu will generate a fresh world for you. Select **Create World**. | |||
|
|
|||
| #### I've found a bug / I would like to make a suggestion. What should I do? | |||
|
|
|||
| Please submit an issue on [our GitHub page](https://github.com/CleverRaven/Cataclysm-DDA/issues/). If you're not able to, send an email to `TheDarklingWolf@gmail.com`. | |||
| Please submit an issue on [our GitHub page](https://github.com/CleverRaven/Cataclysm-DDA/issues/). If you're not able to, send an email to `kevin.granade@gmail.com`. | |||
| @@ -0,0 +1,16 @@ | |||
| *.iml | |||
| .gradle | |||
| /local.properties | |||
| /.idea/workspace.xml | |||
| /.idea/libraries | |||
| .DS_Store | |||
| /build | |||
| /captures | |||
| .externalNativeBuild | |||
| !config/ | |||
| /app/jni/libintl-lite | |||
| /app/jni/mpg-123 | |||
| /app/jni/SDL2 | |||
| /app/jni/SDL2_image | |||
| /app/jni/SDL2_mixer | |||
| /app/jni/SDL2_ttf | |||