Skip to content

Commit 05119de

Browse files
committed
Added readme
1 parent 1b5ef51 commit 05119de

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Readme.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Crackshell package for Sublime Text
2+
This package includes several Sublime Text syntaxes for multiple parts of Crackshell's game engine.
3+
4+
1. Complete replacement for the [AngelScript](https://github.com/wronex/sublime-angelscript) syntax, providing a more complete and somewhat context-aware syntax highlighting, specifically suited to fit some of the engine's API.
5+
2. Syntax for `.sval` files. This builds upon the standards of XML, but highlights specific keywords such as `dict`, `array`, `string`, etc. Also specifically highlights strings named `class`, and applies a namespace/class scope to its value.
6+
3. Syntax for `.unit` files. It's also based on XML, and is somewhat context-aware. Behaviors embed the SValue syntax, and attributes are contextually highlighted.
7+
8+
## How to install
9+
The easiest way to install this package is through [Package Control](https://packagecontrol.io/). In Sublime Text, simply press `Ctrl+Shift+P`, navigate to "Install package", and find the package named "Crackshell".
10+
11+
Manual install is done by making a folder in your packages folder. On Windows for example, you clone the repository here: `C:\Users\Username\AppData\Roaming\Sublime Text 3\Packages\Crackshell\`

0 commit comments

Comments
 (0)