summaryrefslogtreecommitdiffstats
path: root/kolf/README.pool
diff options
context:
space:
mode:
Diffstat (limited to 'kolf/README.pool')
-rw-r--r--kolf/README.pool7
1 files changed, 7 insertions, 0 deletions
diff --git a/kolf/README.pool b/kolf/README.pool
new file mode 100644
index 00000000..a571b1dd
--- /dev/null
+++ b/kolf/README.pool
@@ -0,0 +1,7 @@
+Heya,
+
+I made a kolf pool game as an example of kolf plugin use. kolf/obects/poolball/ contains the PoolBall class, which is installed as a plugin.
+
+So, compile PoolBall, install it, and open pool.kolf. Kolf courses can specify any object name, and it is up to the user to install these objects that the course needs. Kolf will warn when an object is not found in the hole being loaded.
+
+Jason