This is an old, archived version of the project. Use only for educational purposes!

Introduction

The DOS Spirit is courtesy of The DOS Spirit Foundation.

The DOS Spirit is a high availability, high performance site focused on categorizing, indexing and organizing games and applications on a wide variety of platforms from the early 80s, 90s and up to the 00s.

The Project

Started initially back in 2004 as a home page project, but moved as its own project early 2005 called "The DOS Spirit".

Prerequisities

• A Local setup of at least PHP 5.2 and MySQL 5.X. You can also use other xSQL as long as you change the config to use this driver and update the schema as well. *
• GD2 image library *
• APC opcode cache
• xDebug
• Patience *

Asterix = Needed

How can I contribute to The DOS Spirit project?

1. Fork the repo, have a look at the code and improve parts you don't agree with.
2. Help translate The DOS Spirit to other languages: https://crowdin.com/project/dosspirit
3. Support and incentivize further improvements by supporting The DOS Spirit on Patreon: http://www.patreon.com/dosspirit

Installation

TODO: Create a "make" script for all the procedures below.

• Move or copy the "Config" and "tmp" folder from "build/app" to "app" so it becomes "app/Config" and "app/tmp". (I.e: /home/user/dosspirit/app/Config)

• Move or copy the "vendors" and "plugins" from "build/root" folder to the root of your project. (I.e: /home/user/dosspirit/vendors and /home/user/dosspirit/plugins)

• Move or copy all the folders from "build/webroot" to "app/webroot/*". (I.e: "app/webroot/fonts" etc.)

• Update app/Config/database.php to include your db connection credentials.

• Grab a copy of CakePHP 2.X.X, http://cakephp.org/. Unpack to a folder of your choice, but remember where it is.

• Now configure the path, YOUR-CAKEPHP-LIBRARY-PATH, in webroot/index.php to point to where you unpacked the CakePHP folder in the previous step. Alternatively change the CAKE_CORE_INCLUDE_PATH in root/index.php to your CakePHP path. Something like '/home/user/libraries/cakephp/lib'.

• Create a schema. It expects "tds", but you are free to edit this in your local installation. Import "build/tds-schema.sql" as MySQL export from PHPMyAdmin. There are several ways to import it, but one is: "mysql -u username -p -h localhost YOUR-DATABASE-NAME < build/tds-schema.sql". If you find it easier, you can also use PHPMyAdmin on your local installation or other UI.

• Set the permissions to either 755 or 605 on your local dev environment.

• Update security salt and cipherseed in app/Config/Core.php.

• That should be it, but things will fail as there is no content present. This is normal. You can use the application to create test data for yourself.

Language and translation

To contribute to translating The DOS Spirit into your locale, please see The DOS Spirit Crowdin Project page for this: http://crowdin.net/project/dosspirit Currently The DOS Spirit supports 9 languages including English, Spanish, Italian and Norwegian.

Build process is abit convoluted. It requires you to run the cakephp i18n shell console to correctly generate a new "default.pot" file, located in "app/Locale/default.pot". Have a look here on how that works: http://book.cakephp.org/2.0/en/console-and-shells/i18n-shell.html

New locale updates to the application must checked in and done through pull requests. Newly generated locale files (.po, located in Locale//LC_MESSAGES/default.po) will then be checked into master.

Future planned updates

• CakePHP 3.0 migration
• CSS minification
• REST API
• Member services
• Achievements
• Installs via Make
• Upgrade MarkItDown editor

License

Use of this repository is for educational purposes only. You may not use this for commercial, competing resources or similar purposes. All code from The Retro Spirit - Since 1832™ is licensed under a CC BY-NC-ND 4.0 license.