From 0ef193262a053326a3d3e610496d0c4702472ad8 Mon Sep 17 00:00:00 2001
From: SilverSokolova <80606782+SilverSokolova@users.noreply.github.com>
Date: Wed, 30 Apr 2025 01:11:47 -0500
Subject: songbook documentation

---
 doc/lua/openstarbound/songbook.md | 51 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 doc/lua/openstarbound/songbook.md

(limited to 'doc/lua')

diff --git a/doc/lua/openstarbound/songbook.md b/doc/lua/openstarbound/songbook.md
new file mode 100644
index 0000000..72204f1
--- /dev/null
+++ b/doc/lua/openstarbound/songbook.md
@@ -0,0 +1,51 @@
+# Songbook
+
+The new songbook table is accessible from players and NPC's.
+
+---
+
+#### `String` songbook.band()
+
+Returns a string containing the instrumentalist's current band. Defaults to `""`.
+
+---
+
+#### `song` songbook.song()
+
+Returns the notes of the song currently being played.
+
+---
+
+#### `?` songbook.keepAlive(`?` ?)
+
+todo
+
+---
+
+#### `void` songbook.stop()
+
+Causes the instrumentalist to stop playing.
+
+---
+
+#### `bool` songbook.active()
+
+Returns whether the instrumentalist is playing a song.
+
+---
+
+#### `bool` songbook.instrumentPlaying()
+
+Returns whether the instrumentalist is currently performing part of a song.
+
+---
+
+#### `void` songbook.play(`?` ?)
+
+todo
+
+---
+
+#### `String` songbook.instrument()
+
+Returns the type of instrument last played, as determined by the instrument's `kind` value. Defaults to `""`.
-- 
cgit v1.2.3