ScudoGR 1.1

ScudoGR - ScummVM, Dosbox (e Windows) Game Runner

-Italiano

Attenzione!! Alcuni antivirus trovano ScudoGR potenzialmente pericoloso, ma ci  dovuto alle dll necessarie contenute all'interno dell'eseguibile.
ScudoGR  virus-free!!

20 Luglio 2008	Versione 1.0	Prima versione
27 Agosto 2008  Versione 1.1    Corretto bug per l'utilizzo del drive CDRom fisico in Dosbox
                                Aggiunta opzione -noconsole
                                Corretto bug in fase di start-up da CD/DVD
                                Corretti bug minori
----------------------------------------------------------------------------------------------

ScudoGR si propone di essere un'interfaccia immediata per l'esecuzione di giochi per pc, indipendentemente dal fatto che siano stati sviluppati per Dos o per Windows. Come indica l'acronimo, ScudoGR utilizza Dosbox e Scummvm, attualmente a mio avviso i migliori emulatori (o interpreti..) per l'uso dei giochi Dos sui moderni sistemi.
Di seguito riporto una veloce spiegazione del programma e del suo utilizzo, che comunque ho cercato di rendere il pi semplice ed intuitivo possibile, spero di esserci riuscito..



1 - Esecuzione
Per funzionare, scudoGR utilizza le seguenti librerie:

	-zlib.dll      (versione rinominata di zlibwapi.dll)
	-sawzip.dll    (che necessita a sua volta di zlib.dll)

  - zlib.dll viene utilizzato per la 
    compressione/decompressione dei file zip

  - sawzip.dll viene usato qui per gestire 
    facilmente file zip di grandi dimensioni. 
    Per funzionare, questa libreria va 
    registrata esplicitamente, e ScudoGR
    effettua tale operazione automaticamente.

Ho deciso di 'racchiudere' queste librerie nel file eseguibile, in modo che vengano automaticamente 'esplose' nella directory System32 di Windows alla prima esecuzione. L'estrazione delle librerie e la registrazione di sawzip.dll (operazioni da eseguire una volta sola) richiedono i permessi di amministratore della macchina host.



1.1 - Esecuzione da CD/DVD
E' possibile eseguire ScudoGR da un unit CD/DVD. Questa possibilit permette di poter creare una propria collezione di giochi facilmente 'portabile' su diversi pc. Quando viene eseguito per la prima volta da un unit CD/DVD, ScudoGR chieder di inserire una directory dell'Hard Disk da utilizzare per aggiornare le informazioni man mano che si utilizza il programma (file di configurazione, snapshot ecc...)



2 - File zip
ScudoGR crea,manipola e importa i file zip associati ai giochi. Una volta creato/ottenuto un gioco (cio il suo file zip OPPORTUNAMENTE COSTRUITO), baster importarlo (o trascinarlo) in ScudoGR per poter giocare con un semplice doppio click. Comodo no?



2.1 - Creazione di un gioco
La creazione del gioco (cio del file zip associato) richiede l'immissione di alcuni parametri di gioco necessari all'esecuzione. I principali parametri richiesti sono:

	-La directory (o il file zip) contenente TUTTI e SOLI i file del gioco
	-Il percorso dove dovr essere creato il file zip di destinazione 
	-Il nome del gioco 
	-L'emulatore/loader richiesto dal gioco (Dosbox, Scummvm o Windows) 
	-La linea di comando per far partire il gioco 
	-L'utilizzo del CD-ROM (facoltativo), e la modalit di utilizzo (montaggio immagine o drive fisico)

Viene quindi creato un file zip, composto da:

	- File propri del gioco
	- Un file speciale, 'Scudogr.dat', usato esclusivamente da ScudoGR, che contiene tutto il necessario per l'esecuzione del gioco



2.2 - Importazione di un gioco
E' possibile importare un file zip creato in precedenza dall'applicazione, attraverso l'apposito menu o trascinandolo sulla finestra dell'applicazione. Il gioco importato  immediatamente utilizzabile.



2.3 - Importazione di una directory di giochi
Se pi giochi pronti per l'importazione si trovano in una directory,  possibile importarla attraverso l'apposito menu o trascinandola sulla finestra dell'applicazione. Ci comporta l'importazione di tutti i giochi contenuti al suo interno.



2.3.1 - Autoimportazione
Al primo lancio, ScudoGR chiede all'utente se desidera importare i giochi dalla directory di default (vedere sezione 3), se presente.



2.4 - Archiviazione di un gioco
Se si vogliono mantenere le modifiche fatte ad un gioco dopo l'installazione (ad esempio, per mantenere i salvataggi del gioco, oppure per impostare e mantenere un nuovo snapshot, oppure per impostare e mantenere un nuovo file di configurazione Dosbox ecc...),  possibile archiviare un gioco in modo da creare un nuovo file zip; una futura importazione del file zip archiviato permettera di ripristinare le informazioni aggiornate.



3 - Directory
Dal momento che  possibile lanciare l'applicazione anche da un unit CD/DVD, occorre definire le directory:

	-<directory fissa>	   la directory su hard disk su cui scrive l'applicazione
	-<directory di lancio>     la directory da cui viene lanciata l'applicazione

Se l'applicazione viene lanciata da hard disk, le due directory coincidono.
ScudoGR utilizza le seguenti directory:

	-<directory di lancio>\Data\Emulators	DEVE CONTENERE le due directory Dosbox e ScummVm, con i relativi programmi al loro interno ***
	-<directory di lancio>\Data\ZipGames	Directory di Default per la ricerca dei file zip da importare
	-<directory fissa>\Config		Contiene tutti i file di configurazione
	-<directory fissa>\Data\InstalledGames	Directory di Default per l'installazione dei giochi
	-<directory fissa>\Snaps		Contiene tutti i file snapshot jpg dei giochi
	-<directory fissa>\Temp			Contiene tutti i file temporanei. Viene eliminata all'uscita

Se un file zip gi importato non viene trovato, ScudoGR cerca il file nella directory <directory di lancio>\Data\ZipGames.
Se la directory di installazione di un gioco non viene trovata, ScudoGR la cerca in <directory fissa>\Data\InstalledGames

***	Questo  un aspetto che rientra nel concetto di "Configurazione emulatori", non presente fino alla versione 2.0



4 - Lingua
ScudoGR  in grado di gestire fino a 6 lingue contemporaneamente (in genere una  sufficiente...). Per configurare le lingue, basta accedere al menu Configurazione->Lingua.
Sentitevi liberi di mandarmi qualsiasi file relativo ad una particolare lingua, cos lo metto a disposizione sul sito. 



5 - Uso del CD-ROM
E' possibile configurare ScudoGR per l'utilizzo del CD-ROM nel caso in cui un gioco lo richieda. In particolare scudoGR permette di:
	-montare l'immagine attraverso Daemon Tools (che dev'essere gi installato sul pc);
	-montare l'immagine attraverso Dosbox (ovviamente solo per giochi Dosbox, che attualmente  in grado di montare solo file ISO)
	-usare il drive fisico

Nota: si consiglia di disattivare la modalit sicura dalle opzioni di Daemon Tools, per non dover continuamente confermare le operazioni di mount/unmount

Nota: alcuni vecchi giochi riconoscono il cd solo se l'unit associata  la prima disponibile tra i cd-rom. Per cambiare l'unit: 
Tasto destro su "Risorse del computer"->Gestione -> Gestione disco
A questo punto se la prima unit CD-ROM non  associata al drive virtuale di Daemon Tools occorre cambiarla:

- Tasto destro sulla prima unit cD-ROM->"Cambia lettera e percorso di unit" e scegliere
un'altra unit rispetto a quella attuale
- Tasto destro sull'unit relativa a Daemon Tools->"Cambia lettera e percorso di unit"
e scegliere la prima unit disponibile (che dovrebbe coincidere con quella appena 'liberata')



Da fare:

-Propriet
Il mio amico 'Theego' mi ha suggerito un'idea interessante: una finestra 'propriet' contenente, neanche a dirlo, le propriet di ciascun gioco (compreso il file zip associato)

- Configurazione emulatori
Tra le cose che mancano, questa  la principale. Mi piacerebbe rendere la gestione degli emulatori COMPLETAMENTE CONFIGURABILE.
Con 'completamente', intendo dire che vorrei che l'utente possa specificare anche le singole opzioni degli emulatori (Dosbox e Scummvm), in modo tale che modifiche future degli emulatori (ad esempio, per scummvm nuove opzioni da riga di comando, per Dosbox nuove opzioni di configurazione) possano essere inserite dall'utente senza bisogno di una nuova versione di ScudoGR. 
In pi, vorrei aggiungere la possibilit di importare anche dei profile D-fend.
Tutto ci richiede un po' di tempo, che in questo momento purtroppo scarseggia..E' attualmente possibile per impostare manualmente quasi tutti gli aspetti di configurazione:

	-un gioco Dosbox viene creato con un file di 
	 configurazione standard (chiamato Dosbox_cfg.txt). Per cambiare la 
	 configurazione, tale file deve essere cambiato a
	 mano, e per essere 'salvato'  necessaria 
	 l'archiviazione del gioco.

	-un gioco Scummvm utilizza la configurazione 
	 standard: per cambiarla, occorre cambiare i 
	 file ScummVm.ini e AddedGames.txt nella 
	 directory <directory fissa>\Config\Emulators\ScummVM. 
	 In particolare, addedGames.txt permette di aggiungere
	 in ScudoGR dei tag per giochi presenti in ScummVM.ini

- Masterizzazione
Mi piacerebbe aggiungere la funzionalit di masterizzazione, cos un utente pu salvarsi la propria compilation di giochi su CD/DVD in modo che sia 'portabile' ed immediatamente avviabile su altri pc.  Sto cercando una libreria/dll free per masterizzare, che non mi 'obblighi' a distribuire il codice sorgente...qualcuno sa aiutarmi?

- Comando di installazione/disinstallazione
Sto pensando di aggiungere la possibilit di eseguire un comando in fase di installazione e in fase di disinstallazione di un gioco.
Se ad esempio un gioco richiede l'inserimento di una chiave nel registro di windows, si potrebbe configurare l'applicazione in modo che:

	-subito dopo l'installazione esegua un file batch in cui si richiede l'inserimento nel registro 
	-immediatamente prima della disinstallazione esegua un file batch in cui si richiede la rimozione della chiave dal registro 



- Ricerca per la configurazione della lingua
Allo stato attuale, la configurazione di una lingua non permette di ricercare una stringa, il che pu essere scomodo quando si sbaglia ad inserire la traduzione di un messaggio.


Per qualsiasi cosa: jenergy@scudogr.it
Sito internet:      http://www.scudogr.it






-English

Warning!! Some antivirus find ScudoGR potentially dangerous, but this is due to the inclusion of the needed dll's into executable file.
ScudoGR is virus-free!!

20 July 2008	Version 1.0	First version
27 August 2008  Version 1.1     Fixed bug while using physical CDRom drive in Dosbox
                                Added the option -noconsole
                                Fixed bug while loading from CD/DVD
                                Fixed minor bugs
----------------------------------------------------------------------------------------------

ScudoGR wants to be a quick interface to execute pc games, even if they was developed for dos either windows. Just as like acronym says, ScudoGR uses Dosbox and Scummvm, which are actually the best emulators (or interpreters..) to play Dos games on modern systems.
I'm writing here a quick explanation on the program and on its use, even if I tried to make it easy, I hope I succeeded on it...



1 - Execution
In order to work correctly, ScudoGR uses following libraries:

	-zlib.dll      (renamed version of zlibwapi.dll)
	-sawzip.dll    (which needs zlib.dll)

  - zlib.dll is used in order to compress/decompress zip files

  - sawzip.dll is used here to manage GREAT zip files 
    In order to work, this library must be registered, 
    and ScudoGR executes automatically this operation.

I decided to 'enclose' these libraries in the executable main file, so that they will be 'extracted' at first execution in the "System32" windows folder. Libraries extraction and registration of sawzip.dll (which are operation that must be executed once) require administrator privileges on the host machine.


1.1 - Execution from CD/DVD
ScudoGR can be launched from a CD/DVD unit. This allows the user to create its own games-collection, easily portable on different pc. The first time that ScudoGR is executed from CD/DVD asks to insert the path of an Hard-Disk folder; this will be used to update needed files (configuration files, snapshot files etc...) 



2 - Zip files
ScudoGR creates, manages and imports zip files, which represent the games. Once a ScudoGR game is created (that is: its zip file), it's possibile to import (or drag) it in ScudoGR, and with a double click you can play it! Isn't it easy?



2.1 - Creation of a game
The creation of a game (that is: the creation of its zip file) requests to insert some game parameters, needed for execution. Main parameters requested are: 

	-The folder (or the zip file) which contains ALL (and ONLY them) game-files
	-The path where the destination file zip will be created
	-The name of the game to create
	-The emulator/loader required by the game (Dosbox, ScummVm or Windows)
	-The command line to start the game
	-The CD-Rom usage (optional), and the way to use it (mounting image file or usage of physical drive)

So, a zip file is created, which is composed by:

	- The files of the game
	- A Special file, called 'Scudogr.dat', used exclusively from ScudoGR, which contains all the needed information to execute the game



2.2 - Import of a game
It's possible to import a zip file previously created from the program, by the proper menu or by dragging it on the main window. The imported game is instantly usable.



2.3 - Import of a game folder
If one or more games ready for import are grouped in a folder, it's possible to import it by the proper menu or by dragging it on the main window. This operation imports all of the games in the folder.



2.3.1 - Autoimport
At first launch, ScudoGR asks to the user if he wants to automatically import the games grouped in the default folder (see section 3), if it's available.



2.4 - Archiving a game
If user wants to keep the changes of a game made after install (for example, in order to keep the game save files, ot in order to set and keep a new snapshot for the game, or in order to set and keep a new Dosbox configuration file etc...), it's possible to archive a game, so that a new zip file will be created: a future import of this file will allow to restore the updated informations.



3 - Folders
Since ScudoGR can be launched also from a CD/DVD unit, I'll call:

	-<fixed folder>	    it's the main hard disk folder, where ScudoGR writes files
	-<launch folder>    it's the folder where the executable file is

If ScudoGR is launched from an hard disk folder, <fixed folder> and <launch folder> coincide.
ScudoGR uses the following folders

	-<launch folder>\Data\Emulators		MUST COINTAIN two folders Dosbox and ScummVm, with the emulators inside ***
	-<launch folder>\Data\ZipGames		Default folder where to search zip files to import
	-<fixed folder>\Config			Contains all the configuration files
	-<fixed folder>\Data\InstalledGames	Default folder where to install games
	-<fixed folder>\Snaps			Contains all the jpg snapshot of games
	-<fixed folder>\Temp			Contains all the temporary files. It's erased on exit

If a zip file imported is not found, ScudoGR searches for it in <launch folder>\Data\ZipGames.
If the install folder of a game is not found, ScudoGR searches in <fixed folder>\Data\InstalledGames

***	This aspect is contained in the "Configure emulators" concept, which is not available until version 2.0



4 - Language
ScudoGR can manage up to 6 languages simultaneously (usually one is enough...). In order to configure languages, it's available the menu Configuration->Language.
Feel free to send me language file you created, so I'll put them on the site.


5 - Usage of the CD-ROM
It's possible to configure ScudoGR in order to use CD-ROM when a game needs it. In particular ScudoGR allows to:
	-mount image using Daemon Tools (which must be already installed on PC);
	-mount image using Dosbox (obviously this is only for Dosbox games, which actually can mount only ISO files)
	-use the physycal drive

Note: it's advisable to disable the secure mode from Daemon Tools option, in order to avoid to confirm repeatedly mount/unmount operations.

Note: some old games can use cd only if the relative drive is the first available. In order to change drive letter:

Right click on "My computer"->Manage -> Disk management
Now, if first CD-ROM unit is not linked to Daemon Tools virtual drive, it must be changed:

- Right click on the first CD-ROM unit->"Change drive letter" and choose another one
- Right click on the unit relative to Daemon Tools->"Change drive letter" and choose the first available unit (which should be the one just freed)


To do:

-Properties
My friend 'Theego' suggested me an interesting idea: a 'properties' window, in which show the properties of a particual game (and on its zip file)

- Emulators configuration
This is the main thing which is missing. I'd like to create the emulators management COMPLETELY CONFIGURABLE.
This means that I'd like that user can specify the single options of every emulator, so that future modifications of an emulator (for example, new command line ScummVM options or new configuration Dosbox options) can be managed without the need of another ScudoGR version.
I'd like to add also the management for import D-fend profiles.
All of this requires a lot of time..time which is unavailable at the moment! But it's possible actually to set manually almost all the configuration parameters. For example:

	-a Dosbox game is created with a standard configuration
         file (which is called Dosbox_cfg.txt). In order to
         change configuration, this file must be manually changed,
         and in order to save it in the zip file, the game must be 
         archived.

	-a ScummVM game uses standard configuration:
         in order to change it, the files ScummVm.ini 
         and AddedGames.txt in the 
         <fixed folder>\Config\Emulators\ScummVM must be
         manually changed. 
	 In particular, "addedGames.txt" allows to add in
         ScudoGR the tags which are configured in ScummVM.ini

- CD/DVD Burn
I'd like to add the CD/DVD burn management, so a user can save its own games-compilation by the program. I'm searching for a free library/dll, which does not force me to distribute source code..someone can help me?

- Install/Uninstall command
I'm thinking to add a configurable command to execute on install/uninstall. This can be useful sometimes..for example, if a game requires to insert a key in the windows registry, it would be useful to configure scudoGR so that:

	-after the install process, it executes a batch file which insert the key in the registry
	-just before uninstall process, it executes a batch file which removes the key



- Search in language configuration
Actually the language configuration doesn't allow to search for a string, and this can be a trouble when you want to correct a wrong translated message!


For anything:  jenergy@scudogr.it
Internet site: http://www.scudogr.it

