From 5b1669b461b319ccbfdab1f0fc949000dfc30387 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Wed, 11 May 2022 21:57:25 +0200 Subject: [PATCH] Rename 'Supybot' to 'Limnoria' in introductory material At this point, it's just confusing to keep refering to Supybot, especially for new users. --- use/configuration.rst | 18 ++++++------- use/faq.rst | 48 ++++++++++++++++----------------- use/httpserver.rst | 2 +- use/identifying_to_services.rst | 2 +- use/install.rst | 11 +++++--- use/install_windows.rst | 21 ++++++++------- use/supybot-botchk.rst | 6 ++--- 7 files changed, 57 insertions(+), 51 deletions(-) diff --git a/use/configuration.rst b/use/configuration.rst index a7a851d..04c364e 100644 --- a/use/configuration.rst +++ b/use/configuration.rst @@ -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 diff --git a/use/faq.rst b/use/faq.rst index fae2d82..127a16f 100644 --- a/use/faq.rst +++ b/use/faq.rst @@ -11,8 +11,8 @@ administrator. .. _user-faq-multi-servers: -How do I make my Supybot connect to multiple servers? -===================================================== +How do I make my Limnoria connect to multiple servers? +====================================================== Just use the `connect` command in the `Network` plugin. @@ -47,7 +47,7 @@ What is a hostmask? Each user on IRC is uniquely identified by a string which we call a ``hostmask``. The IRC specifications refers to it as a "prefix" or "source". Either way, it consists of a nick, a user, and a host, in the form - ``nick!user@host``. If your Supybot complains that something you've + ``nick!user@host``. If your Limnoria complains that something you've given to it isn't a hostmask, make sure that you have those three components and that they're joined in the appropriate manner. @@ -134,7 +134,7 @@ What does 'lobotomized' mean? ============================= I see this word in commands and in my `channels.conf`, but I don't - know what it means. What does Supybot mean when it says lobotomized? + know what it means. What does Limnoria mean when it says lobotomized? A lobotomy is an operation that removes the frontal lobe of the brain, the part that does most of a person's thinking. To lobotomize a bot @@ -144,13 +144,13 @@ What does 'lobotomized' mean? The term is certainly suboptimal, but remains in use because it was historically used by certain other IRC bots, and we wanted to ease the - transition to Supybot from those bots by reusing as much terminology + transition to Limnoria from those bots by reusing as much terminology as possible. .. _user-faq-load-all-plugins: -Is there a way to load all the plugins Supybot has? -=================================================== +Is there a way to load all the plugins Limnoria has? +==================================================== No, there isn't. Even if there were, some plugins conflict with other plugins, so it wouldn't make much sense to load them. For instance, @@ -190,20 +190,20 @@ Why doesn't `Karma` seem to work for me? .. _user-faq-ignore-private-message: -Why won't Supybot respond to private messages? +Why won't Limnoria respond to private messages? ============================================== The most likely cause is that your bot has a mode blocking messages from unregistered users. Around Sept. 2005, for example, Freenode added a user mode where registered users could set ``+R``, which `blocks`_ private messages from unregistered users. So, the reason you aren't - seeing a response from your Supybot is likely: + seeing a response from your Limnoria is likely: - * Your Supybot is not registered with NickServ, you are registered, + * Your Limnoria is not registered with NickServ, you are registered, and you have set the +R user mode for yourself. - * or: you have registered your Supybot with NickServ, you aren't - registered, and your Supybot has the +R user mode set. + * or: you have registered your Limnoria with NickServ, you aren't + registered, and your Limnoria has the +R user mode set. .. _user-faq-admin-change-config: @@ -217,36 +217,36 @@ Can users with the admin capability change the configuration? .. _user-faq-log-channel: -How can I make my Supybot log my IRC channel? -============================================= +How can I make my Limnoria log my IRC channel? +============================================== - To log all the channels your Supybot is in, simply load the + To log all the channels your Limnoria is in, simply load the `ChannelLogger` plugin, which is included in the main distribution. .. _user-faq-irc-proxy: -Can Supybot connect through a proxy server? -=========================================== +Can Limnoria connect through a proxy server? +============================================ Limnoria can connect to specific network using socks proxy, simply set the configuration variable `supybot.networks..socksproxy`. For specifying proxy which is used for HTTP requests, set the configuration variable `supybot.protocols.http.proxy`. - Supybot also works with transparent proxy server helpers like tsocks_ - that are designed to proxy-enable all network applications, and Supybot + Limnoria also works with transparent proxy server helpers like tsocks_ + that are designed to proxy-enable all network applications, and Limnoria does work with these. .. _user-faq-cannot-find-plugin: -Why can't Supybot find the plugin I want to load? -================================================= +Why can't Limnoria find the plugin I want to load? +================================================== Why does my bot say that 'No plugin "foo" exists.' when I try to load the foo plugin? First, make sure you are typing the plugin name correctly. ``@load - foo`` may not be the same as ``@load Foo`` depending on your Supybot + foo`` may not be the same as ``@load Foo`` depending on your Limnoria version [#plugindir]_. If that is not the problem, .. [#plugindir] Yes, it used to be the same, but then we moved to using @@ -311,8 +311,8 @@ try increasing it further. .. _user-faq-make-silent: -Can I make Supybot silent, but still working on channel (as titlesnarfer or something)? -======================================================================================= +Can I make Limnoria silent, but still working on channel (as titlesnarfer or something)? +======================================================================================== With lobotomy, the bot stops doing everything on the channel. If you want it to not reply to commands, but still work as titlesnarfer or similar, you diff --git a/use/httpserver.rst b/use/httpserver.rst index 2dbf6ef..8c787e5 100644 --- a/use/httpserver.rst +++ b/use/httpserver.rst @@ -28,7 +28,7 @@ At the root of the server, you will find a list of the plugins that have a Web interface, and a link to them. Each plugin has one or more subdirectories of its own. -You may also want to run Apache httpd or Nginx in front of Supybot's HTTP +You may also want to run Apache httpd or Nginx in front of Limnoria's HTTP server, if you want to use subdomains or load balancing. Here is an example of Apache httpd configuration (I didn't test it diff --git a/use/identifying_to_services.rst b/use/identifying_to_services.rst index 0267c2e..d234f17 100644 --- a/use/identifying_to_services.rst +++ b/use/identifying_to_services.rst @@ -180,7 +180,7 @@ that have been fixed since then. You should always run the latest release. Services plugin --------------- -The Services plugin comes with Supybot and should be an easy way to +The Services plugin comes with Limnoria and should be an easy way to identify your bot, but SASL is recommended over it. Start by loading Services with:: diff --git a/use/install.rst b/use/install.rst index 1f5c3c8..cff2058 100644 --- a/use/install.rst +++ b/use/install.rst @@ -183,9 +183,14 @@ guide: https://pip.pypa.io/en/stable/installing/ Configuration ************* -We are now ready to configure Supybot. Supybot creates quite a few auxiliary +.. note:: + + For historical reasons, commands are called ``supybot``; but they actually + run Limnoria. + +We are now ready to configure Limnoria. Limnoria creates quite a few auxiliary files/directories to store its runtime data. It is thus recommended to create -an empty directory from which you'll be running supybot, to keep all the data +an empty directory from which you'll be running Limnoria, to keep all the data in a nice dedicated location. For example, you may create a 'runbot' directory inside your home directory. @@ -231,4 +236,4 @@ can use one of these methods: .. _ProgVal's build repo: https://builds.progval.net/limnoria/ .. _Limnoria repository: https://github.com/ProgVal/Limnoria -.. _git: https://git-scm.com/ \ No newline at end of file +.. _git: https://git-scm.com/ diff --git a/use/install_windows.rst b/use/install_windows.rst index 770a279..3ea9bed 100644 --- a/use/install_windows.rst +++ b/use/install_windows.rst @@ -5,7 +5,7 @@ Installing Limnoria on Windows ****************************** This is the "easy to follow" guide to installing Limnoria. The installation -documentation provided with the supybot distribution is really quite good +documentation provided with the Limnoria distribution is really quite good already, but since people keep coming to IRC, asking a repeating pattern of questions, we thought it would be a good idea to expand it a bit to make it a little more of a "foolproof guide". @@ -14,10 +14,6 @@ This guide is only for Windows. If you don't want to install on Windows, check out the :ref:`non-Windows install guide `. -.. note:: - - Limnoria is a modified version of Supybot. - .. highlight:: bat Install @@ -44,7 +40,7 @@ points to correct python. Open ``cmd.exe`` (press the Windows button on your keyboard and type "cmd.exe") and run ``where python`` and the toppernmost entry should be ``C:\Python35\python.exe``. -Install Supybot +Install Limnoria --------------- Now we are ready to install Limnoria and it's requirements. Open @@ -54,15 +50,20 @@ and run:: python3 -m pip install -r https://raw.githubusercontent.com/ProgVal/Limnoria/master/requirements.txt --upgrade python3 -m pip install limnoria --upgrade -We are now ready to configure Supybot. Supybot creates quite a few +We are now ready to configure Limnoria. Limnoria creates quite a few auxiliary files/directories to store its runtime data. It is thus recommended to create an empty directory from which you'll be running -supybot, to keep all the data in a nice dedicated location. +Limnoria, to keep all the data in a nice dedicated location. For example, you may create a ``C:\Users\\runbot`` for this purpose. -Configure Supybot -================= +Configure Limnoria +================== + +.. note:: + + For historical reasons, commands are called ``supybot``; but they actually + run Limnoria. Now you open cmd.exe as **normal user**, and create and cd into your runbot directory:: diff --git a/use/supybot-botchk.rst b/use/supybot-botchk.rst index 632a5a9..ca18ea6 100644 --- a/use/supybot-botchk.rst +++ b/use/supybot-botchk.rst @@ -22,7 +22,7 @@ Create a new file ``/etc/systemd/system/.service`` with the following content replacing things were suitable:: [Unit] - Description=Supybot + Description=Limnoria After=network.target [Service] @@ -33,7 +33,7 @@ following content replacing things were suitable:: ExecReload=/bin/kill -HUP $MAINPID Restart=always User=BOTUSERNAME - SyslogIdentifier=Supybot + SyslogIdentifier=Limnoria [Install] WantedBy=multi-user.target @@ -61,7 +61,7 @@ Some commands supybot-botchk ============== -supybot-botchk is a script that comes with Supybot which restarts the bot +supybot-botchk is a script that comes with Limnoria which restarts the bot if it quits or system reboots or anything that causes the bot to quit. It's placed to crontab so cron will run it with scheduled intervals.