icza / sc2gears

The COMPLETE (!) source code of the Sc2gears universe (Sc2gears app + Sc2gears Database + web-based parsing engine - bundled in an Eclipse project).

Sc2gears

The COMPLETE (!) source code of the Sc2gears universe (Sc2gears app + Sc2gears Database + web-based parsing engine - bundled in an Eclipse project).

Sc2gears home page: https://sites.google.com/site/sc2gears/

The complete source code of Sc2gears is more than a hundred thousands lines of code. Enjoy :)

(The Github project counts 183,000 lines. And this is without development history, just the snapshot of the current state of the project.)

Directory Structure

directory-info.html in the root explains / details the main folders / files:

File/folder			Description
/src			Main source folder of Sc2gears.
/src-shared			Shared source folder for both Sc2gears and Sc2gears Updater.
/src-updater			Main source folder of the Sc2gears Updater.
/src-util			Source of some utility/test application, not part of Sc2gears.
/src-common			Common source for both Sc2gears and Sc2gears Database.
/src-sc2gearsdb			Source folder of the web application of the back-end server for Sc2gears.
/src-plugins			Source folder of some of my plugins. They provide extra functionality for Sc2gears; implemented as plugins for educational purposes.
/src-sc2gearspluginapi			Source folder of the Sc2gears plugin interface and the APIs and services that are provided for the plugins.
/app-folder			Contains the off-line files and static files/folders required to run Sc2gears (including the language files).
/release-files			Static resource files needed to create a release.
/release			Target folder for creating a release
/doc			Contains some info and help files.
/resources			Some external resources with the intent to provide information only, not required for the project.
/war	/		Files of the Sc2gears Database web application.
	/hosted	/	Hosted files that are intended for Sc2gears clients.
		/latest_version.xml	XML document containing required info about the latest release.
		/start_pageXXX.html	HTML document to be displayed as the Start page of Sc2gears.
		/custom_protraits.xml	XML document containing the custom portraits definition.
/clear_for_archiving.cmd			Windows script to clear unnecessary, compiler generated files to make backups smaller.
/create-release.cmd			Windows script to create a release.
/directory-info.html			This document.
/Sc2gears.launch			Eclipse launch configuration to run Sc2gears.
/zprj-Sc2gears-parsing-engine			This is an embedded Eclipse project (originally it was a separate project). It is a stripped / altered version of the Sc2gears replay parsing engine, tailored for running in web apps. This is the parsing engine used in the Parsing Service of the Sc2gears Database. This project produces the sc2gears-parsing-engine.jar lib to be placed under /war/WEB-INF/lib.

Project Status

Active development of Sc2gears took place between 2010 - 2013 (about 3 and a half years). The project is no longer maintained, no further updates will be released for Sc2gears. It is open-sourced for educational purposes - and for the curious eyes.

As of October 7, 2015, Sc2gears can no longer parse replays (since StarCraft II patch 3.0). Sc2gears lived 5 years, 6 months and 5 days! (April 2, 2010 - October 7, 2015)

License

Open-sourced under the Apache License 2.0.

sc2gears's Issues

Is Sc2Gears really dead, since the repo is still updated? Should we use Scelight?

Hi,

The website states, that SC2gears is disontinued but the repo is still maintained. What are the differences between SC2gears and Scelight? Is it recommended to use Scelight in any case now or does Sc2gears also has its advantages? Why was SC2gears discontinued but later still maintained?

A few explaining words on the main page would really help. Thank you!