Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 6.71 KB

SUMMARY.md

File metadata and controls

52 lines (39 loc) · 6.71 KB
Raw

Summary

This repository is created from libraries submitted by multiple kOS users. All contributions are accepted as long as they satisfy the set requirements. As such there may be multiple libraries that provide the same functionality but take different approaches to it.

This is an attempt at summarising and categorising the libraries by their use cases.

Control

  1. lib_pid.ks / docs : provides functions for creating a PID controller. This functionality has been superseded by kOS buil-in PIDLoop().
  2. lib_raw_user_input.ks / docs : Listens for action groups in a list and returns the index of the activated action group.

Data Structures

  1. lib_enum.ks / docs : provides functions to manipulate structures like lists, stacks, queues etc.

External Mod Compatibility

  1. lib_realchute.ks / docs : Provides a way to (dis)arm, deploy and cut chutes if the RealChute mod is installed.

File I/O

  1. lib_file_exists.ks / docs : checks whether a given file exists or not on the current volume. This functionality has been superseded by kOS built-in VOLUME:EXISTS().

Maths and Statistics

  1. lib_running_average_filter.ks / docs : gives a running average of a given list of numbers.
  2. lib_hyperbolic_trigonometry / docs : adds hyperbolic trig functions.

Navigation

  1. lib_circle_nav.ks / docs : provides functions to help with great circle / geodesic navigation while in atmosphere or the surface. For example, finding out the compass heading of a waypoint to fly there along the shortest path.
  2. lib_location_constants.ks / docs : provides latitude longitude values for various locations on some bodies.
  3. lib_navball.ks / docs : provides various navball state values (heading, pitch, roll, etc) of several kOS structures that can be considered to have such state.
  4. lib_navigation.ks / docs : provides a range of functions to used in calculations of both space, atmospheric and surface navigation.

Programming Utilities

  1. lib_exec.ks / docs : allows executing commands and evaluating expressions from strings.

Space Navigation

  1. lib_lazcalc.ks / docs : does launch azimuth calculation.

Terminal Utilities

  1. lib_gui_box.ks / docs : draws ASCII boxes in the terminal.

  2. lib_input_string.ks / docs : creates an on-screen keyboard inside the terminal.

  3. lib_input_terminal / docs : for string input by typing in the terminal.

  4. lib_list_dialog.ks / docs : helps with long list navigation.

  5. lib_menu.ks / docs : draws an interactive menu in the terminal.

  6. lib_num_to_formatted_str.ks / docs : provides functions to format numbers and date-time values in standard formats. For example, numbers with given digit precision and SI unit, time broken into years, months, days etc.

  7. lib_num_to_str.ks / docs : formats numbers to specified number of digits.

  8. lib_number_dialog.ks / docs : draws a dialog box for numerical input in the terminal.

  9. lib_seven_seg.ks / docs : creates a seven segment display to show single digit numbers.

  10. lib_str_to_num.ks / docs : converts numerical strings into numbers. This has been superseded by kOS built-in STRING:TONUMBER().

  11. lib_term.ks / docs : a primitive terminal ASCII graphics library. Helps with drawing straight lines, circles and elliptical arcs.

Copyright © 2019,2020,2021 KSLib team

This work and any code samples presented herein are licensed under the MIT license.