Skip to content

Zoomah/StarboundApiDocViewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Download Latest Release: Version 1.0


Starbound API Documentation Viewer

This Viewer provides an easy to use interface to the modding help files of Starbound

Features

  • Clear and simple user interface
  • .md files are always taken from the starbound path
  • Simple switching between documents
  • Search and highlight matches in the file
  • Document zoom: 50% - 200%
  • (Re)setting of the Starbound path, for example to target the unstable branch instead

User Interface

Viewer GUI

  1. List of documents
  2. Current document
  3. Select another Starbound directory (i.e. unstable)
  4. Searchbox - Starts to search automatically after you stopped typing for 0.8 seconds
  • ENTER (in Searchbox) Searches immetiadly
  • CTRL + F (from anywhere) - Jump to Searchbox
  • ESC (from anywhere) - Clear Searchbox and remove highlights from the document view
  1. Jump to the previous match in the current document (SHIFT + F3)
  2. Jump to the next match in the current document (F3)
  3. Zoom controls

Requirements