From c17b62bbaf6695c68a4eadf51872fbeb70db7930 Mon Sep 17 00:00:00 2001 From: Maxwell Date: Mon, 15 Jul 2024 17:49:54 +1000 Subject: [PATCH] Add Configuration --- Configuration.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 Configuration.md diff --git a/Configuration.md b/Configuration.md new file mode 100644 index 0000000..513d59f --- /dev/null +++ b/Configuration.md @@ -0,0 +1,31 @@ +# Configuration + +Make Mash your own with a configuration file. + +### Overview + +Mash uses an easy-ish to read syntax for configuration. An example line would look something like this: + +`thingToConfigure:confOptionOne;confOptionTwo;confOptionThree;` + +thingToConfigure stands for the option inside of Mash you are configuring, whereas all the other confOptions are completely customisable, depending on what you might use it for. + +Start your line of config with the thing you're configuring, add a colon seperating (without a space), seperate any suboptions with semicolons, and end each line with a comma. Start a new line with your next config option. Note that you can use spaces in your configuration without messing anything up, and without the need for quotation marks. + +Mash will look for a config file first at `.config/mash/mash.conf`, then at `/etc/mash/mash.conf`. Using the Mash install script, `/etc/mash/mash.conf` should be created. + +### Things to Configure + +This will be updated as more options are avaliable. + +* MOTD + +> Overview: Change the message on startup +> Syntax: motd:(your startup message here), +> Default: motd:Welcome to Mash!, + +* Mash Path + +> Overview: Change where Mash looks for programs +> Syntax: mashPath:/path/to/dir;/path/to/dir, +> Default: mashPath:/bin;/usr/bin;/usr/local/bin;/sbin;/usr/sbin, \ No newline at end of file