Limnoria/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Limnoria/Limnoria-doc.git synced 2025-04-05 14:59:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename 'Supybot' to 'Limnoria' in introductory material

Browse Source 
At this point, it's just confusing to keep refering to Supybot,
especially for new users.
This commit is contained in:
Valentin Lorentz
2022-05-11 21:57:25 +02:00
parent 93cb169e8c
commit 5b1669b461
7 changed files with 57 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
use/configuration.rst
View File

@ -4,13 +4,13 @@ Configuration
Introduction
------------
So you've got your Supybot up and running and there are some things you
So you've got your Limnoria up and running and there are some things you
don't like about it. Fortunately for you, chances are that these things
are configurable, and this document is here to tell you how to configure
them.
Configuration of Supybot is handled via the `Config` plugin, which
controls runtime access to Supybot's registry (the configuration file
Configuration of Limnoria is handled via the `Config` plugin, which
controls runtime access to Limnoria's registry (the configuration file
generated by the 'supybot-wizard' program you ran). The `Config` plugin
provides a way to get or set variables, to list the available variables,
and even to get help for certain variables. Take a moment now to read
@ -20,13 +20,13 @@ GETTING_STARTED document.
Configuration Registry
----------------------
Now, if you're used to the Windows registry, don't worry, Supybot's
Now, if you're used to the Windows registry, don't worry, Limnoria's
registry is completely different. For one, it's completely plain text.
But there is at least one good idea in Windows' registry: hierarchical
configuration.
Supybot's configuration variables are organized in a hierarchy:
variables having to do with the way Supybot makes replies all start with
Limnoria's configuration variables are organized in a hierarchy:
variables having to do with the way Limnoria makes replies all start with
`supybot.reply`; variables having to do with the way a plugin works all
start with `supybot.plugins.Plugin` (where 'Plugin' is the name of the
plugin in question). This hierarchy is nice because it means the user
@ -38,9 +38,9 @@ under the base group, `supybot`. Things like the bot's nick, its ident,
etc. Along with these config values are a few subgroups that contain
other values. Some of the more prominent subgroups are: `plugins`
(where all the plugin-specific configuration is held), `reply` (where
variables affecting the way a Supybot makes its replies resides),
variables affecting the way a Limnoria makes its replies resides),
`replies` (where all the specific standard replies are kept), and
`directories` (where all the directories a Supybot uses are defined).
`directories` (where all the directories a Limnoria uses are defined).
There are other subgroups as well, but these are the ones we'll use in
our example.
@ -177,7 +177,7 @@ configuration and user/channel/ignore database configuration.
Just edit the interesting files and then give the bot the ``config
reload`` command and it'll work as expected. Do note, however, that
Supybot flushes its configuration files and database to disk every hour
Limnoria flushes its configuration files and database to disk every hour
or so, and if this happens after you've edited your configuration files
but before you reload your changes, you could lose the changes you made.
To prevent this, set the `supybot.flush` value to 'Off' while editing