Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 5.87 KB

README.md

File metadata and controls

50 lines (38 loc) · 5.87 KB

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/folderDescription
/srcMain source folder of Sc2gears.
/src-sharedShared source folder for both Sc2gears and Sc2gears Updater.
/src-updaterMain source folder of the Sc2gears Updater.
/src-utilSource of some utility/test application, not part of Sc2gears.
/src-commonCommon source for both Sc2gears and Sc2gears Database.
/src-sc2gearsdbSource folder of the web application of the back-end server for Sc2gears.
/src-pluginsSource folder of some of my plugins. They provide extra functionality for Sc2gears; implemented as plugins for educational purposes.
/src-sc2gearspluginapiSource folder of the Sc2gears plugin interface and the APIs and services that are provided for the plugins.
/app-folderContains the off-line files and static files/folders required to run Sc2gears (including the language files).
/release-filesStatic resource files needed to create a release.
/releaseTarget folder for creating a release
/docContains some info and help files.
/resourcesSome 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.xmlXML document containing required info about the latest release.
/start_pageXXX.htmlHTML document to be displayed as the Start page of Sc2gears.
/custom_protraits.xmlXML document containing the custom portraits definition.
/clear_for_archiving.cmdWindows script to clear unnecessary, compiler generated files to make backups smaller.
/create-release.cmdWindows script to create a release.
/directory-info.htmlThis document.
/Sc2gears.launchEclipse launch configuration to run Sc2gears.
/zprj-Sc2gears-parsing-engineThis 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.