Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 3.74 KB

README.md

File metadata and controls

83 lines (50 loc) · 3.74 KB
Raw

Imperialism Remake

Home - Community - Sources - Download - Tasks - Contact

Getting Started

1. Access the source code

The source code is on GitHub. You can also download a zipped one-time snapshot. Otherwise just register with GitHub and fork the project.

2. Using Git

Download Git or on Windows install TortoiseGit which conveniently integrates git with the explorer.

Git is not easy. Be careful and read some instructions first. Among others I liked this tutorial.

  • Once you forked the project, clone it on your computer with "git clone https://github.com/USER/Imperialism-Remake.git"
  • Regularly get updates with fetch/pull
  • Programm as usual (commit)
  • When task is done, create pull request (by pushing?). Have never done this. Don't know how this works exactly.

3. Python

Download and install latest Python 3.X. The Python documentation is quite good.

32 or 64 bit on Windows

In principle it doesn't matter. I use 64 bit and also deliver packages in 64 bit only.

Third Party Modules for Python

Only PySide and PyYAML are required for running, Markdown and cx_Freeze are additionally required for developing.

PySide

PySide is a Python binding of the Qt framework (very similar to PyQt). Follow the installation instructions. On Windows you can also use these binaries.

Check the API documentation and also the underlying Qt 4.8 C++ API classes overview which is linked better.

PyYAML

PyYAML is required for running.

Markdown

Markdown is required for creating the HTML pages of the manual.

cx_Freeze

cx_Freeze is used for packaging Python and creating standalone versions.

4. Start

  • Execute "./tools/manual_markdown_converter.py" once with working directory "./tools"(all paths relative to repository root).
  • Run file "./source/start.py" with working directory "./".
  • Start with command line parameter "debug" for (more) output on the console.
  • A folder with log files and settings is created under "user folder/Imperialism Remake User Data" where "user folder" is the typical user folder of your system (Windows C:/Users/XXX/).

5. IDE

I use PyCharm Community Edition. Since the .idea folder is contained the project can probably be opened directly with PyCharm. Another nice IDE is Spyder.

6. Tools

  • Inno Setup is needed for the creation of the Windows installer.
  • Many graphics are edited with Inkscape.

7. Packaging

  • Run tools/package_vanilla.py to create package in the build folder.

On Windows:

  • Run tools/package_windows.py.
  • Download the VC 2010 x64 redistributable and store in folder build.
  • Run tools/installer_windows.iss with Inno Setup