Skip to content

Add documentation about include mechanism #856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ImperatorS79 merged 6 commits into from
Mar 2, 2019
Merged

Add documentation about include mechanism #856

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2a9588e
Add documentation about include mechanism
ImperatorS79 Feb 4, 2019
8a483a9
Update script-js.md
ImperatorS79 Feb 4, 2019
47cef6e
Update script-js.md
ImperatorS79 Feb 6, 2019
f51a3c7
Update script-js.md
ImperatorS79 Feb 26, 2019
702bf83
Include by ID
ImperatorS79 Mar 2, 2019
f9e8747
Merge branch 'master' into ImperatorS79-patch-3
ImperatorS79 Mar 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions docs/_docs/Develop/script-js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ QuickScripts use the latest stable wine version by default (recommended).
A basic script looks like:

```javascript
include(["engines", "wine", "quick_script", "steam_script"]);
include("engines.wine.quick_script.steam_script");

var installerImplementation = {
run: function () {
Expand Down Expand Up @@ -55,7 +55,7 @@ For a different shortcut (e.g. if you want to pass arguments):
### OriginScript
A basic script looks like:
```javascript
include(["engines", "wine", "quick_script", "origin_script"]);
include("engines.wine.quick_script.origin_script");

var installerImplementation = {
run: function () {
Expand All @@ -81,7 +81,7 @@ You can determine the app ID by going into `C:\Origin Games\*name of the game*\
A basic script looks like:

```javascript
include(["engines", "wine", "quick_script", "uplay_script"]);
include("engines.wine.quick_script.uplay_script");

var installerImplementation = {
run: function () {
Expand All @@ -105,7 +105,7 @@ Installs a local Windows executable. Shows a setup window browse step (see [Setu
A basic script looks like:

```javascript
include(["engines", "wine", "quick_script", "local_installer_script"]);
include("engines.wine.quick_script.local_installer_script");

var installerImplementation = {
run: function () {
Expand All @@ -129,7 +129,7 @@ Downloads and installs a Windows executable.
A basic script looks like:

```javascript
include(["engines", "wine", "quick_script", "online_installer_script"]);
include("engines.wine.quick_script.online_installer_script");

var installerImplementation = {
run: function () {
Expand All @@ -152,7 +152,7 @@ var Installer = Java.extend(org.phoenicis.scripts.Installer, installerImplementa
### CustomInstallerScript
Executes a custom installation command:
```javascript
include(["engines", "wine", "quick_script", "custom_installer_script"]);
include("engines.wine.quick_script.custom_installer_script");

var installerImplementation = {
run: function () {
Expand All @@ -177,7 +177,7 @@ var Installer = Java.extend(org.phoenicis.scripts.Installer, installerImplementa
A basic script looks like:

```javascript
include(["engines", "wine", "quick_script", "zip_script"]);
include("engines.wine.quick_script.zip_script");

var installerImplementation = {
run: function () {
Expand All @@ -200,6 +200,13 @@ var Installer = Java.extend(org.phoenicis.scripts.Installer, installerImplementa
### Advanced
This section describes some advanced methods which give you more possibilities to control your script.

### Include mechanism
When you want to use a certain functionality in your scripts, you need to include it in your scripts, for example:
```javascript
include("engines.wine.quick_script.steam_script");
```
allows you to execute a steam script. The content of the include is the id of the functionality, which can be found in the `script.json` file located next to the `script.js` file implementing the functionality.

#### Executable arguments
By default, the `.executable` runs the application without arguments. If you need arguments, pass an array as second parameter.

Expand All @@ -216,8 +223,8 @@ You can find the complete list of available verbs [here](https://github.com/Phoe

For example, in the script for "Assassin’s Creed: Brotherhood":
```javascript
include(["engines", "wine", "verbs", "d3dx9"]);
include(["engines", "wine", "verbs", "crypt32"]);
include("engines.wine.verbs.d3dx9");
include("engines.wine.verbs.crypt32");

new SteamScript()
...
Expand Down Expand Up @@ -247,6 +254,8 @@ Specific wine architecture ("x86" or "amd64"):
```
Specific windows version:
```javascript
include("engines.wine.plugins.windows_version");
...
Copy link
Copy Markdown
Collaborator

@madoar madoar Feb 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the deep indention?

Copy link
Copy Markdown
Contributor Author

@ImperatorS79 ImperatorS79 Feb 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is the same than in #### Pre/Post install hooks.

Copy link
Copy Markdown
Collaborator

@madoar madoar Feb 5, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@plata what do you think? Should we always indent the ... or should we not indent the ... at all?

Copy link
Copy Markdown
Collaborator

@plata plata Feb 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you show a comparing screenshot?

.preInstall(function(wine, wizard) {
wine.windowsVersion("win7");
})
Expand All @@ -258,6 +267,9 @@ If the script requires a special registry setting, there are 2 options:

2. If the setting is special for this script, use a registry file. Create a `registry.reg` in `<scriptname>/resources` (see [IE6](https://github.com/PhoenicisOrg/scripts/blob/master/Applications/Internet/Internet%20Explorer%206.0/resources/ie6.reg)) and apply this in `pre/postInstall()` via
```javascript
include("utils.functions.apps.resources");
include("engines.wine.plugins.regedit");
...
Copy link
Copy Markdown
Collaborator

@madoar madoar Feb 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the indention?

Copy link
Copy Markdown
Contributor Author

@ImperatorS79 ImperatorS79 Feb 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did it in the spirit of the indent in #### Pre/Post install hooks.

var registrySettings = new AppResource().application([TYPE_ID, CATEGORY_ID, APPLICATION_ID]).get("registry.reg");
wine.regedit().patch(registrySettings);
```
Expand All @@ -267,8 +279,8 @@ If the QuickScript is not sufficient for you, you can still write a custom scrip

The frame for a custom script looks like this:
```javascript
include(["engines", "wine", "engines", "wine"]);
include(["engines", "wine", "shortcuts", "wine"]);
include("engines.wine.engines.wine");
include("engines.wine.shortcuts.wine");

var application = "application name"

Expand Down