JSettlers is Open Source, First Alpha Released!

Hello all!

UPDATE 26.04.2015 22:47: New release with some bug-fixes and an easier installation. Furthermore, new Java OpenGL libraries should improve rendering on more platforms.

UPDATE 07.04.2015 22:47: I just published a new release with some bug-fixes.

I’m happy to announce that the source code of our Settlers 3 remake is now fully available on GitHub. The repository can be found at https://github.com/jsettlers/settlers-remake. Please read the README.md for an installation guideline and a developer guide, if you want to assist the development. There you can also download the first alpha release of the game.

Before you start the game, have a brief look at the manual, as there are some extra features in the UI, you should now about.

Also note that you will need to have an original version of “The Settlers 3” installed on your computer, as this game is using the original graphics and sounds.


  1. This game is only in an alpha status! So be aware of bugs, missing features (no AI, only Romans playable, missing buildings…), an “unfinished” UI and frequent code changes possibly breaking your savegames. I’m looking forward to your reports and help in improving this game!
  2. I’m still looking for a good name and I’m open for your (serious) proposals.
  3. When following the installation instructions for JSettlers, you will also get the Map Editor installed. Feel free to design great maps and send them to me / commit them to the repository.
  4. I will try to update / improve the documentation more and more. If you have a special request / see a certain need, let me know!

Best regards, have fun with the game + many thanks for your patience!


24 thoughts on “JSettlers is Open Source, First Alpha Released!

  • 25. January 2017 at 20:26

    Hey. Super cooles Projekt. Endlich wieder S3 spielen ist ein Traum.
    Wie sieht es mit Updates aus, seid ihr am Ball oder verfliegt alles?
    Habt ihr einen Donate-Link um euch zu unterstützen?


    • 27. January 2017 at 21:39

      Hi Peter,

      after I didn’t have some much time last autumn, I’m not fully back in the project. So we are still continuing. However, we could always need more developers! At the moment Tom Pratt is totally reworking the Android App, while I’m freshing up some code in the game logic, fix some bugs and will try to get the stock into the game. You can always follow the newest developments on our Github project page.

      Regarding donations: No, we don’t have a donate link yet… I should really consider creating one 🙂

      Best regards,

  • 16. May 2016 at 20:16

    Tried to compile and run it via gradlew on Windows 7 64bit (+Java 8 64bit). Checked out a clone via GIT, set up development environment (Android Studio / Eclipse), configured PATH, JAVA_HOME and ANDROID_HOME accordingly … Swing builds fine … thought i was lucky and had the goal achieved … however this is what happens when i run “gradlew run”, i get:

    No default command line options file found.
    Options loaded: {}
    Source: (file:/C:/Users/XYZ/Documents/Projekte/Java/jsettlers/jsettlers.main.swing/build/classes/main/ )
    java.lang.ArrayIndexOutOfBoundsException: 232
    at jsettlers.graphics.reader.AdvancedDatFileReader.getSettlerPointers(AdvancedDatFileReader.java:614)
    at jsettlers.graphics.image.MultiImageMap.addSequences(MultiImageMap.java:104)
    at jsettlers.graphics.reader.AdvancedDatFileReader.generateImageMap(AdvancedDatFileReader.java:646)
    at jsettlers.graphics.map.draw.ImagePreloadTask.run(ImagePreloadTask.java:121)
    at java.lang.Thread.run(Thread.java:745)
    Exception in thread “main” java.lang.ExceptionInInitializerError
    at jsettlers.main.swing.lookandfeel.JSettlersLookAndFeel.install(JSettlersLookAndFeel.java:69)
    at jsettlers.main.swing.SwingManagedJSettlers.createJSettlersFrame(SwingManagedJSettlers.java:209)
    at jsettlers.main.swing.SwingManagedJSettlers.main(SwingManagedJSettlers.java:65)
    Caused by: java.awt.image.RasterFormatException: (x + width) is outside raster
    at sun.awt.image.IntegerInterleavedRaster.createWritableChild(IntegerInterleavedRaster.java:467)
    at java.awt.image.BufferedImage.getSubimage(BufferedImage.java:1202)
    at jsettlers.main.swing.lookandfeel.ui.SettlersLabelUi.(SettlersLabelUi.java:61)
    at jsettlers.main.swing.lookandfeel.factory.LabelUiFactory.(LabelUiFactory.java:40)
    … 3 more
    :jsettlers.main.swing:run FAILED

    FAILURE: Build failed with an exception.

    * What went wrong:
    Execution failed for task ‘:jsettlers.main.swing:run’.
    > Process ‘command ‘C:\Program Files\Java\jdk1.8.0_91\bin\java.exe” finished wi
    th non-zero exit value 1

    * Try:
    Run with –stacktrace option to get the stack trace. Run with –info or –debug
    option to get more log output.


    Total time: 5.541 secs

    Strange thing though, it started once and i was able to choose the original Settlers3 Folder … however it instantly crashed afterwards … and now i cannot restart the game any longer. "git status" does not show any changed files in my local repository. Where do you store the selection of the Settlers3 folder, i've made? Also: Do you guys got a board or an IRC channel or something? I was really searching hard and could not find anything. Thanks for your great work so far btw, i'm really looking forward to get more into this project one day 🙂

    • 16. May 2016 at 20:27


      thanks for the stack trace. I will file an issue for this. I haven’t seen that before.
      Regarding a board or something like that: No, not really. Atm we mainly communicate via the tickets on Github. However, we plan to set something up for easier communication.

      The setting where your settlers installation is, is stored in your user profile. Search for a file named .config in a folder named .jsettlers. On Windows this should be in C:\Users\—YOUR USERNAME—\AppData\Roaming\.jsettlers

      Best regards

      EDIT: I filed the issue here https://github.com/jsettlers/settlers-remake/issues/439. Please have a look as we might have further questions to find the problem.

  • 5. September 2015 at 10:43

    Please never stop developing this project – i love settlers 3 and it is so great that you take care of it!!!

  • 15. June 2015 at 20:55

    First of all, awesome project! I downloaded the alpha and it’s running nicely!

    I’ve got a question: In your videos, and some screenshots, there’s the full Settlers 3 Menu, which i’d love to have. But on the alpha version, there’s just a simple GUI, that’s missing a lot of functions. Will the original one (with some mods for mobile devices) return?

    Another question, i’d love to support you in any way. Is there a way to donate some money to you? I’ve grown up with Settlers 3 and still love the game! I’m not too deep into Java programming, so i wouldn’t be a great help;)

    Please reply!=)
    best regards DerKrawallkeks

    PS: I’m running a youtube channel with 3000+ subscribers, if i can help you in any way with that, i’d be happyto do so!

  • 8. June 2015 at 10:35


    Well done guys on making a test for us to play with! It’s awesome!!!!

    Only one thing I’m struggling with is the menu as it’s in another language, is there a way to make it English?

    Other than that it’s ACE!!!! thanks guys

    • 8. June 2015 at 10:37

      Forgot to mention, I’m using a Samsung galaxy s4 zoomed out the frame rate does drop a bit, but it is 100% compatible with my phone for your future reference.

      Thanks keep going at it guys, on wards and up wards!!

      • 11. June 2015 at 15:06

        @David Draycott,

        the menu should already be in English… unfortunately, I don’t habe an English device.
        Nevertheless, I opened a ticket to ask other contributors to recheck if they also have this issue.

        Best regards,

        • 18. June 2015 at 20:17

          Thank you I’ve re-checked it but the menu says “Willkommen zu JSettlers” “neues spiel” “spielstand laden” etc

          Other than that excellent guy’s I’ve been playing it regardless it’s ace!!!

  • 24. May 2015 at 21:41

    Hallo !

    Boar, echt der Wahnsinn was ihr hier leistet ! Ich würde ja gerne mithelfen, aber dazu fehlt mir das knowledge. :/
    Naja, wollte euch eigentlich nur motivieren weiterhin am Ball zu bleiben, würde mich auf eine Beta extrem freuen (also mit AI etc…).
    Ich bin selber ein grosser Fan von Siedler 4, leider gehen mir die Multiplayer Probleme extrem aufm Keks. Daher würde ich ein S3 (oder irgend wann mal S4 😀 ?) Remake SEHR begrüssen.

    Danke für euer Engagement !

  • 25. April 2015 at 11:25

    bekomme es auf meinem pc leider nicht ans laufen.
    Habe alles mögliche ausprobiert, Pfad, /, usw.
    Bekomme immer die Fehlermeldung “hauptklasse konnte nicht gefunden oder geladen werden”
    Kann da jemand helfen?

    • 25. April 2015 at 11:44

      Hi Heffernan,

      what exactly are you doing to start the game? Which java version do you have installed? Please try to start the game from the command line as follows:
      java -jar JSettlers.jar (This must be executed in the JSettlers directory). What is the exact result of this?

      Furthermore: It’s best to post this issue on Github. Here you can create a new ticket, so it’s easiert to track it for all contributors.

      Best regards,

      • 25. April 2015 at 20:20

        C:\Windows\System32>cd “C:\Users\Heffernan\Desktop\Siedler”
        C:\Users\Heffernan\Desktop\Siedler>java -jar JSettlers.jar
        Der Befehl “java” ist entweder falsch geschrieben oder
        konnte nicht gefunden werden.

        Java version

        • 26. April 2015 at 10:27

          Hi Heffernan,

          it looks like your Java isn’t correclty installed. Probably you don’t have the PATH variable set to point to your Java installation (this is why it says “Der Befehl java …”). You can try to uninstall and then reinstall java, or you can follow the steps on this page: https://www.java.com/de/download/help/path.xml

          Please tell me if it worked 😉 + Good luck!

          • 26. April 2015 at 13:17

            -habe java neu installiert
            -den path aktualisiert
            neue Fehlermeldung :
            C:\Users\Heffernan\Desktop\Siedler>java -jar JSettlers
            Error: Unable to access jarfile JSettlers

            (beim Kollegen funktioniert es so, bei mir leider nicht)

          • 26. April 2015 at 13:18

            Did you try to start it with java -jar JSettlers.jar (don’t miss the -jar at the end of JSettlers).

          • 26. April 2015 at 14:42

            Fehler gefunden danke !!

            1. java -jar JSettlers.jar (ich hatte das .jar nicht geschrieben…..)
            2. Der Win Editor hat die config falsch gespeichert:

            #Folder containing the folders of the graphics and the sound files. If you want to specify multiple possible folders, use a “;” character for separation.settlers-folder=E:/BlueByte/Siedler3/

            Das “settlers-folder=E:/BlueByte/Siedler3/” muss in eine neue Zeile.
            Der WinEditor macht das nicht!!
            Habe es mit notepad++ gespeichert und es läuft !!

            thank you 🙂

          • 26. April 2015 at 14:45

            I’m glad you found the problem. Luckily, since the newest release, you don’t need to modify the config.prp file manually any more. 😉

  • 13. April 2015 at 19:20

    hi i want to download it on my samsung s5 can you say where i can download or give me a link i have looking for it bud i cant find it

    • 20. April 2015 at 16:05

      Hi Gordon,

      please check out our README.md on Github. There you find the steps to install JSettlers on your device. If you have trouble, please open a ticket on Github, so we can fix the issue.

      Best regards,

  • 7. April 2015 at 23:17

    So excited, thank you so much for this first release ! I’m going to test this 🙂

  • 5. April 2015 at 15:46

    Thank you so much!!!

    Finally I have sth I can have my hands on 😀
    Very excited about the first release!

    Hope you keep going strong & that you take care especially for current/future bug fixes & improved AI. By the way, is your first release working with AI? Have to test it immediately.

    I’m so happy about the news, wish you a nice easter!

    • 6. April 2015 at 15:40

      Hey SourceSeeker,

      thanks for your enthusiasm!
      Unfortunately there is no AI implemented yet. I think it’s important to get the game playable in multiplayer first. But help is always welcome 😉

      Best regards,


Leave a Reply

Your email address will not be published. Required fields are marked *