Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nicholas-ochoa/opensc2k

OpenSC2K - An Open Source remake of Sim City 2000 by Maxis
https://github.com/nicholas-ochoa/opensc2k

2000 city electron game javascript maxis opensc2k phaser phaser-game phaser3 phaserjs remake sc2k sim simcity simcity-2000 typescript webgl

Last synced: 2 days ago
JSON representation

OpenSC2K - An Open Source remake of Sim City 2000 by Maxis

Awesome Lists containing this project

README 

        
# OpenSC2K

OpenSC2K - An Open Source remake of SimCity 2000 written in JavaScript, using WebGL Canvas and [Phaser 3](https://github.com/photonstorm/phaser/).



## Overview

Currently a lot remains to be implemented but the basic framework is there for importing and viewing cities. Lots of stuff remains completely unimplemented such as the actual simulation, rendering of many special case tiles and buildings and anything else that exists outside of importing and viewing.



Along with implementing the original functionality and features, I plan to add additional capabilities beyond the original such as larger city/map sizes, additional network types, adding buildings beyond the initial tileset limitations, action/history tracking along with replays and more.



I've only tested using Chrome / Firefox on macOS, but it should run fairly well on any modern browser/platform that supports WebGL. Performance should be acceptable but there is still a LOT of room for optimizations and improvements.



Due to copyrights, the original graphics and assets from SimCity 2000 cannot be provided here. I've developed and tested using the assets from SimCity 2000 Special Edition for Windows 95. Once I've got the basic engine stabilized I plan to add support for multiple versions of SimCity 2000 in the future.



**Update:** I've been working on refactoring considerable portions of the code for clarity and performance. Due to the changes a lot of existing functionality is now completely broken and will be fixed in upcoming commits.



![Screenshot](/screenshots/1.png)



## Installation

You can use yarn (recommended) or npm to install and run. Once installed and started, open a browser to http://localhost:3000 to start the game.



### OS X / Linux

1. `git clone https://github.com/rage8885/OpenSC2K` or download this repository

1. `cd OpenSC2K`

1. `yarn install` downloads and installs the dependancies

1. `yarn dev` to run



## Usage

By default, a test city included in the /assets/cities/ folder will load. Currently you must modify the `/src/city/load.js` file to load different cities.



Requires two files from the Windows 95 Special Edition version of SimCity 2000: `LARGE.DAT` and `PAL_MSTR.BMP`. These must be placed in the `/assets/import/` directory prior to starting the game. The files will be automatically parsed and used for all in game graphics.



### Controls

 - `WASD` to move the camera viewport

 - `Q` or `E` to adjust camera zoom



![Screenshot](/screenshots/2.png)

![Screenshot](/screenshots/3.png)

![Screenshot](/screenshots/4.png)



## Acknowledgements

Based on the work of Dale Floer

 - SimCity 2000 specifications (*.sc2)

 - MIF / LARGE.DAT graphics extraction



Based on the work of David Moews

 - SimCity 2000 for MS-DOS file format; unofficial partial information



Portions of the SC2 import logic are based on sc2kparser created by Objelisks and distributed under the terms of the ISC license.



Includes work adapted from the Graham Scan polygon union JavaScript implementation by Lovasoa and distributed under the terms of the MIT license



## License

OpenSC2K - An Open Source SimCity 2000 remake



Copyright (C) 2019 Nicholas Ochoa



This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.



This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.



You should have received a copy of the GNU General Public License

along with this program.  If not, see .



SimCity 2000 is copyright Electronic Arts / Maxis. No assets, artwork or other media from the original game is included in this remake. The OpenSC2K engine is being rebuilt as a new implementation and does not use any code from the original game reproduced in any form.