Skip to content

Commit

Permalink
update for build 4163
Browse files Browse the repository at this point in the history
  • Loading branch information
CGJennings committed Apr 27, 2021
1 parent d0b9b92 commit 39ac309
Show file tree
Hide file tree
Showing 11 changed files with 176 additions and 71 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/nav.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"title":["Welcome and quick start guide","Installation on Windows","Installation on macOS","Installation on other platforms","Transferring settings from another computer","Upgrading from Strange Eons 1 or 2","Choosing language settings","Troubleshooting","Portable installations","Command line options","Plug-in essentials","Downloading and installing plug-ins","Managing installed plug-ins","Relaunching the application","Managing update notifications","\"eons cat\" links","Overview of the app interface","Main menu commands","Document tab management","Using and customizing the context bar","Preferences","Creating a new game component","Preview area","Markup text","Portraits","Tints","Expansion symbols","Spelling checking","Thesaurus and other language tools","Using abbreviations to work efficiently","Printing components","Exporting images","Play testing and improving your designs","The marker and token editor","The deck editor","Creating decks","Creating boards","Creating fold-up boxes","Editing commands","Pages and paper size","Splitting large pages when printing","Publisher's marks (crop, fold marks) and bleed margins","Object snapping","Tips for sharing decks","Tips for printing, assembling, and integrating components","Projects","Deck of Cards tasks","Documentation tasks","Factory tasks","Plug-in tasks","Generic tasks","Searching projects","Automation scripts","Making cards from a CSV data file","Supported file types","Release notes","Overview of plug-in authoring","Taking a tour of a plug-in","Plug-in types","Making your first plug-in","The root file","Script library API","Java class API","Plug-in authoring kit","Setting basics","Setting hierarchies","Setting collections","$-notation","Resources","Resource `res://` and other special URLs","Image resources","Font resources","Class map resources","Settings file resources","String table resources","Tile set resources","Silhouette resources","Default abbreviation table resources","Installation notes and scripts","Named objects","Quickscript and the script console","Code editor","Test Plug-in","Script debugger","Converting and compressing images","Draw Regions","Typeface (font file) viewer","Setting Explorer","Memory use and cache control","Register new games and game expansions","Create new card types with DIY components","Add portraits to DIY components","Add bleed margins to DIY components","Change DIY components without breaking old save files","Prefab components: create new component types without code","Customize how a component is drawn in Ink Saver mode","Access the open project and its files","Extend the project system","Extend the **Preferences** dialog","Customize the context bar","Extend the app menu","Use and define application commands","Register an export container","Make the spelling checker ignore game terminology","Overview of localization","Adding support for localization to a plug-in","Adding a new translation","Testing a translation","Handle %-format strings","Fit translated text","Work around fonts that don't support the target locale","Translate strings that use plural forms","Add spelling support for a new language","Table of locale codes"],"file":["um-install-intro","um-install-win","um-install-mac","um-install-other","um-install-user-folder","um-install-upgrading","um-install-languages","um-install-troubleshooting","um-install-portable","um-install-command-line-options","um-plugins-intro","um-plugins-catalogue","um-plugins-manager","um-plugins-relaunching","um-plugins-updates","um-plugins-eonscat","um-ui-intro","um-ui-menu","um-ui-documents","um-ui-context-bar","um-ui-preferences","um-gc-intro","um-gc-preview","um-gc-markup","um-gc-portraits","um-gc-tints","um-gc-expansions","um-gc-spelling","um-gc-thesaurus","um-gc-abbreviations","um-gc-print","um-gc-export","um-gc-play-testing","um-token-editor","um-deck-intro","um-deck-decks","um-deck-boards","um-deck-boxes","um-deck-commands","um-deck-pages","um-deck-page-split","um-deck-pubmarks","um-deck-snap","um-deck-share-tips","um-deck-print-tips","um-proj-intro","um-proj-deck-task","um-proj-doc-task","um-proj-factory-task","um-proj-plugin-task","um-proj-generic-task","um-proj-search","um-proj-automation","um-proj-csv-factory","um-proj-file-types","um-release-notes","dm-overview","dm-walkthrough","dm-plugin-types","dm-first-plugin","dm-eons-plugin","dm-script-api","dm-java-api","dm-pak","dm-settings","dm-setting-hierarchies","dm-setting-collections","dm-dollar-notation","dm-resources","dm-special-urls","dm-res-image","dm-res-font","dm-res-classmap","dm-res-settings","dm-res-string-table","dm-res-tile-set","dm-res-silhouette","dm-res-abbrv-table","dm-installation","dm-named-objects","dm-quickscript","dm-code-editor","dm-test-plugin","dm-debugger","dm-convert-image","dm-draw-regions","dm-type-viewer","dm-setting-explorer","dm-memory","dm-register-game","dm-diy","dm-diy-portraits","dm-diy-bleed-margins","dm-compatibility","dm-diy-prefab","dm-ink-saver","dm-project","dm-project-ext","dm-preferences","dm-context-bar","dm-app-menu","dm-app-commands","dm-export-container","dm-spelling-exclusions","tm-intro","tm-localization","tm-add-new","tm-testing","tm-printf-strings","tm-fitting-text","tm-fonts","tm-plurals","tm-spelling","tm-locales"]}
{"title":["Welcome and quick start guide","Installation on Windows","Installation on macOS","Installation on Linux (and some Chromebooks)","Installation on other platforms","Transferring settings from another computer","Upgrading from Strange Eons 1 or 2","Choosing language settings","Troubleshooting","Portable installations","Command line options","Plug-in essentials","Downloading and installing plug-ins","Managing installed plug-ins","Relaunching the application","Managing update notifications","\"eons cat\" links","Overview of the app interface","Main menu commands","Document tab management","Using and customizing the context bar","Preferences","Creating a new game component","Preview area","Markup text","Portraits","Tints","Expansion symbols","Spelling checking","Thesaurus and other language tools","Using abbreviations to work efficiently","Printing components","Exporting images","Play testing and improving your designs","The marker and token editor","The deck editor","Creating decks","Creating boards","Creating fold-up boxes","Editing commands","Pages and paper size","Splitting large pages when printing","Publisher's marks (crop, fold marks) and bleed margins","Object snapping","Tips for sharing decks","Tips for printing, assembling, and integrating components","Projects","Deck of Cards tasks","Documentation tasks","Factory tasks","Plug-in tasks","Generic tasks","Searching projects","Automation scripts","Making cards from a CSV data file","Supported file types","Release notes","Overview of plug-in authoring","Taking a tour of a plug-in","Plug-in types","Making your first plug-in","The root file","Script library API","Java class API","Plug-in authoring kit","Setting basics","Setting hierarchies","Setting collections","$-notation","Resources","Resource `res://` and other special URLs","Image resources","Font resources","Class map resources","Settings file resources","String table resources","Tile set resources","Silhouette resources","Default abbreviation table resources","Installation notes and scripts","Named objects","Quickscript and the script console","Code editor","Test Plug-in","Script debugger","Converting and compressing images","Draw Regions","Typeface (font file) viewer","Setting Explorer","Memory use and cache control","Register new games and game expansions","Create new card types with DIY components","Add portraits to DIY components","Add bleed margins to DIY components","Change DIY components without breaking old save files","Prefab components: create new component types without code","Customize how a component is drawn in Ink Saver mode","Access the open project and its files","Extend the project system","Extend the **Preferences** dialog","Customize the context bar","Extend the app menu","Use and define application commands","Register an export container","Make the spelling checker ignore game terminology","Overview of localization","Adding support for localization to a plug-in","Adding a new translation","Testing a translation","Handle %-format strings","Fit translated text","Work around fonts that don't support the target locale","Translate strings that use plural forms","Add spelling support for a new language","Table of locale codes"],"file":["um-install-intro","um-install-win","um-install-mac","um-install-linux","um-install-other","um-install-user-folder","um-install-upgrading","um-install-languages","um-install-troubleshooting","um-install-portable","um-install-command-line-options","um-plugins-intro","um-plugins-catalogue","um-plugins-manager","um-plugins-relaunching","um-plugins-updates","um-plugins-eonscat","um-ui-intro","um-ui-menu","um-ui-documents","um-ui-context-bar","um-ui-preferences","um-gc-intro","um-gc-preview","um-gc-markup","um-gc-portraits","um-gc-tints","um-gc-expansions","um-gc-spelling","um-gc-thesaurus","um-gc-abbreviations","um-gc-print","um-gc-export","um-gc-play-testing","um-token-editor","um-deck-intro","um-deck-decks","um-deck-boards","um-deck-boxes","um-deck-commands","um-deck-pages","um-deck-page-split","um-deck-pubmarks","um-deck-snap","um-deck-share-tips","um-deck-print-tips","um-proj-intro","um-proj-deck-task","um-proj-doc-task","um-proj-factory-task","um-proj-plugin-task","um-proj-generic-task","um-proj-search","um-proj-automation","um-proj-csv-factory","um-proj-file-types","um-release-notes","dm-overview","dm-walkthrough","dm-plugin-types","dm-first-plugin","dm-eons-plugin","dm-script-api","dm-java-api","dm-pak","dm-settings","dm-setting-hierarchies","dm-setting-collections","dm-dollar-notation","dm-resources","dm-special-urls","dm-res-image","dm-res-font","dm-res-classmap","dm-res-settings","dm-res-string-table","dm-res-tile-set","dm-res-silhouette","dm-res-abbrv-table","dm-installation","dm-named-objects","dm-quickscript","dm-code-editor","dm-test-plugin","dm-debugger","dm-convert-image","dm-draw-regions","dm-type-viewer","dm-setting-explorer","dm-memory","dm-register-game","dm-diy","dm-diy-portraits","dm-diy-bleed-margins","dm-compatibility","dm-diy-prefab","dm-ink-saver","dm-project","dm-project-ext","dm-preferences","dm-context-bar","dm-app-menu","dm-app-commands","dm-export-container","dm-spelling-exclusions","tm-intro","tm-localization","tm-add-new","tm-testing","tm-printf-strings","tm-fitting-text","tm-fonts","tm-plurals","tm-spelling","tm-locales"]}
Binary file added docs/images/macos-eject.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/macos-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/macos-verify.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/smartscreen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 8 additions & 7 deletions docs/um-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
1. [Welcome and quick start guide](um-install-intro.md)
2. [Installation on Windows](um-install-win.md)
3. [Installation on macOS](um-install-mac.md)
4. [Installation on other platforms](um-install-other.md)
5. [Transferring settings from another computer](um-install-user-folder.md)
6. [Upgrading from Strange Eons 1 or 2](um-install-upgrading.md)
7. [Choosing language settings](um-install-languages.md)
8. [Troubleshooting](um-install-troubleshooting.md)
9. [Portable installations](um-install-portable.md)
10. [Command line options](um-install-command-line-options.md)
4. [Installation on Linux (and some Chromebooks)](um-install-linux.md)
5. [Installation on other platforms](um-install-other.md)
6. [Transferring settings from another computer](um-install-user-folder.md)
7. [Upgrading from Strange Eons 1 or 2](um-install-upgrading.md)
8. [Choosing language settings](um-install-languages.md)
9. [Troubleshooting](um-install-troubleshooting.md)
10. [Portable installations](um-install-portable.md)
11. [Command line options](um-install-command-line-options.md)
2. **Plug-ins**
1. [Plug-in essentials](um-plugins-intro.md)
2. [Downloading and installing plug-ins](um-plugins-catalogue.md)
Expand Down
40 changes: 40 additions & 0 deletions docs/um-install-linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Installation on Linux

This page describes the steps needed to install Strange Eons on desktop PCs running a common Linux distribution, such as Ubuntu.

## System requirements

A Debian package (`.deb`) is available for amd64 (64-bit Intel/AMD) devices. This includes a precompiled private Java runtime, ensuring that Strange Eons has a compatible runtime that will not interfere with any edition of Java you may have installed for general use. If your device is not compatible, see the instructions for [other devices](um-install-other.md) instead.

At least 2 GB of RAM is recommended.

## Installation steps

1. [Download the latest version of Strange Eons for Linux systems.](http://cgjennings.ca/eons/download/update.html?platform=nix) This version is provided as a Debian package (`.deb`).

2. On many systems, including [Chromebooks with the Linux feature enabled](https://support.google.com/chromebook/answer/9145439?hl=en), you can double click on the `.deb` file to install it. Otherwise, in a shell window, in the directory where you downloaded the file, run the following (replacing `{xxxx}` with the correct build number):

```bash
dpkg -i strange-eons-linux-b{xxxx}.deb
```

3. An icon for Strange Eons should be added to your desktop launcher. Open it as you would any other application.

4. After installation, it is safe to delete the downloaded `.deb` package if you wish.

## Troubleshooting

Installation problems are rare but frustrating.

If unpacking the `.deb` package fails, it may mean that the file did not download correctly. Try downloading it again. If it fails again, it may be corrupt on the server: [please report the issue](https://cgjennings.ca/contact.html).

If the `dpkg` command is not available, your distribution may not have built-in support for Debian packages. If your distribution supports Red Hat Package Manager (`.rpm`) packages, you may be able to convert it using a tool called Alien. Look up how to install Alien on your system (if it is not already installed), then try converting and install the package with:

```bash
alien --to-rpm strange-eons-linux-b{xxxx}.deb
rpm -ivh strange-eons-linux-b{xxxx}.rpm
```

If your device does not support Debian packages, is not hardware compatible, or you just can't get this to work, you can instead try installing the version for [other devices](um-install-other.md).
For issues that occur after installation, such as failing to start at the splash screen, refer to the [Troubleshooting](um-install-troubleshooting.md) page.
17 changes: 11 additions & 6 deletions docs/um-install-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,22 @@ This page describes the steps needed to install Strange Eons on macOS PCs.

## System requirements

Intel-based Mac running Mac OS X 10.8.3+ or 10.9+.
Mac running Mac OS X 10.8.3+ or 10.9+.

At least 2 GB of RAM recommended.

## Installation steps

1. [Download the macOS disk image](http://cgjennings.ca/eons/download/update.html?platform=osx) (dmg) file.
2. Double-click the downloaded file to mount the disk image. In a few moments, a Finder window will open showing the contents.
3. Double click to start the installer.
**Note:** if the install package is unsigned, right click the installer and choose **Open**. Then click **Open** again to confirm that you want to run the installer.
4. An installation wizard will guide you through the rest of the process. If you are not sure what to do, stick with the default options. Strange Eons will be added to your **Applications** folder.
1. [Download the macOS disk image](http://cgjennings.ca/eons/download/update.html?platform=osx) (DMG) file. You may be asked if you want to allow downloads on "github.com." Choose **Allow**.
2. Open the downloads stack on the dock, then click the downloaded file to mount the disk image. In a few moments, a Finder window will open showing the contents, the Strange Eons app.
3. Open a new **Finder** window and choose **Applications** from the **Favorites** list.
4. Drag and drop (or copy and paste) the Strange Eons app into your **Applications** folder. If upgrading a previous version, choose **Replace** when prompted.
![dragging into the Applications folder](images/macos-install.png)
5. Wait for the file to copy, then double click the app in your **Applications** folder to start it. The first time, you start it, you will see a message that the app is being *verified*.
6. Since the app was downloaded from the Internet outside of the app store, your Mac will double check that you meant to run it. Choose **Open**.
![macOS security dialog](images/macos-verify.png)
7. After the file has been copied, you can eject the mounted DMG volume.
![ejecting the disk image volume](images/macos-eject.png)

## Troubleshooting

Expand Down
Loading

0 comments on commit 39ac309

Please sign in to comment.