ReadMe for Myriarch 1.0.1

Program: Myriarch Combat Simulator
Version: 1.0.1 (History)
Released: 30 September 2015
Author: Christoph Nahr (Copyright)
Contact: webmaster@kynosarges.org
Website: http://kynosarges.org/Myriarch.html

Table of Contents

  1. Quick Start
  2. Documentation
  3. System Requirements
  4. Security Permissions
  5. Installed Files
  6. Deinstallation
  7. Source Package
  8. Copyright Notice
  9. Known Issues

1. Quick Start

Make sure that the .NET Framework 4 Client Profile or newer is installed on your Microsoft Windows system. Unpack the binary package to any directory of your choice.

Run Myriarch.exe. The built-in demo scenario Leuctra starts automatically. Choose Play or press Ctrl+P to start the simulation.

2. Documentation

Myriarch ships with a built-in help system. Choose Help or press F1 to show the help index, or the help page associated with an open dialog window.

The help system ships as a collection of loose HTML pages in the Help subdirectory. You can view them without running Myriarch, e.g. Help\Overview.html for an overview of implemented and planned features.

Class Reference

The Myriarch source code is documented by a comprehensive class reference, available as a separate download at the Myriarch home page. This reference is a collection of HTML pages that was created from XML source code comments using the free Sandcastle help compiler.

3. System Requirements

Myriarch requires a Microsoft Windows system capable of running the Microsoft .NET Framework 4 Client Profile or any newer .NET 4.x release. This includes the following operating systems:

On all of these systems, Microsoft Internet Explorer 5.01 or later and Microsoft Windows Installer 3.1 or later are also required. Any post-XP system will already have those.

4. Security Permissions

Myriarch requires a number of .NET security permissions that are available only when the executable is running with “Full Trust”. This is usually the case for all .NET programs that are run from a local hard disk or a shared network drive. Myriarch does not require administrator privileges.

5. Installed Files

The binary package contains the following files:

ReadMe.html This file
WhatsNew.html Myriarch version history
Myriarch.exe Myriarch application
Myriarch.Core.dll Myriarch simulation engine
Help\* Myriarch help pages
Myriarch.Simulation.xsd XML schema definition for simulation files
HtmlConverter.dll XAML/HTML conversion library (see below)
Tektosyne.Core.dll Tektosyne utility library (see below)
Tektosyne.Windows.dll Tektosyne utility library (see below)
*.exe.config .NET application configuration file

6. Deinstallation

Since Myriarch has no formal installer, you can simply uninstall the binary package by deleting its directory. You may also with to delete your simulation files which are saved under the Myriarch subdirectory of the local application data folder of any user who had been running Myriarch.

7. Source Package

This section provides additional information regarding the source package, available as a separate download at the Myriarch home page. The directory to which the archive is unpacked contains the source files required to build all .NET assemblies comprising the binary package.

You need either Microsoft Visual Studio (2010 or later) or the free Microsoft Windows SDK 7.1 for Windows 7 and .NET 4 to perform the build. Windows SDK 7.1 has the same system requirements as the .NET Framework 4 itself but also requires that you first install the full .NET Framework 4 – not just the Client Profile.

The subdirectory Tektosyne contains version 5.6.6 of my Tektosyne library. The current version of this class library is also available as a separate download at the Tektosyne home page, but this is not required to run or compile Myriarch.

Building Myriarch

Use Visual Studio or MSBuild to load or build the solution Myriarch\Myriarch.sln. The output directory is Myriarch\bin. This directory contains other files and subdirectories which are not created during the build process but which must be present for Myriarch to execute properly. Please refer to Installed Files for details.

Rebuilding the solution will create an “unsupported developer version” because the assemblies are no longer signed with the expected strong name. There are only two differences to the version in the binary package: the About Myriarch dialog will show a warning, and error reporting by e-mail will be disabled.

You can use the free Visual C# Express IDE instead of the full Visual Studio. However, the Express edition has several artificial limitations, including a lack of support for “solution items”. These are files that are linked to a solution but not to any particular project, such as this ReadMe file. Express users will have to locate and open these files manually. This restriction does not apply to the free Visual Studio 2015 Community edition.

The distribution package was created by running MSBuild on the separate build script Publish.proj. This script offers the following targets:

The default target is “Publish”. You need a key container named “Kynosarges” and the applications 7-Zip for this target to succeed.

The HtmlConverter Library

Myriarch includes the XAML/HTML Converter library, created by members of Microsoft’s WPF team. This library is old and unfinished but still quite useful to convert simple HTML markup into WPF FlowDocument format for display. Myriarch uses this feature to allow basic formatting in scenario descriptions.

8. Copyright Notice

All files – individual files, multi-file packages, and individual files contained in multi-file packages – that constitute the original distribution of Myriarch are Copyright © 2012–2015 by Christoph Nahr, except where otherwise noted.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

HtmlConverter

The included HtmlConverter library is Copyright © 2006 Microsoft and free to use, as far as I could figure out. The download was posted on WindowsClient.net without any formal license.

9. Known Issues

Class Reference

The current Sandcastle release that was used to build the Class Reference still has a few bugs. You may encounter the following issues:

When in doubt, please refer to the source code for the correct documentation.