Skip to content

Commit

Permalink
#4 - Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joedf committed Feb 8, 2019
1 parent 7be708c commit 36d3025
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,18 @@ A Webapp.ahk project must have a `webapp.json` configuration file.

```JSON
{
"name": "My App",
"width": 640,
"height": 480,
"protocol": "app",
"protocol_call": "app_call",
"html_url": "index.html",
"NavComplete_call": "app_page",
"Nav_sounds": true,
"fullscreen": true
"name": "My App",
"width": 640,
"height": 480,
"protocol": "app",
"protocol_call": "app_call",
"html_url": "index.html",
"NavComplete_call": "app_page",
"Nav_sounds": true,
"fullscreen": true
"DPI_Aware": true,
"ZoomLevel": 100,
"AllowZoomLevelChange": true
}
```

Expand All @@ -39,6 +42,9 @@ A Webapp.ahk project must have a `webapp.json` configuration file.
- The `NavComplete_call` option is the name of the function in your AutoHotkey that will run when a page is finished loading. Its first argument is the new page's URL. It defaults to `app_page()` if none is specified.
- The `Nav_sounds` parameter (boolean) is optional. If left unspecified, it defaults to false. The Navigation sounds correspond to the sounds made by IE during navigation such as the infamous "click" sound.
- The `fullscreen` parameter (boolean) is optional. If left unspecified, it defaults to false. This sets whether the application should start in fullscreen or as a window of the specified size (`Width` & `Height`).
- The `DPI_Aware` parameter (boolean) is optional. If left unspecified, it defaults to true. This sets whether the application should zoom_level auto-correction based on the system's DPI.
- The `ZoomLevel` option is the percent scaling for the App to launch with (specify `200` for 200% scaling). It defaults to `100` if none is specified.
- The `AllowZoomLevelChange` parameter (boolean) is optional. If left unspecified, it defaults to true. This sets whether the application should allow users to change the zoom level with either `Ctrl +/-` or `Ctrl Wheel Up/Down`.

Note: For example, if `protocol` is set to `myapp` and a `myapp://test/1234` link is clicked, the set `protocol_call` function will be called and will receive `test/1234` as its first argument. If `protocol` is set to `*`, the set `protocol_call` function will run for **ANY** link clicked and it will receive `myapp://test/1234` (the whole URL) as its first argument. This is not recommended for most cases, as links with `href="#"` will also trigger the function (usually unwanted behaviour).

Expand Down

0 comments on commit 36d3025

Please sign in to comment.