Skip to content

Commit 709920a

Browse files
committed
Update README + screenshots
1 parent 55cffc2 commit 709920a

File tree

3 files changed

+16
-7
lines changed

3 files changed

+16
-7
lines changed

README.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
1-
KSP-tmLanguage
2-
==============
1+
# Kerbal Space Program Configuration Syntax
32

4-
This is a `.tmLanguage` specification for configuration files in [Kerbal Space Program](https://kerbalspaceprogram.com/), including `persistent.sfs` and `part.cfg` files. I developed this for syntax highlighting when editing these files in [Sublime Text](http://www.sublimetext.com/). I'm also trying to support ModuleManager syntax.
3+
![Screenshot of persistent.sfs](Screenshot.png)
54

6-
`KSP configuration.JSON-tmLanguage` is the JSON "source" for the specification, which can be "compiled" into the XML `.tmLanguage` type with [AAAPackageDev](https://github.com/SublimeText/AAAPackageDev). All the work is done in the JSON.
5+
This is a `.tmLanguage` specification for configuration files in [Kerbal Space Program](https://kerbalspaceprogram.com/), including `persistent.sfs` and `part.cfg` files.
6+
I developed this for syntax highlighting when editing these files in [Sublime Text](http://www.sublimetext.com/).
77

8-
To use with Sublime Text select Sublime Text Preferences -> Browse Packages... in Sublime Text, and copy `KSP configuration.tmLanguage` to `Packages/User/`. It is also available under [Package Control](https://sublime.wbond.net/).
8+
It *mostly* supports ModuleManager syntax:
99

10-
[Here's how it looks.](http://i.imgur.com/8RN3o4g.png)
10+
![Screenshot of FerramAerospaceResearch.cfg](Screenshot-ModuleManager.png)
1111

12-
I am quite new to regex so I welcome suggestions. It's far from complete.
12+
Note: this screenshot contains data from [Ferram-Aerospace-Research](https://github.com/ferram4/Ferram-Aerospace-Research/blob/master/GameData/FerramAerospaceResearch/FerramAerospaceResearch.cfg) by [ferram4](https://github.com/ferram4), licenced under GNU.
13+
14+
`KSP configuration.JSON-tmLanguage` is the JSON "source" for the specification, which can be "compiled" into the XML `.tmLanguage` type with [AAAPackageDev](https://github.com/SublimeText/AAAPackageDev).
15+
All the work is done in the JSON.
16+
17+
## Installation
18+
Installation through [Package Control](https://packagecontrol.io/packages/Kerbal%20Space%20Program%20Configuration%20Syntax) is preferred.
19+
20+
## Contributing
21+
Please [file an issue](https://github.com/NathanJang/KSP-tmLanguage/issues) or fork if you have any suggestions!

Screenshot-ModuleManager.png

217 KB
Loading

Screenshot.png

197 KB
Loading

0 commit comments

Comments
 (0)