Micropolis

Micropolis is the Open Source Release of the original SimCity source code. This is a Java rewrite fork based on MicropolisJ by Jason Long, which was first released in Feburary 2013. MicropolisJ was functionality-wise almost equivalent to the TCL/Tk edition

The original game, SimCity, was developed by Will Wright. Don Hopkins released a GPL open source version named Micropolis as a part of the One Laptop Per Child (OLPC) program.

Prerequisites

To install and run this game, you need to install the Java Runtime Environment. You can get Java from https://www.java.com/

For development, please install the Java Development Toolkit. I recommend OpenJDK. You'll find an installation instruction here: https://openjdk.java.net/install/

Running

The release archive comes with start scripts that ease the process of running the game.

Linux and Mac

Download the Tar archive of the latest version of Micropolis. x.x.x is the version number

(1) Extract the tar archive: tar xf /path/to/micropolis-x.x.x.tar

(2) Run ./micropolis-x.x.x/bin/micropolis to start the game

Windows

Download the ZIP archive of the latest version of Micropolis.

(1) Extract the ZIP archive by double-clicking on the file

(2) Double-click on micropolis.bat within the directory bin

Development

The micropolisj.engine package contains the guts of the city simulation. It has no dependencies on the front-end or any particular graphical system.

The micropolisj.gui package provides the user interface for the game. It renders the city, controls the speed of the simulation, and responds to event messages from the engine.

Building

A Gradle wrapper is included, so please just run

./gradlew build

to build the software and run the tests.

Localization

Unless you are an English speaker, you may like to run Micropolis in your own language. Micropolis is designed to be run in any language, but needs translators to provide the translated text to display.

If you want to translate the game to another language, please first determine the ISO 639-1 language code of your target language, e.g. for Spanish use es (lower case). A list of language codes can be found here: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Fork the repository on GitHub and clone it locally.
Create a copy of each property file in src/main/resources/strings and rename the copy according to your language code. This little bash code will help you:

    export language_code=es # change this according to your language
    find src/main/resources/strings -regex '.*/\([A-Za-z]*\)\.properties' -exec sh -c 'filename={}; cp $filename ${filename%.properties}_$language_code.properties' \;

Translate the lines within the new resources bundles.
Create a pull request.

File Format

Save files have the following format:

Offset	Content
0x0000	History of residential levels (240 16-bit integers)
0x01E0	History of commericial levels
0x03C0	History of industrial levels
0x05A0	History of crime levels
0x0780	History of pollution levels
0x0960	History of cash flow
0x0B40	Miscellaneous values
0x0C30	Map data (by columns, west to east)

Releasing

To create a release, make sure that your GitHub API token with corresponding repository permissions exists in '~/.gradle/gradle.properties':

github.token=abcdef...

Update the version property in the gradle.properties of this repository.

Ensure that you included all the changes into the master branch.

./gradlew

Then execute

./gradlew clean build githubRelease

to create a GitHub release from the current master.

dheid/micropolis