Readme for KaM Remake

Knights and Merchants Remake Demo
Brought to you by Krom and Lewin

Readme contents:
Description · System requirements · Installing · Gameplay · F.A.Q. · Known bugs · Dedicated Server · Feedback · Source Code · Credits · Legal notice

Description

The KaM Remake mod is an attempt to reinvigorate the original "Knights and Merchants: The Shattered Kingdom" strategy game. Our goals are to make it work on today's computers and operating systems, implement a fully featured online multiplayer system, as well as to fix the many bugs in the game engine. To do this we have started from scratch, writing our own code for the game engine but still relying on many original resource files. We assume that you own the original KaM game, (the installer checks for it) otherwise you should buy it - it's available in a number of online gaming stores.
The KaM Remake executable is freeware and is built by enthusiasts. Applications used: Delphi 6, Delphi 7, FastMM4, Lazarus, LNet, OpenGL, OpenAL, Overbyte ICS, PNGImage, zLib, MadExcept, libZPlay.

System Requirements

KaM Remake requires:
    - Microsoft Windows 98, XP, Vista or Seven;
    - 500MHz or faster processor;
    - 256MB or more of RAM;
    - 3D graphics accelerator OpenGL 1.4 compliant;
    - Sound card.

Installation

1. Run the installer and follow the installation instructions.
2. The installer will also install the OpenAL audio drivers (oalinst.exe) if they are not detected. The latest version can be found on the official OpenAL page: http://connect.creativelabs.com/openal/default.aspx
3. The KaM Remake uses the OpenGL rendering engine, so you need to have OpenGL drivers installed as well. Visit your graphics card manufacturer site to get the latest drivers available.
4. Launch the mod - KaM_Remake.exe or from the Desktop/Start Menu if you chose to create shortcuts.

Gameplay

The following shortcuts are available in the game:
Esc closes the open message or active tab in the game menu
F1-F4 opens corresponding tab in the gameplay menu
F5-F8 speeds up the game pace by x1 - x10
F11 will show debugging panel and menu
1-9 will select units or houses assigned to with Ctrl + 1-9 keys
B will place a beacon on map that your allies can see
P pauses the game
T while pressed will show teamnames over units in multiplayer
Del deletes the open message in game
Spacebar goes to the location of the open message in game
←↑→↓ cursor keys will move you around the map
Scrolling the Mouse wheel will zoom in and out
← backspace will reset zoom back to 100%

For more detailed information about game shortcuts please visit our Wiki page:
https://github.com/Kromster80/kam_remake/wiki/Controls

Installing add-on maps:
1. Create a sub-folder in the Maps folder of the KaM Remake and name it, for example, "My New Map".
2. Put inside .dat and .map files of the map and rename them accordingly "My New Map.dat" and "My New Map.map". File names should match folder name exactly.
3. You can also make an optional file called "My New Map.txt" which will contain the mission description and other information. Use the same format as the missions provided with the Remake. No official format information will be released because this file will probably be changed later on.

Adding custom music:
You can put your MP3/OGG files into the Music folder of the KaM Remake, and they will be included into the playlist automatically.

F.A.Q.

Silent crashes:
If the KaM Remake crashes silently during startup please send the log file to contact@kamremake.com along with any other information that might be of use.

Low framerate:
If you have ridiculously low framerate in game it might be because your OpenGL drivers are out of date. See the OpenGL version information in the top-left corner of the main menu, it should be at least 1.4.x. If it is less you need to update your graphics card drivers (check your card manufacturers website).

Game errors:
Sometimes when something unexpected happens you will get an "An error has occurred in the application" message. Please click the Send Bug Report button to send the crash report to us. Enter your name and email address in the form if you would like us to be able to contact you about the crash. Having the crash report will help us to fix the bug.

Known bugs and limitations

Unit training in Town Hall and Siege Workshop is not functioning.
AI behavior is still limited.

Dedicated Server

Executables for the multiplayer dedicated server are included, available for Windows and Linux x86 and x86_64. The server listens for connections on a TCP port (56789 by default) and acts as a hub to trasfer the data between clients. The dedicated server does not understand gameplay, it simply moves packets around. The first client to join a room will be assigned hosting rights allowing them to setup the game. If that client disconnects, the next one in the list will be assigned hosting rights.
The server can be configured from the file KaM_Remake_Settings.ini. (created on the first of the game or server) Options for the dedicated server are in the section [Server].
To use in a LAN game, first make sure the server will not be published to the master server by setting "AnnounceDedicatedServer=0" in the INI file. (see above) Then start the dedicated server and ensure it is running properly (it should say "Listening on port 56789") Please ensure your firewall is allowing clients to connect to the server, by allowing TCP port 56789. (or whichever you chose) You may then connect to it from the same computer and/or other computers. (For the same computer, connect to the address 127.0.0.1 or localhost)
To use on the internet, you must forward the TCP port 56789 (or whichever you chose) from your router to your PC running the dedicated server. (for more information on port forwarding visit http://portforward.com/) Tell your friends to connect to your server name from the list if you chose to make your server publicly announced, or your external IP address if not, which is displayed to you on the homepage of http://portforward.com/. If you are playing on the same computer that is running the dedicated server, or on the same LAN, connect to its IP address as you would for a LAN game.

Note: The dedicated server is not required to play multiplayer. Clicking "Start Local Server" or "Start Internet Server" from the network menu has the same effect, except you must participate in the game and the server cannot be left to maintain itself. The dedicated server is only necessary if you want to provide a server without playing. The main purpose of the dedicated server is to allow servers to be hosted 24/7, which players can join and participate in any time they like. If you are able to provide this service we would be pleased.

The Linux builds have been tested on Fedora and Ubuntu. Any queries or comments regarding the Linux builds should be sent to Lewin. (lewinjh@gmail.com).

Feedback

Please use the forum or email (see below) to give us feedback. We would love your comments, suggestions, compliments, etc.
If you can offer some help in Delphi coding, menu design, documentation, graphics, sounds, translation or ideas for improvement - please drop us an email or write on the forum.

Source Code

The KaM Remake source code is available at our project page:
https://github.com/Kromster80/kam_remake
Here you can find our game Wiki:
https://github.com/Kromster80/kam_remake/wiki
We encourage you to submit bugs using built-in interface:
https://github.com/Kromster80/kam_remake/issues

Credits

Lead programmer - Krom (kromster80@gmail.com)
Programmer - Lewin (lewinjh@gmail.com)
Thanks to Alex who introduced the core design back in 2008
Thanks to StarGazer, who drew Marketplace, new cursors and icons for user interface, also to Malin who drew marketplace wares.
Huge thanks to the KaM community and its active members (Free_sms_kam, Harold, Humbelum, JBSnorro, The Knight, Litude (Real Hotdog), Merchator, Nick, Thunderwolf, Vas and many others) who helped us with decoding, advice, ideas and encouragement.
Icons from famfamfam and FatCow are used in the KaM Remake.

Legal notice

Commercial use is prohibited.
Any used names, symbols or other copyrighted material is the property of the respective owners.
We do not take any responsibility if this mod harms your software or hardware.
For obvious reasons publishing and/or sharing of this mod in any form is not allowed without this readme file.
You can upload this mod to your site/server/homepage, but please let us know first.
We assume that you (end user/player) own a licensed copy of the game KaM, otherwise you should buy the game before using this mod. Failing to do so will be breaching the license agreement.