Installation 0.5.3

From Synekism Wiki
Jump to: navigation, search

Minimum Version: v0.5.3 - Jan. 1, 2014

Synekism should be pretty simple to install on a supported version of Windows. Please do contact support@synekism.com if you're having any trouble.

If you're trying to install it on Linux you might want to also read the linux installation page.

Normal Installation

  1. Log in using the user account you wish Synekism to run on
    Note: this is important as the installer will create special folders in the current user's My Documents folder for such data as save files and mods.
  2. Download the latest installer at:
    http://www.synekism.com/downloads.php
  3. Double-click on the installer executable called: SynekismSetup.#.#.#.#.exe
  4. Follow the steps for each screen.

Minimum System Requirements

* This is just Synekism's installation footprint. It does not include space for any user generated content such as the city save files.

What Is Installed

We do our best to remove everything we install once you decide to uninstall Synekism. However, due to various limitations, some bits of garbage might be left over. For those keen on keeping a tidy system here is a rather exhaustive list of everything we create and touch when you install Synekism using its installer.

Temp

Temp directory is usually under: C:\Documents and Settings\username\Local Settings\Temp for Windows XP and C:\Users\username\AppData\Local\Temp for any Windows newer than XP. These files are only used during installation and are removed by the installer after it's done with them.

  • GPU-Z.#.#.#.exe
    Used during installation to check for minimum graphics hardware requirements.
    Note: GPU-Z is a freeware tool available here: http://www.techpowerup.com/gpuz/
  • gpuz.xml
    Generated by GPU-Z, it contains full system specs (this is not sent anywhere, it's just used to check hardware capabilities). It is later copied to install directory as client_spec.xml.
  • client_spec.xml
    If the installer needs to upgrade an existing installation we copy this file from the existing installation directory back to the temp folder so we can nuke the existing installation folder without loosing this file (which was just generated). We then copy the file back and delete this temporary copy.

Program Files

This is under C:\Program Files\Synekism under a 32-bit OS or C:\Program Files (x86)\Synekism under a 64-bit OS. Of course, it can also be a user-specified location set during one of the installation screens.

Please note that you should not store any files in this folder as it is always completely deleted whenever a newer Synekism version is installed on top.

  • bin/D3DCompiler_43.dll - DirectX HLSL shader compiler needed because Synekism currently ships with raw shader code.
  • bin/D3DX9_43.dll - DirectX 9.0c library.
  • bin/d3dx10_43.dll - DirectX 10 library.
  • bin/d3dx11_43.dll - DirectX 11 library. Synekism does not currently support DirectX 11 but it will.
  • bin/Low.dll - Low-level Synekism library. Contains custom utility code like Synekism's own vector library and amended STL containers.
  • bin/msvcp100.dll - One of the Microsoft Visual C++ Redistributable libraries.
  • bin/msvcr100.dll - Another one of the Microsoft Visual C++ Redistributable libraries.
  • bin/Synekism.exe - Main Synekism executable. All shortcuts point to this guy. Run this to launch the game.
  • client_spec.xml - Partial system information generated upon install by GPU-Z and used to assist with technical support.
  • install_log.txt - A log of the installation process. Mostly for debugging purposes but also useful to see exactly what the installer did.
  • readme.txt - The readme file that contains mostly details on the currently installed version of Synekism.
  • Synekism.Uninstall.exe - Synekism's uninstaller.

My Documents

This is under C:\Users\username\Documents\Synekism under Windows Vista/7/8 and C:\Documents and Settings\username\My Documents\Synekism under Windows XP.

  • Ini - Contains .ini files used to persist Synekism settings. For more details on this see: Ini Settings.
  • Mods - Default mods folder.
  • Saves - Default save file folder.
  • Screens - Default location for screenshots and renders.

Desktop

This is under C:\Users\username\Desktop under Windows Vista/7/8 and C:\Documents and Settings\username\Desktop under Windows XP.

We only install a shortcut to the main Synekism executable if so indicated on the final screen of the installation.

Please note that regardless of whether or not you choose to install a Desktop icon during installation, Synekism's uninstaller will always delete any shortcut on the Desktop named: Synekism.

Start Menu

The main Synekism start menu folder is under C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Synekism and C:\Users\username\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Synekism under Windows Vista/7/8. Nothing is currently installed in the Start Menu in Windows XP.

  • Synekism - Shortcut to main executable.
  • Uninstall - Shortcut to uninstaller.

There is also an additional shortcut installed under C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Games:

  • Synekism - Shortcut to main executable.

Games Explorer

To add Synekism to the Games Explorer in Windows Vista and Windows 7, this folder is created:

C:\Users\username\AppData\Roaming\Microsoft\Windows\GameExplorer\{CDA814CA-DDE7-419f-BB9B-3F8FC44EF9EB}\PlayTasks\0

and this file is created inside:

C:\Users\username\AppData\Roaming\Microsoft\Windows\GameExplorer\{CDA814CA-DDE7-419f-BB9B-3F8FC44EF9EB}\PlayTasks\0\Play.lnk

Note that Synekism is not a Games for Windows certified game.

Registry

These can be verified by going to: Start Menu > All Programs > Accessories > Run, then typing regedit.exe and pressing OK.

There are two keys that are filled with values:

  • 32-bit OS:
    • HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\Synekism.exe\
    • HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\Synekism\
  • 64-bit OS:
    • HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\App Paths\Synekism.exe\
    • HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Synekism\

They each contain these values:

  • ...\App Paths\Synekism.exe\
    • (Default) - Absolute path to the Synekism main executable.
  • ...\Uninstall\Synekism\
    • (Default) - Empty
    • Comments - Brief summary of this page: Synekism.
    • DisplayIcon - Absolute path to the Synekism main executable's icon (which is inside the main executable file).
    • DisplayName - Something in the form of: Synekism #.#.#.#.
    • DisplayVersion - Installed Synekism version as a string.
    • EstimatedSize - The estimated size of the Synekism installation. This does not include user generated content.
    • InstallLocation - The path to the Synekism installation folder.
    • NoModify - Indicates that the uninstaller can only uninstall Synekism completely and cannot modify the installation.
    • NoRepair - Indicates that the uninstaller can only uninstall Synekism completely and cannot repair the installation.
    • Publisher - Idimoris
    • UninstallString - Absolute path to Synekism's uninstaller.
    • URLInfoAbout - Link to Synekism's website: http://www.synekism.com.