breakTime — различия между версиями

Материал из Руководство по OpenKore
Перейти к: навигация, поиск
м (4epT переименовал страницу autoBreakTime в breakTime)
 
Строка 1: Строка 1:
 
== Плагин breakTime ==
 
== Плагин breakTime ==
Этот блочный параметр конфига определяет когда OpenKore следует сделать перерыв. Этот параметр полезен, если нужно автоматически прерывать работу OpenKore на время регулярных профилактических работ на игровом сервере.
+
Этот плагин позволяет настроить автоматическое отключение OpenKore по расписанию. Например, отключение OpenKore на время регулярных профилактических работ на игровом сервере. Настройка плагина осуществляется путём добавления\редактирования в [[:Category:config.txt|config.txt]] блочного параметра: '''autoBreakTime'''. По факту OpenKore выполняет консольную команду [[relog|relog n]], где '''n''' - это разница во времени между stopTime и startTime.
  
В ревизии [http://openkore.svn.sourceforge.net/viewvc/openkore?view=rev&revision=7288 r7288] код, отвечающий за параметр конфига '''autoBreakTime''' вынесен из основного кода OpenKore в соответствующий плагин [https://openkore.svn.sourceforge.net/svnroot/openkore/plugins/breakTime/trunk/breakTime.pl breakTime.pl].
+
'''Примечания:'''
 +
* в режиме [[XKore]] 1 не работает, т.к. OpenKore не умеет перезапускать клиент RO;
 +
* этот плагин можно использовать только в том случае, если длительность перерыва меньше 24х часов;
 +
* американский формат времени - "AM/PM", не поддерживается. Следует использовать 24х часовой формат времени.
 +
* до ревизии [https://sourceforge.net/p/openkore/code/7288/ r7288] этот плагин входил основной код OpenKore, затем его решили вынести в отдельный плагин [https://github.com/OpenKore/openkore/tree/master/plugins/breakTime breakTime.pl].
  
== Правописание ==
+
== Синтаксис ==
  autoBreakTime [{all|mon|tue|wed|thu|fri|sat|sun}] {
+
  autoBreakTime [{ all | mon | tue | wed | thu | fri | sat | sun }] {
 
  startTime <время>
 
  startTime <время>
 
  stopTime [<время>]
 
  stopTime [<время>]
Строка 12: Строка 16:
  
 
== Описание атрибутов ==
 
== Описание атрибутов ==
; autoBreakTime [{all|mon|tue|wed|thu|fri|sat|sun}]
+
; autoBreakTime [{ all | mon | tue | wed | thu | fri | sat | sun }]
: В параметре конфига пишутся дни недели, в которые OpenKore следует делать перерывы.
+
: В названии блока указываются дни недели, в которые OpenKore следует делать перерыв. '''all''' - означает каждый день. В одном конфиге можно указать несколько блоков '''autoBreakTime'''.
 
 
  
 
; startTime <время>
 
; startTime <время>
: Этот атрибут определяет время начала перерыва - т.е. дисконнекта. 24-х часовой формат времени.
+
: Этот атрибут определяет время начала перерыва. В это время OpenKore отключится от сервера. Его следует указать в 24-х часовом формате времени.
 
 
  
 
; stopTime [<время>]
 
; stopTime [<время>]
: Этот атрибут определяет время окончания перерыва - т.е. время коннекта к серверу. 24-х часовой формат времени.
+
: Этот атрибут определяет время окончания перерыва. В это время OpenKore подключится к серверу обратно. Его следует указать в 24-х часовом формате времени.
 
 
  
'''Примечания:'''  
+
; disabled <[[References#булев флаг|булев флаг]]>
* Этот блочный параметр можно использовать только в том случае, если длительность перерыва меньше 24х часов.
+
: Если атрибут disabled '''1''', то блочный параметр будет выключен и не сработает, даже если все условия выполнятся.
* Американский формат времени - "AM/PM", не поддерживается. Поэтому следует использовать 24х часовой формат времени.
 
  
  
 
== Пример ==
 
== Пример ==
* В следующем примере OpenKore будет автоматически дисконнектиться в воскресенье в 21:29, и продолжит работу в понедельник в 01:08 ночи.
+
* В следующем примере OpenKore будет автоматически отключаться в воскресенье в 21:29, и подключаться в понедельник в 01:08 ночью.
  
 
  autoBreakTime sun {
 
  autoBreakTime sun {
Строка 39: Строка 39:
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
[[Category:config.txt]]
 
[[Category:auto disconnect]]
 
[[Category:config block]]
 

Текущая версия на 13:35, 4 мая 2021

Плагин breakTime

Этот плагин позволяет настроить автоматическое отключение OpenKore по расписанию. Например, отключение OpenKore на время регулярных профилактических работ на игровом сервере. Настройка плагина осуществляется путём добавления\редактирования в config.txt блочного параметра: autoBreakTime. По факту OpenKore выполняет консольную команду relog n, где n - это разница во времени между stopTime и startTime.

Примечания:

  • в режиме XKore 1 не работает, т.к. OpenKore не умеет перезапускать клиент RO;
  • этот плагин можно использовать только в том случае, если длительность перерыва меньше 24х часов;
  • американский формат времени - "AM/PM", не поддерживается. Следует использовать 24х часовой формат времени.
  • до ревизии r7288 этот плагин входил основной код OpenKore, затем его решили вынести в отдельный плагин breakTime.pl.

Синтаксис

autoBreakTime [{ all | mon | tue | wed | thu | fri | sat | sun }] {
	startTime <время>
	stopTime [<время>]
	disabled <булев_флаг>
}

Описание атрибутов

autoBreakTime [{ all | mon | tue | wed | thu | fri | sat | sun }]
В названии блока указываются дни недели, в которые OpenKore следует делать перерыв. all - означает каждый день. В одном конфиге можно указать несколько блоков autoBreakTime.
startTime <время>
Этот атрибут определяет время начала перерыва. В это время OpenKore отключится от сервера. Его следует указать в 24-х часовом формате времени.
stopTime [<время>]
Этот атрибут определяет время окончания перерыва. В это время OpenKore подключится к серверу обратно. Его следует указать в 24-х часовом формате времени.
disabled <булев флаг>
Если атрибут disabled 1, то блочный параметр будет выключен и не сработает, даже если все условия выполнятся.


Пример

  • В следующем примере OpenKore будет автоматически отключаться в воскресенье в 21:29, и подключаться в понедельник в 01:08 ночью.
autoBreakTime sun {
	startTime 21:29
	stopTime 01:08
}