Merge pull request #10 from PhoenicisOrg/master

Merge master

.travis.yml

@@ -26,6 +26,7 @@ matrix:
 
     # Update JSDoc
     - stage: Update JSDoc
+      before_install: npm install -g jsdoc
       script:
         # push JSDoc updates only for master (PR changes must be committed to master before they are taken into account)
         - if [ "$TRAVIS_BRANCH" == "master" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./push_jsdoc.sh; fi
@@ -43,4 +44,9 @@ matrix:
 
 env:
   global:
-    - secure: "G4stg+1ko5gyBf7q4d3BPmpHKKNkNjEFJOjE83JAe+3aJFYUSh+bwQKizc6+0BaekhyQcQB2CxtknkVGk/xnio2fNNuahxYV1QJmEDxNeBmwF4LS8rQcidoxOPfCVHQ/DXCqtJrCjof7BrWGJKsnhIVHtkQFwo369XATCNIZdsjhuM4ROT35HykoGE+us2qWsoU5C/j+F3dD+9LC8y8ye7SljC9EJVCjZ7HrW77ghS7aulZ+tcrQiHeFwRGJ9Oppwq+XbViflMmPxsp1z3Sg829dWA0Fv9+ejZo7ys0KJauh0H00J8druy3X/QncibzOqy2FCbwXm3e8k3WHgUpYihN3x2Up4PmhEysrlctnR1s3VFDr2cUHYbmeh4eqjSy9O3ejPu9th7Z0pjAJxJae8BWx3Gg2oA+tuIeMAxvGQScQkj93g2moAq2n1wSaa5wCEzoLTV+gheqojRIMc/E9O5VQB+oXgDv1xUKfJ5ZmB7nPGoVBbw2YimGTeICbLjydH6ErKTnxdia1EVn5OX5OOss5H6u/jxg8wJALp4+Qq/7EwMj9f6j6J8JuZSNMAqlvSovdqNPlrywPsqtGEJlB6GU3Sqc5cWW/qlefXNZzXHJkZGGQCqhQiQljNxzRm8lgh0u9/uAH4RhOFhtJnBbE/yo7Exe0yIH6eadBaMl+xTQ="
+    # to create secure for travis-ci.com
+    # 1. create personal access token with public_repo permissions
+    # 2. clone this repo (not a fork)
+    # 3. run in the clone: travis encrypt GH_TOKEN="<access_token>" --pro (GH_TOKEN is the variable which is used e.g. in push_jsdoc.sh)
+    # 4. set output below
+    - secure: "HZ7wbZdwnp3iUJwfL42HnH8fnTcVz/9y9HKFy2MXw38ZtZMoXMB1a3duM0a+UFY59biFVb2PgvqEzl5e8i1fygCN2gYtyWNvvMsNTD0Iq9eOo6nzSkWjWoWIn1TMUEjDS4xZdJLHkmnp7E4h4xc4CNt3HZA5rRbiko8wXCLeWh0UM3YXjs/b14tDlZRy29Sn4LuMSdGWi8lqqTF+4rAAFJ7aQOZDJfse/lZr2FTxRtOdsxPSizU3wJ/Hk/uQvOtp6CizC0c53r49ODqDuFeHj0AOeAR9DpM0B7MojZiFKW2h74vMMcCBKdeyX3K7iLn55Z65p/9bwWCPWwAbwy4Vrbi4OMKc4WdD0RE5h0OOXCdw7xuCA1nPg5+xk5l/0TAXjmb/luklyFbNBXyGKjF5CeEaUhrn9LFmOuyoqYoVf4BD2TA32kqMGxVchf8bnTeM25slI/wi5Sgjpj6GXuxay9bUt13QPQLcT3sNp1Jftvm4gZPdY9TR9m+nPK7nhIZjFWeHJu2nIzcfJdqMTcmLV+iKqZSSL2CJqCUbPEIVwtIj3ZytFrWTX88H97K/9UMDPQ+YbyT1I9XwkXY2PT66F5WE1UVMW/3SKw/jZON8AjYKD4mTd24kRMNfNhXGsg3L+NS8dsDXz1cfSZpLGxe4rvguZInoziJGLN27jGwyN0I="

Engines/Wine/Plugins/regedit/script.js

@@ -22,6 +22,16 @@ Wine.prototype.regedit = function () {
         return _wine;
     };
 
+    this.deleteKey = function (keyPath) {
+        _wine.run("reg", ["delete", keyPath, "/f"], this.prefixDirectory(), false, true);
+        return _wine;
+    };
+
+    this.deleteValue = function (keyPath, value) {
+        _wine.run("reg", ["delete", keyPath, "/v", value, "/f"], this.prefixDirectory(), false, true);
+        return _wine;
+    };
+
     this.fetchValue = function (keyPath) {
         var root = keyPath[0];
         var registryFile;

Engines/Wine/QuickScript/Steam Script/script.js

@@ -96,10 +96,7 @@ SteamScript.prototype.go = function () {
 
     var wine = new Wine()
         .wizard(setupWizard)
-        .architecture(this._wineArchitecture)
-        .distribution(this._wineDistribution)
-        .version(this._wineVersion)
-        .prefix(this._name)
+        .prefix(this._name, this._wineDistribution, this._wineArchitecture, this._wineVersion)
         .luna()
         .run(tempFile)
         .wait(tr("Please follow the steps of the Steam setup.\n\nUncheck \"Run Steam\" or close Steam completely after the setup so that the installation of \"{0}\" can continue.", this._name));

Engines/Wine/Settings/DirectDraw renderer/script.js

@@ -0,0 +1,48 @@
+include(["engines", "wine", "engine", "object"]);
+include(["engines", "wine", "plugins", "regedit"]);
+
+/**
+ * setting to set the DirectDraw renderer
+*/
+var settingImplementation = {
+    _options: [tr("Default"), tr("GDI"), tr("OpenGL")],
+    // values which are written into the registry, do not translate!
+    _registryValues: ["", "gdi", "opengl"],
+    getText: function () {
+        return tr("DirectDraw renderer");
+    },
+    getOptions: function () {
+        return this._options;
+    },
+    getCurrentOption: function (container) {
+        var currentValue = new Wine()
+            .prefix(container)
+            .regedit()
+            .fetchValue(["HKEY_CURRENT_USER", "Software", "Wine", "Direct3D", "DirectDrawRenderer"]);
+        // find matching option (use default if not found)
+        var index = Math.max(this._registryValues.indexOf(currentValue), 0);
+        return this._options[index];
+    },
+    setOption: function (container, optionIndex) {
+        if (0 == optionIndex) {
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .deleteValue("HKEY_CURRENT_USER\\Software\\Wine\\Direct3D", "DirectDrawRenderer");
+        }
+        else {
+            var regeditFileContent =
+            "REGEDIT4\n" +
+            "\n" +
+            "[HKEY_CURRENT_USER\\Software\\Wine\\Direct3D]\n" +
+            "\"DirectDrawRenderer\"=\"" + this._registryValues[optionIndex] + "\"\n";
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .patch(regeditFileContent);
+        }
+    }
+};
+
+/* exported Setting */
+var Setting = Java.extend(org.phoenicis.engines.EngineSetting, settingImplementation);

Engines/Wine/Settings/DirectDraw renderer/script.json

@@ -0,0 +1,11 @@
+{
+    "scriptName"                 : "DirectDraw renderer",
+    "id"                         : "directdraw_renderer",
+    "compatibleOperatingSystems" : [
+        "MACOSX",
+        "LINUX"
+    ],
+    "testingOperatingSystems" : [],
+    "free"                    : true,
+    "requiresPatch"           : false
+}

Engines/Wine/Settings/GLSL/script.js

@@ -0,0 +1,48 @@
+include(["engines", "wine", "engine", "object"]);
+include(["engines", "wine", "plugins", "regedit"]);
+
+/**
+ * setting to enable/disable GLSL
+*/
+var settingImplementation = {
+    _options: [tr("Default"), tr("Disabled"), tr("Enabled")],
+    // values which are written into the registry, do not translate!
+    _registryValues: ["", "disabled", "enabled"],
+    getText: function () {
+        return tr("GLSL support");
+    },
+    getOptions: function () {
+        return this._options;
+    },
+    getCurrentOption: function (container) {
+        var currentValue = new Wine()
+            .prefix(container)
+            .regedit()
+            .fetchValue(["HKEY_CURRENT_USER", "Software", "Wine", "Direct3D", "UseGLSL"]);
+        // find matching option (use default if not found)
+        var index = Math.max(this._registryValues.indexOf(currentValue), 0);
+        return this._options[index];
+    },
+    setOption: function (container, optionIndex) {
+        if (0 == optionIndex) {
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .deleteValue("HKEY_CURRENT_USER\\Software\\Wine\\Direct3D", "UseGLSL");
+        }
+        else {
+            var regeditFileContent =
+                "REGEDIT4\n" +
+                "\n" +
+                "[HKEY_CURRENT_USER\\Software\\Wine\\Direct3D]\n" +
+                "\"UseGLSL\"=\"" + this._registryValues[optionIndex] + "\"\n";
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .patch(regeditFileContent);
+        }
+    }
+};
+
+/* exported Setting */
+var Setting = Java.extend(org.phoenicis.engines.EngineSetting, settingImplementation);

Engines/Wine/Settings/GLSL/script.json

@@ -0,0 +1,11 @@
+{
+    "scriptName"                 : "GLSL",
+    "id"                         : "glsl",
+    "compatibleOperatingSystems" : [
+        "MACOSX",
+        "LINUX"
+    ],
+    "testingOperatingSystems" : [],
+    "free"                    : true,
+    "requiresPatch"           : false
+}

Engines/Wine/Settings/always offscreen/script.js

@@ -0,0 +1,48 @@
+include(["engines", "wine", "engine", "object"]);
+include(["engines", "wine", "plugins", "regedit"]);
+
+/**
+ * setting to set always offscreen
+*/
+var settingImplementation = {
+    _options: [tr("Default"), tr("Disabled"), tr("Enabled")],
+    // values which are written into the registry, do not translate!
+    _registryValues: ["", "disabled", "enabled"],
+    getText: function () {
+        return tr("Always offscreen");
+    },
+    getOptions: function () {
+        return this._options;
+    },
+    getCurrentOption: function (container) {
+        var currentValue = new Wine()
+            .prefix(container)
+            .regedit()
+            .fetchValue(["HKEY_CURRENT_USER", "Software", "Wine", "Direct3D", "AlwaysOffscreen"]);
+        // find matching option (use default if not found)
+        var index = Math.max(this._registryValues.indexOf(currentValue), 0);
+        return this._options[index];
+    },
+    setOption: function (container, optionIndex) {
+        if (0 == optionIndex) {
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .deleteValue("HKEY_CURRENT_USER\\Software\\Wine\\Direct3D", "AlwaysOffscreen");
+        }
+        else {
+            var regeditFileContent =
+            "REGEDIT4\n" +
+            "\n" +
+            "[HKEY_CURRENT_USER\\Software\\Wine\\Direct3D]\n" +
+            "\"AlwaysOffscreen\"=\"" + this._registryValues[optionIndex] + "\"\n";
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .patch(regeditFileContent);
+        }
+    }
+};
+
+/* exported Setting */
+var Setting = Java.extend(org.phoenicis.engines.EngineSetting, settingImplementation);

Engines/Wine/Settings/always offscreen/script.json

@@ -0,0 +1,11 @@
+{
+    "scriptName"                 : "always offscreen",
+    "id"                         : "always_offscreen",
+    "compatibleOperatingSystems" : [
+        "MACOSX",
+        "LINUX"
+    ],
+    "testingOperatingSystems" : [],
+    "free"                    : true,
+    "requiresPatch"           : false
+}

Engines/Wine/Settings/application.json

@@ -0,0 +1,5 @@
+{
+    "name"        : "Wine Settings",
+    "id"          : "settings",
+    "description" : "Settings for Wine."
+}

Engines/Wine/Settings/mouse warp override/script.js

@@ -0,0 +1,48 @@
+include(["engines", "wine", "engine", "object"]);
+include(["engines", "wine", "plugins", "regedit"]);
+
+/**
+ * setting to configure mouse warp override
+*/
+var settingImplementation = {
+    _options: [tr("Default"), tr("Disabled"), tr("Enabled"), tr("Force")],
+    // values which are written into the registry, do not translate!
+    _registryValues: ["", "disabled", "enabled", "force"],
+    getText: function () {
+        return tr("Mouse warp override");
+    },
+    getOptions: function () {
+        return this._options;
+    },
+    getCurrentOption: function (container) {
+        var currentValue = new Wine()
+            .prefix(container)
+            .regedit()
+            .fetchValue(["HKEY_CURRENT_USER", "Software", "Wine", "DirectInput", "MouseWarpOverride"]);
+        // find matching option (use default if not found)
+        var index = Math.max(this._registryValues.indexOf(currentValue), 0);
+        return this._options[index];
+    },
+    setOption: function (container, optionIndex) {
+        if (0 == optionIndex) {
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .deleteValue("HKEY_CURRENT_USER\\Software\\Wine\\DirectInput", "MouseWarpOverride");
+        }
+        else {
+            var regeditFileContent =
+            "REGEDIT4\n" +
+            "\n" +
+            "[HKEY_CURRENT_USER\\Software\\Wine\\DirectInput]\n" +
+            "\"MouseWarpOverride\"=\"" + this._registryValues[optionIndex] + "\"\n";
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .patch(regeditFileContent);
+        }
+    }
+};
+
+/* exported Setting */
+var Setting = Java.extend(org.phoenicis.engines.EngineSetting, settingImplementation);

Engines/Wine/Settings/mouse warp override/script.json

@@ -0,0 +1,11 @@
+{
+    "scriptName"                 : "mouse warp override",
+    "id"                         : "mouse_warp_override",
+    "compatibleOperatingSystems" : [
+        "MACOSX",
+        "LINUX"
+    ],
+    "testingOperatingSystems" : [],
+    "free"                    : true,
+    "requiresPatch"           : false
+}

Engines/Wine/Settings/multisampling/script.js

@@ -0,0 +1,48 @@
+include(["engines", "wine", "engine", "object"]);
+include(["engines", "wine", "plugins", "regedit"]);
+
+/**
+ * setting to configure multisampling
+*/
+var settingImplementation = {
+    _options: [tr("Default"), tr("Disabled"), tr("Enabled")],
+    // values which are written into the registry, do not translate!
+    _registryValues: ["", "disabled", "enabled"],
+    getText: function () {
+        return tr("Multisampling");
+    },
+    getOptions: function () {
+        return this._options;
+    },
+    getCurrentOption: function (container) {
+        var currentValue = new Wine()
+            .prefix(container)
+            .regedit()
+            .fetchValue(["HKEY_CURRENT_USER", "Software", "Wine", "Direct3D", "Multisampling"]);
+        // find matching option (use default if not found)
+        var index = Math.max(this._registryValues.indexOf(currentValue), 0);
+        return this._options[index];
+    },
+    setOption: function (container, optionIndex) {
+        if (0 == optionIndex) {
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .deleteValue("HKEY_CURRENT_USER\\Software\\Wine\\Direct3D", "Multisampling");
+        }
+        else {
+            var regeditFileContent =
+            "REGEDIT4\n" +
+            "\n" +
+            "[HKEY_CURRENT_USER\\Software\\Wine\\Direct3D]\n" +
+            "\"Multisampling\"=\"" + this._registryValues[optionIndex] + "\"\n";
+            new Wine()
+                .prefix(container)
+                .regedit()
+                .patch(regeditFileContent);
+        }
+    }
+};
+
+/* exported Setting */
+var Setting = Java.extend(org.phoenicis.engines.EngineSetting, settingImplementation);

Engines/Wine/Settings/multisampling/script.json

@@ -0,0 +1,11 @@
+{
+    "scriptName"                 : "multisampling",
+    "id"                         : "multisampling",
+    "compatibleOperatingSystems" : [
+        "MACOSX",
+        "LINUX"
+    ],
+    "testingOperatingSystems" : [],
+    "free"                    : true,
+    "requiresPatch"           : false
+}