Added Instructions and clean users.txt

README.md

@@ -1,21 +1,111 @@
 # EmuLinkerSF
-EmuLinkerSF is a modified version of EmuLinker Kaillera network server created by Moosehead with new features by Suprafast.
-Original EmuLinker can be found here: https://github.com/monospacesoftware/emulinker
-******************
+EmuLinkerSF модифицированная версия EmuLinker Kaillera network server созданный 
+Moosehead с новыми функциями от Suprafast.
+
+Основной проект EmuLinker: https://github.com/monospacesoftware/emulinker
+
+Основной проект EmuLinkerSF: https://github.com/God-Weapon/EmuLinkerSF
+## Пометка автора
 This is unofficially updated version of EmulinkeSF, based on original latest source v72.3 (09-20-2009).
 This version includes bug fixes and other improvements.
-******************
 
-## Development
+## Сборка проекта
+
+Для сборки jar-файла используйте Ant (протестировано на версии 1.10.7):
 
-To build the jar using Ant (tested at version 1.10.7) run:
 
 ```shell
-$ ant build
+ant build
 ```
 
-To run the jar with Bash:
+## CLI запуск
+Запуск EmuLinkerSF в Bash:
 
 ```shell
-$ java -Xms64m -Xmx128m -cp ./conf:./build/emulinker.jar:./lib/commons-collections-3.1.jar:./lib/commons-configuration-1.1.jar:./lib/commons-el.jar:./lib/commons-lang-2.1.jar:./lib/commons-logging.jar:./lib/commons-pool-1.2.jar:./lib/log4j-1.2.12.jar:./lib/nanocontainer-1.0-beta-3.jar:./lib/picocontainer-1.1.jar:./lib/xstream-1.1.2.jar:./lib/commons-codec-1.3.jar:./lib/commons-httpclient-3.0-rc3.jar org.emulinker.kaillera.pico.PicoStarter
+java -Xms64m -Xmx128m -cp ./conf:./build/emulinker.jar:./lib/commons-collections-3.1.jar:./lib/commons-configuration-1.1.jar:./lib/commons-el.jar:./lib/commons-lang-2.1.jar:./lib/commons-logging.jar:./lib/commons-pool-1.2.jar:./lib/log4j-1.2.12.jar:./lib/nanocontainer-1.0-beta-3.jar:./lib/picocontainer-1.1.jar:./lib/xstream-1.1.2.jar:./lib/commons-codec-1.3.jar:./lib/commons-httpclient-3.0-rc3.jar org.emulinker.kaillera.pico.PicoStarter
 ```
+
+## Установка EmuLinker на Linux Debian
+
+Скачиваем пакеты JRE 17 и JDK 17 и git
+
+```shell
+sudo apt update
+sudo apt install openjdk-17-jdk openjdk-17-jre git
+```
+
+Проверяем что java установлена
+
+```
+mayekkuzu@intel-nuc:/home/mayekkuzu$ java -version
+openjdk version "17.0.9" 2023-10-17
+OpenJDK Runtime Environment (build 17.0.9+9-Debian-1deb12u1)
+OpenJDK 64-Bit Server VM (build 17.0.9+9-Debian-1deb12u1, mixed mode, sharing)
+```
+
+Скачиваем скомпилированный пакет и распаковываем в папку /opt
+
+```shell
+wget https://gitea.mayex.net/mayekkuzu/EmuLinkerSF/releases/download/v0.93.2/EmuLinkerSF_v93.2.zip
+unzip EmuLinkerSF_v93.2.zip
+sudo mv EmuLinkerSF /opt
+```
+
+## Первичная настройка
+
+В файле EmuLinkerSF/conf/emulinker.cfg отредактируйте следующие параметры:
+
+```
+ # Порт на котором будут соединяться клиенты эмуляторов
+controllers.connect.port=27888
+
+ # Порт с которого начнется выделение дополнительных портов для игроков.
+controllers.v086.portRangeStart=27889
+
+ # Количество портов которые будут дополнительно выделены. (Например с 10 будет рэндж 27889-27899)
+controllers.v086.extraPorts=10
+
+ # Имя сервера для отображения в мастер-листе
+masterList.serverName=Awesome EmuLinker Server
+
+ # Территориальная локация сервера 
+masterList.serverLocation=Russia
+
+ # Веб-сайт проекта
+masterList.serverWebsite=https://gitea.mayex.net
+
+ # true - листинг на оригинальном kaillera.com мастер-листе.
+masterList.touchKaillera=true
+
+ # true - листинг на оригинальном emulinker.com мастер-листе.
+masterList.touchEmulinker=true
+```
+На дополнительные опции обращайте внимание на описания параметров, возможно потребуется какая-то более точная настройка
+## Запуск как демон systemd
+
+Создайте фаил сервиса emulinker.service в папке /etc/systemd/system/
+```
+$ sudo touch /etc/systemd/system/emulinker.service
+$ sudo vi /etc/systemd/system/emulinker.service
+```
+
+Содержимое файла emulinker.service
+```
+[Unit]
+Description=EmuLinker Script
+
+[Service]
+ExecStart=/opt/EmuLinkerSF/server.sh
+WorkingDirectory=/opt/EmuLinkerSF/%i
+[Install]
+WantedBy=multi-user.target
+```
+
+Далее перезагружаем сервис systemd и запускаем демон emulinker
+```
+sudo systemctl daemon-reload
+sudo systemctl start emulinker.service
+sudo systemctl enable emulinker.service
+sudo systemctl status emulinker.services
+```
+