Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

gtw123/ShenzhenMod

Repository files navigation

ShenzhenMod

A mod for SHENZHEN I/O.

Features

  • Adds a new prototyping area (sandbox) which is four times the size of the regular one.
  • Makes the simulation speed slider a bit wider in the sandbox, for more fine-grained speed control.
  • (Experimental) Increases the maximum simulation speed for the first three test runs and in the sandbox.
    • Note: This feature sometimes makes the game crash, so it's not enabled by default. See below for more info.
  • Supports both the Steam and GoG versions of SHENZHEN I/O.
  • Supports Windows, Linux and macOS.

Installing

Windows

  • First, back up your SHENZHEN I/O save files. This is strongly recommended as there is a risk that using this mod may corrupt your save files. Make a copy of My Documents\My Games\SHENZHEN IO and put it somewhere safe.
  • Download and unzip the latest release from https://github.com/gtw123/ShenzhenMod/releases
  • Run ShenzhenMod.exe
  • Follow the steps to install the mod.

Linux

  • First, back up your SHENZHEN I/O save files. This is strongly recommended as there is a risk that using this mod may corrupt your save files. Make a copy of $HOME/.local/share/SHENZHEN IO/ and put it somewhere safe.
  • Download and unzip the latest ShenzhenMod release from https://github.com/gtw123/ShenzhenMod/releases.
  • Run mono ShenzhenMod.exe
  • Follow the steps to install the mod.

macOS

  • First, back up your SHENZHEN I/O save files. This is strongly recommended as there is a risk that using this mod may corrupt your save files. Make a copy of ~/Library/Application Support/SHENZHEN IO/ and put it somewhere safe.
  • Download and install Mono from http://www.mono-project.com/download/stable/. Version 5.10.1 or later is recommended.
  • Download and unzip the latest ShenzhenMod release from https://github.com/gtw123/ShenzhenMod/releases.
  • Open a Terminal window and change into the unzipped folder.
    • Tip: Type cd, then a space, then drag the unzipped folder into the window then press enter.
  • Run mono32 ShenzhenMod.exe macos
  • Follow the steps to install the mod.

Using the new features in SHENZHEN I/O

  • To use the bigger sandbox, look for "Prototyping bigger ideas" in the puzzle list, just below "Prototyping new ideas".
  • Use middle-click-drag or alt-drag to scroll around the circuit board.

Upgrading from an earlier version of ShenzhenMod

No need to uninstall or unpatch first: simply run the new installer!

Enabling the "Increase max game speed" feature

This feature increases the maximum simulation speed. Unfortunately it can cause the game to crash on certain puzzles, especially in the bigger prototyping area, so it's not enabled by default.

To enable it:

  • Edit Shenzhen.exe.config and set "IncreaseMaxSpeed" to true". (If you're building from source, edit App.config instead.)
  • Run the installer again.

Building from source

Windows

Linux

  • Clone or download the repo from https://github.com/gtw123/ShenzhenMod
  • Install mono-devel, version 5.0 or later.
  • Open the ShenzhenMod folder.
  • Run nuget restore to download the dependencies.
  • Build using msbuild
  • Launch it via mono bin/Debug/ShenzhenMod.exe

macOS

Releasing a new version

  • Make sure you've built the solution in release.
  • Make sure you've updated the version number in AssemblyInfo.cs.
  • (Windows) Open a developer command prompt.
  • Run msbuild build-release.targets.
  • The zip file will be in the output directory.
  • Test the zip file.
  • Upload to GitHub.
  • Tag the release.

Credits

The following people have helped develop this mod, either directly or indirectly:

  • gtw123
  • 12345ieee
  • pseudonym404
  • csaboka
  • mathiscode