diff --git a/README.md b/README.md index 19cadd5..9d5bc45 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# Case-Insensitive-ASF -Plugin for ASF to make bot names case-insensitive +# ASF Case Insensitive Bot Names Plugin +Plugin for [ASF](https://github.com/JustArchiNET/ArchiSteamFarm/) that makes bot names case-insensitive, so you can use `BotName`, `botname`, and `BoTnAmE` to refer to your bot. Also works for regular expressions in bot names. +Make sure you don't have multiple bots with names that differ only by case (only applicable to case-sensitive file systems of course). If you have two files `BotName.json` and `botname.json` in your config folder - you are guaranteed to have troubles. +Works only with ASF 4.0+ +To use: +- download .zip file from [latest release](https://github.com/Ryzhehvost/Case-Insensitive-ASF/releases/latest), in most cases you need `CaseInsensitiveASF.zip`, but if you use ASF-generic-netf.zip (you really need a strong reason to do that) download `CaseInsensitiveASF-netf.zip`. +- unpack downloaded .zip file to `plugins` folder inside your ASF folder. +- (re)start ASF, you should get a message indicating that plugin loaded successfully. + + +# ������ ��� ASF ����� ������� ����� ������ �������������������� +���� ������ ��� [ASF](https://github.com/JustArchiNET/ArchiSteamFarm/) ��������� ������� ����� ����� ��������������������, ��� ��� ����� `BotName`, `botname`, � `BoTnAmE` ����� ��������� �� ������ ����. �������� ����� ��� ���������� ��������� � ������ �����. +���������, ��� � ��� ��� ���������� �����, ����� ������� ���������� ������ ��������� (����������, ��� �������� ������� ������ ����������������� �������� �������). ���� � ��� � ����� config ���� ��� ����� `BotName.json` � `botname.json` - � ��� �������������� ����� ��������. +�������� ������ � ASF 4.0+ +��� ���������: +- �������� ���� .zip �� [���������� ������](https://github.com/Ryzhehvost/Case-Insensitive-ASF/releases/latest), � ����������� ������� ��� ����� ���� `CaseInsensitiveASF.zip`, �� ���� �� �� �����-�� ������� ����������� ASF-generic-netf.zip (� ��� ����� ����� ������ �������) - �������� `CaseInsensitiveASF-netf.zip`. +- ���������� ��������� ���� .zip � ����� `plugins` ������ ����� ����� � ASF. +- (����)��������� ASF, �� ������ �������� ��������� ��� ������ ������� ��������. +