C++ C CMake Lua Shell Objective-C
Clone or download
Permalink
Failed to load latest commit information.
RTTR Remove unneeded jpg files. Apr 19, 2018
bugle Move more out of build dir and update Jenkinsfile Oct 8, 2016
cmake Fix build server Aug 9, 2018
common Factor out optimizations and simplify platform files Jul 10, 2018
contrib Improve Lua handling Jun 4, 2018
debian Create directories with '-p' Aug 7, 2018
driver Add screenshot function Feb 11, 2018
libendian @ 710e17a update lineendings Feb 9, 2018
liblobby @ 0dc47a1 Move RTTR_Version to rttrConfig Jul 10, 2018
libsiedler2 @ 0acf283 Fix apple build Jul 12, 2018
libutil @ a17b13a Fix build server Aug 9, 2018
macos Create Branch 'master' for '/s25client/trunk' at Subversion Revision … Dec 22, 2010
mygettext @ 08f2f78 update lineendings Feb 9, 2018
release Fix build server Aug 9, 2018
rttrConfig Fix GetYear Aug 12, 2018
s-c @ 453a4b2 Fix missing macros Jul 10, 2018
s25edit @ 6c42649 Add better warning message Feb 13, 2018
s25update @ 65d3138 update lineendings Feb 9, 2018
src Fix wrong check for failed construction Aug 13, 2018
tests Rework override handling in loader Jan 5, 2018
utils Empty build directory Jul 7, 2018
win32 STY: dos2unix Nov 9, 2017
.clang-format Update kaguya and clangformat + format srcs Oct 19, 2017
.gitattributes update lineendings Feb 9, 2018
.gitignore Empty build directory Jul 7, 2018
.gitmodules Generate version from within CMake Jul 11, 2018
.travis.yml Create directories with '-p' Aug 7, 2018
CMakeLists.txt Fix build server Aug 9, 2018
COPYING STY: eol Dec 1, 2017
Doxyfile.in STY: eol Dec 1, 2017
Jenkinsfile Fix build server Aug 9, 2018
README.md Add install instructions to README Aug 7, 2018
appveyor.yml Empty build directory Jul 7, 2018
codecov.yml Add Editor Nov 7, 2017
contrib.cmake Make PLATFORM_* variables optional Jul 8, 2018
copyDepsToBuildDir.cmake Make PLATFORM_* variables optional Jul 8, 2018
cpp.hint Refactor event manager for better tests Oct 11, 2017
start.sh Turn start.sh into plain sh(1) scripts Sep 2, 2015
start.sh.cmake Move more out of build dir and update Jenkinsfile Oct 8, 2016

README.md

Return To The Roots

"Return To The Roots" is a fan-project, which aims to renew the original The Settlers 2.

We aim to extend new features such as a multiplayer mode via internet as well as the support for modern hardware and several operating systems like Windows XP/Vista/Seven, Linux and MacOS X. Likewise we want to invent some smaller upgrades. Unfortunately it is necessary to rewrite the whole game, but we will stick to the original graphics and sounds, because they are still common and nice to be heard or seen. So you will still need an original "The Settlers 2 Gold Edition" version to play Return To The Roots.

see more information on http://www.rttr.info

Current Build Info

Travis CI: Travis CI Build Info

Appveyor: Appveyor CI Build Info

Coverage: Coverage Status / codecov

How to install

  • Download the game for your OS at siedler25.org
    • stable: Usually more stable
    • nightly: Latest features and bug fixes, but might be broken sometimes
  • Extract into a folder of your choice
  • Locate the file put your S2-Installation in here in that folder (usually at the root or in S2)
  • Copy the DATA and GFX folder from the original The Settlers II Gold into the folder containing the above file
  • Start rttr.bat/rttr.sh or the bundle (OSX only) to auto-update and start the game
    • Alternatively start s25client directly, but updates and music might be missing

How to build

On Linux or Darwin/MacOSX

Prerequisite Linux:

Prerequisite MacOSX:

  • cmake
  • git
  • boost
  • sdl
  • sdl_mixer
  • gettext (make sure it is in your path with e.g. brew link --force gettext)
  • miniupnpc All of them can be installed via homebrew

Steps:

git clone --recursive https://github.com/Return-To-The-Roots/s25client s25client
cd s25client
mkdir -p build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make

Optimizations:

There are various CMake options to control the build and optimization including ARM (Rasberry PI etc.) related ones. Examples:

  • RTTR_ENABLE_OPTIMIZATIONS/RTTR_ENABLE_WERROR
  • RTTR_OPTIMZATION_VECTOR_EXT (Non-Windows x86/x64 only)
  • RTTR_OPTIMZATION_TUNE (Non-Windows only)
  • RTTR_TARGET_BOARD (ARM only) See the description in CMake-GUI/ccmake for details.

Note that due to the use of submodules you always need to git pull && git submodule update --init --recursive to get the latest version. (The --init and --recursive arguments are only required should we add new submodules to the existing set.)

On Windows

Prerequisites:

Steps:

  • Clone GIT Repository from https://github.com/Return-To-The-Roots/s25client
    • Using Git bash:

      git clone --recursive https://github.com/Return-To-The-Roots/s25client s25client
      
    • OR using TortoiseGit:

      • Rightclick -> "Git clone..."
      • Put in https://github.com/Return-To-The-Roots/s25client as URL
      • Select "Directory" to clone to
      • press OK
      • Rightclick on the newly created folder -> TortoiseGit-> Submodule Update
      • Make sure all modules are selected and "Initialize submodules (--init)" is checked
      • press OK
  • Extract contrib/full-contrib-msvc.rar to contrib (so that contrib/full-contrib-msvc/bin, contrib/full-contrib-msvc/include and contrib/full-contrib-msvc/lib exist)
  • If you havent installed boost, install boost Fast Way:
    • extract boost-1.55.zip (i.e to contrib/boost, so that contrib/boost/bootstrap.bat exist)
    • run that "bootstrap.bat"
    • run created "b2.exe": this should build boost Notice: if you have multiple Visual Studio versions installed, use the latest one with the "toolset"-parameter. i.e "b2 toolset=msvc-14.0" for Visual Studio 2015
    • run "b2 install --prefix=%CD%": this should install everything so the system can find it Notice: Don't forget to add the toolset parameter if you already used it before
  • Use cmake-gui:
    • "Where is the source code": Select checked out directory
    • "Where to build the binaries": Select "build" directory (create if required)
    • Press configure
    • Select your compiler version (i.e Visual Studio 2010 x86)
    • If it can't find boost:
      • "Add Entry"
      • Enter as "Name" "BOOST_ROOT" (exact casing!)
      • Select for "Type" "PATH"
      • Enter boost installation path for "Value"
      • Press ok
    • Press generate
  • Open and use build/s25client.sln

--

for advanced info or help see FAQ in the wiki or http://www.rttr.info