Skip to content

Commit

Permalink
modified: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cracktorio committed Jun 9, 2023
1 parent b78e907 commit fba5cae
Showing 1 changed file with 9 additions and 31 deletions.
40 changes: 9 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,31 @@
![MkON](/logo.png "MkON")

MkON is a completely modular control panel UI for [Telemachus](http://forum.kerbalspaceprogram.com/threads/24594-0-23-Telemachus-%E2%80%93-Telemetry-and-Flight-Control-in-the-Web-Browser-(2014-1-11)) (see below) and Kerbal Space Program. The UI is designed to work on tablets and second monitors as an auxiliary display and is styled in the KSP aesthetic. It also allows a degree of control using pressable buttons, dials, meters and lots of data for number junkies.

* [Telemachus](http://forum.kerbalspaceprogram.com/threads/24594-0-23-Telemachus-%E2%80%93-Telemetry-and-Flight-Control-in-the-Web-Browser-(2014-1-11)) is a plugin by [Richard Bunt](https://github.com/richardbunt) for Kerbal Space Program that allows real-time in game telemetry to be viewed in the browser. It's pretty awesome, actually.
Please refer to the [original project](https://github.com/chhhrrriiisss/mkon/) for more info, i only fixed the icons not working.

<br />

![MkON](preview.jpg)

_MkON controls on a touch tablet, with a second monitor showing resource information._

## Features
## updates

- A huge variety of buttons, dials, screens, scales and controls.
- A fun and bright UI that works well with Kerbal Space Program.
- Automatic saving of layouts (same device) and the ability to export/import them to screens of the same resolution.
- Common KSP Keyboard shortcuts for some modules (SAS, RCS, GEAR etc).
- Working touch screen support for most buttons and controls.
- edited index.html to refer to the right awesome-font.css file
- added the previously referred file to the right location

## Installation

- You need to download and install the latest release of [Telemachus](https://github.com/richardbunt/Telemachus/releases)
- Download the latest version of [MKON](https://github.com/chrisnic/mkon/releases)
- Go to your KSP Folder/Game Data/Telemachus/Plugins/PluginData/Telemachus folder and delete or move the existing contents to a backup folder.
- Copy the contents of the MkON zip into the above folder.
- You need to download and install the latest release of [Telemachus](https://github.com/TeleIO/Telemachus-1/releases/), this is most easily done by searching for it in ckan, and then pressing the checkmark for the latest version on the right (it is "incompatible", this is not true).
- Download the latest version of [mkon-iconfix](https://github.comBlokheck011/mkon-iconfix/releases), extract the zip and make sure the extracted folder is called "MKON", with all the files inside (e.g. index.html)
- Go to your KSP Folder/GameData/Telemachus/Plugins/PluginData/Telemachus and delete the mkon folder (if there is one already).
- Copy the mkon folder into the above folder.
- Load up KSP and open Telemachus as you would normally - follow the [Telemachus user guide](https://github.com/richardbunt/Telemachus/wiki/User-Guide).
- open the telemachus menu

## How to use

Please see the [wiki](https://github.com/chrisnic/mkon/wiki).

## Coming Soon

- Working 3D Navball, with touch support.
- Draggable throttle control.
- 2D GPS Map.
- Switches and alternative button designs.
- Improved layout saving options (swipe to switch between).

## Disclaimer

This project is very much a work in progress. Expect bugs, occasional slowness and wierd errors but most of the time a refresh will fix it. Optimization will focus exclusively on tablets and desktops/laptops first. Currently tested working environments include:

- Chrome, Safari, Firefox on Windows/OSX for desktops and laptops.
- Chrome, Safari for iPad 4.
- Chrome, Safari for Android Tablets (Asus Transformer Prime).

If you find a bug, or something you think should be added please submit it [here](https://github.com/chrisnic/mkon/issues).

## License

[Attribution-NonCommercial-NoDerivatives 4.0 International](http://creativecommons.org/licenses/by-nc-nd/4.0/)

0 comments on commit fba5cae

Please sign in to comment.