ksc

ksc - Kerboscript Compiler

ksc: The Kerboscript compiler for your command line.

Table Of Content

1. Idea and Use Case 🤔
2. Installation 💻
3. Usage ⌨️
4. Bugs and Features 🐞💡
5. Buy me a coffee ☕
6. License 📃

---

1. Idea and Use Case

This project started out with me working on my open source educational project called Project Artemis where I will try to completely automate a space program with Kerbal Space Program and the mod kOS. While writting my first few lines of Kerboscript it became very cumbersome and error prone to see if the written code is compilable without a lot of copying and running KSP. I just wanted to keep productive without a context switch.

This is the solution I came up with, a CLI for managing Kerboscript projects with features to compile, run and deploy Kerboscript with just a simple command, and even with your custom compile and deployment scripts written in entirely in Kerboscript!

2. Installation

The CLI can easily be installed over npm (Node Package Manager). Which can be installed by installing nodejs.

> npm install -g ksc

That's it, now you're up and running!

3. Usage

For a detailed usage guide please visit the documentation page here.

However, if you the explorer type use this:

> ksc help

4. Bugs and Features

Please open a issue when you encounter any bugs 🐞 or if you have an idea for a additional feature 💡.

5. Buy me a coffee

If you like you can buy me a coffee:

---

6. License

MIT License

Copyright (c) 2019 mrbandler

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.