stevemeacham/kos-oo-library

This unique kOS library supports class and prototype based object oriented programming and namespaces. It also uses NO GLOBALS and enables any kOS program or library to do the same, large or small, no matter how complex.

The kOS Object-Oriented Library (oolib)

Overview

This unique kOS library supports class and prototype based object oriented programming and namespaces. It also uses NO GLOBALS and enables any kOS program or library to do the same, large or small, no matter how complex.

Origin

Original GitHub Repository

Inspiration

• Gisi, Kevin [CheersKevinGames], (2016, February 21), kOS v0.19.0 Deep Dive - Delegates
  [Video]. YouTube. https://youtu.be/pcbURdU_WyU
• The KSLib Team, (2015), KSLib
  [GitHub repository], https://github.com/KSP-KOS/KSLib

Requirements and Dependencies

• Kerbal Space Program (KSP)
• kOS: Kerbal Operating System (kOS)

Technologies

• KerboScript v1.2.1.0

Support

This library is for programmers, so a certain level of technical acumen and initiative is assumed. Here is the support process:

1. RTFM and do things the way it shows before trying to improve upon it. If that didn't help...
2. Read the library and example usage code. If that didn't help...
3. Look for answers in the Github Issue Tracker.
4. Ask for answers in the Github Issue Tracker.

If it was unclear to you, it will be unclear to others. Become a contributor, pay it forward, and keep it from happening again.

Copyright and License

Copyright © 2020 Steve Meacham and contributors

These programs, the program code, and any examples of program code are free software. Permission is granted to redistribute them and/or modify them under the terms of the GNU General Public License v3.0 or (at your option) any later version. Any programs, program code, or examples of program code that specify compatible Licenses granting additional permissions remain governed by this License without regard to the additional permissions.

The accompanying documentation provides the same freedoms that the software does. Permission is granted to copy, distribute and/or modify the accompanying documentation under the terms of the GNU Free Documentation License v1.3 or (at your option) later. Any documents that specify compatible Licenses granting additional permissions remain governed by this License without regard to the additional permissions.

Repository Structure

• The Script folder corresponds to the folder where the kOS mod looks for scripts. Including it in this repository makes things a little cleaner, but also solves some potential problems when this library is installed without reading the instructions.
• The oolib folder is required. See INSTALL.
  • oolib.ks is the kOS Object Oriented Library. See oolib.md to learn all about it.
  • lib_tty.ks demonstrates using oolib and exposes functions to print with word-wrap, print horizontal rules similar to HTML's hr, and print the contents of text files.
  • bootmsg.ks demonstrates using oolib and lib_tty and exposes a function to print the GPLv3 interactive terminal copyright notice (to make RHS proud) and another to print some information about the kOS Processor it is run on.
  • Files that aren't necessary when running a program, but are in the folder so they remain with with oolib when it is installed.
    • Other *.md files correspond one-to-one with the .ks files and provide useful information about each.
• The oolib/Licenses folder - the name's on the tin.
• The oolib/data folder contains the interactive terminal GPL copyright notice to be printed by bootmsg.ks.
• The boot folder is optional.
  • tinyboot.ks fits in under 100 kOS disk capacity and starts the boot process from the Archive volume.
  • boot.ks, the main boot script, can be run from any volume that contains /oolib/oolib.ks, /oolib/lib_tty.ks, and /oolib/bootmsg.ks.
• INSTALL.md explains how to install oolib in KSP.
• LICENSE is the GPLv3 license text, located and formatted in a way that GitHub likes.
• ksconfig.json provides some useful configuration settings for using Visual Studio Code (VSCode) with this Library, when using the "kOS (KerboScript)" and "Kerbal Operating system" extensions.
• .gitignore keeps unwanted files out of the repository. Specifically, those that sometimes appear when using VSCode, VIM, Emacs, MacOS, Windows, and Linux.

---

This document is part of the kOS Object-Oriented Library documentation.

Copyright © 2020 Steve Meacham and contributors

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License v1.3 or (at your option) later published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included.

kos-oo-library's Issues

Help with .gitignore

We need to verify and clean up the sections that already exist. They are generic lists lifted from elsewhere, and seem to cover far more than would be an issue when editing KerboScript.

Also, more editors need coverage. Especially ATOM, BBEdit, GEdit, Kode, IDEA, Nano, and Sublime Text 3, because all are known to be used in the KerboScripting community.