From 2f63738433810b889199c0a3689be50b3b74aa1a Mon Sep 17 00:00:00 2001 From: Tim Vaughan Date: Fri, 29 May 2020 10:01:46 +0200 Subject: [PATCH] Fleshed out welcome page, added README. --- README | 39 +++++++++++++++++++++++++++++++++++++++ directory.gmi | 5 +++++ index.gmi | 25 ++++++++++++++++++++++--- 3 files changed, 66 insertions(+), 3 deletions(-) create mode 100644 README create mode 100644 directory.gmi diff --git a/README b/README new file mode 100644 index 0000000..306e81b --- /dev/null +++ b/README @@ -0,0 +1,39 @@ +μBotany +======= + +μBotany is an experiment to see what can be done in gemini without +employing client-side TLS certificates. In place of these, we rely on +an account identifier (a SHA-1 hash of the account name and some +random salt) transmitted in the query portion of the URI to uniquely +specify accounts. Because this identifier is difficult to guess from +the account name, and because the URI is transmitted to the server +over TLS, I don't think this is a _terrible_ way of managing sessions. + +μBotany is inspired by (i.e. a flagrant ripoff of) Mozz's Astrobotany, +which can be found at gemini://astrobotany.mozz.us/. However, it's +best thought of as a cut-down implementation of Jacob Funke's original +Botany game, the source for which can be found at +https://github.com/jifunks/botany. + +All of the plant descriptions and ascii art have been copied directly +from the original, while the logic has been entirely reimagined and +implemented as Chicken Scheme extension scripts to my RAGS gemini +server. + +Installation +------------ + +To install and run μBotany you'll first need to be running the RAGS +gemini server. (Source available at +gopher://thelambdalab.xyz/1/scripts/browse-git%7Crags.git.) +Then, simply move this directory to a directory named "microbotany" within the content +root of your server. You should then be able to create new gardens by +visiting gemini://your.server/microbotany/. + +Licence +------- + +μBotany is derived from Jacob Funke's Botany game, which he released +under the ISC free software license. Thus μBotany is also distributed +under the same license, which can be found in the file named LICENSE. + diff --git a/directory.gmi b/directory.gmi new file mode 100644 index 0000000..56a8259 --- /dev/null +++ b/directory.gmi @@ -0,0 +1,5 @@ +# Garden directory + +The μBotany garden directory isn't yet implemented. + +=> ./ Return to start page \ No newline at end of file diff --git a/index.gmi b/index.gmi index 9a00e89..44db42a 100644 --- a/index.gmi +++ b/index.gmi @@ -1,8 +1,27 @@ # μBotany -This is a flagrant and flawed ripoff of Mozz's wonderful Astrobotany, mostly to experiment with what can be done without client-side TLS certificates. +## Introduction + +Welcome to my flagrant and flawed ripoff of Mozz's wonderful Astrobotany, which is itself a fork of Jakob Funke's multi-user python game, Botany. (See below) + +For a *much* better botany experience, use one of the many awsome gemini clients which support client-side TLS certificates and go to: +=> gemini://astrobotany.mozz.us/ Astrobotany + +Some gemini clients - Elpher among them - are yet to properly support such certificates. μBotany aims to bring the joy of gardening to users of such clients! + +## Gardening => register.scm Register a new account -=> view.scm Visit your plant -=> directory.scm View the garden directory +=> directory.gmi View the garden directory + +## About + +μBotany is really just an experiment to see what can be done without employing client-side TLS certificates. In places of these, we rely on an account identifier (a SHA-1 hash of the account name and some random salt) transmitted in the query portion of the URI to uniquely specify accounts. Because this identifier is difficult to guess from the account name, and because the URI is transmitted to the server over TLS, I don't think this is a _terrible_ way of managing sessions. + +As mentioned, μBotany is inspired by Mozz's Astrobotany. However, it's best thought of as a cut-down implementation of Jacob Funke's original Botany game, the source for which can be found here: +=> https://github.com/jifunks/botany + +All of the plant descriptions and ascii art have been copied directly from the original, while the logic has been entirely reimagined and implemented as Chicken Scheme extension scripts to my RAGS gemini server. +=> gopher://thelambdalab.xyz/1/scripts/browse-git.scm%7Cmicrobotany.git μBotany source (gopher) +=> https://thelambdalab.xyz/gitweb/index.cgi?p=microbotany.git μBotany source (web) -- 2.20.1