Update docs with details on colors
This commit is contained in:
@@ -1,16 +1,16 @@
|
|||||||
<!---
|
<!---
|
||||||
Copyright (C) 2016 Ronald Jack Jenkins Jr.
|
Copyright (C) 2016-2017 Ronald Jack Jenkins Jr.
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
This program is free software: you can redistribute it and/or modify
|
||||||
it under the terms of the GNU General Public License as published by
|
it under the terms of the GNU General Public License as published by
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
(at your option) any later version.
|
(at your option) any later version.
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
GNU General Public License for more details.
|
GNU General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
||||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
-->
|
-->
|
||||||
@@ -42,3 +42,4 @@ If you wish to use [SLF4J](http://slf4j.org) in your Bukkit plugin, or if your p
|
|||||||
+ SLF4Bukkit issues `ChatColor.RESET` after every log message, so you don't have to worry about resetting after each message.
|
+ SLF4Bukkit issues `ChatColor.RESET` after every log message, so you don't have to worry about resetting after each message.
|
||||||
+ You can use the [ColorString](${project.url}/apidocs/info/ronjenkins/slf4bukkit/ColorString.html) class to easily create colored log messages.
|
+ You can use the [ColorString](${project.url}/apidocs/info/ronjenkins/slf4bukkit/ColorString.html) class to easily create colored log messages.
|
||||||
+ For a consistent user experience, it's recommended that you perform all logging via SLF4Bukkit and not use `Plugin.getLogger()`.
|
+ For a consistent user experience, it's recommended that you perform all logging via SLF4Bukkit and not use `Plugin.getLogger()`.
|
||||||
|
+ Any color-related features are silently stripped/ignored when SLF4Bukkit runs on a Bukkit implementation where JAnsi is not available (e.g. PaperSpigot).
|
||||||
|
|||||||
@@ -1,15 +1,15 @@
|
|||||||
## Copyright (C) 2016 Ronald Jack Jenkins Jr.
|
## Copyright (C) 2016-2017 Ronald Jack Jenkins Jr.
|
||||||
##
|
##
|
||||||
## This program is free software: you can redistribute it and/or modify
|
## This program is free software: you can redistribute it and/or modify
|
||||||
## it under the terms of the GNU General Public License as published by
|
## it under the terms of the GNU General Public License as published by
|
||||||
## the Free Software Foundation, either version 3 of the License, or
|
## the Free Software Foundation, either version 3 of the License, or
|
||||||
## (at your option) any later version.
|
## (at your option) any later version.
|
||||||
##
|
##
|
||||||
## This program is distributed in the hope that it will be useful,
|
## This program is distributed in the hope that it will be useful,
|
||||||
## but WITHOUT ANY WARRANTY; without even the implied warranty of
|
## but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
## GNU General Public License for more details.
|
## GNU General Public License for more details.
|
||||||
##
|
##
|
||||||
## You should have received a copy of the GNU General Public License
|
## You should have received a copy of the GNU General Public License
|
||||||
## along with this program. If not, see <http://www.gnu.org/licenses/>.
|
## along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
#set($h1 = '#')
|
#set($h1 = '#')
|
||||||
@@ -41,3 +41,4 @@ If you wish to use [SLF4J](http://slf4j.org) in your Bukkit plugin, or if your p
|
|||||||
+ SLF4Bukkit issues `ChatColor.RESET` after every log message, so you don't have to worry about resetting after each message.
|
+ SLF4Bukkit issues `ChatColor.RESET` after every log message, so you don't have to worry about resetting after each message.
|
||||||
+ You can use the [ColorString](apidocs/info/ronjenkins/slf4bukkit/ColorString.html) class to easily create colored log messages.
|
+ You can use the [ColorString](apidocs/info/ronjenkins/slf4bukkit/ColorString.html) class to easily create colored log messages.
|
||||||
+ For a consistent user experience, it's recommended that you perform all logging via SLF4Bukkit and not use `Plugin.getLogger()`.
|
+ For a consistent user experience, it's recommended that you perform all logging via SLF4Bukkit and not use `Plugin.getLogger()`.
|
||||||
|
+ Any color-related features are silently stripped/ignored when SLF4Bukkit runs on a Bukkit implementation where JAnsi is not available (e.g. PaperSpigot).
|
||||||
|
|||||||
@@ -1,15 +1,15 @@
|
|||||||
## Copyright (C) 2016 Ronald Jack Jenkins Jr.
|
## Copyright (C) 2016-2017 Ronald Jack Jenkins Jr.
|
||||||
##
|
##
|
||||||
## This program is free software: you can redistribute it and/or modify
|
## This program is free software: you can redistribute it and/or modify
|
||||||
## it under the terms of the GNU General Public License as published by
|
## it under the terms of the GNU General Public License as published by
|
||||||
## the Free Software Foundation, either version 3 of the License, or
|
## the Free Software Foundation, either version 3 of the License, or
|
||||||
## (at your option) any later version.
|
## (at your option) any later version.
|
||||||
##
|
##
|
||||||
## This program is distributed in the hope that it will be useful,
|
## This program is distributed in the hope that it will be useful,
|
||||||
## but WITHOUT ANY WARRANTY; without even the implied warranty of
|
## but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
## GNU General Public License for more details.
|
## GNU General Public License for more details.
|
||||||
##
|
##
|
||||||
## You should have received a copy of the GNU General Public License
|
## You should have received a copy of the GNU General Public License
|
||||||
## along with this program. If not, see <http://www.gnu.org/licenses/>.
|
## along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
#set($h1 = '#')
|
#set($h1 = '#')
|
||||||
@@ -43,19 +43,19 @@ slf4j:
|
|||||||
#
|
#
|
||||||
# If not specified or given an invalid value, defaults to "info".
|
# If not specified or given an invalid value, defaults to "info".
|
||||||
defaultLogLevel: info
|
defaultLogLevel: info
|
||||||
|
|
||||||
# Shows an "[SLF4J]" header for every message logged through SLF4Bukkit.
|
# Shows an "[SLF4J]" header for every message logged through SLF4Bukkit.
|
||||||
#
|
#
|
||||||
# If not specified or given an invalid value, defaults to "false".
|
# If not specified or given an invalid value, defaults to "false".
|
||||||
showHeader: false
|
showHeader: false
|
||||||
|
|
||||||
# Shows the full logger name (e.g. "info.ronjenkins.bukkit.MyPlugin"),
|
# Shows the full logger name (e.g. "info.ronjenkins.bukkit.MyPlugin"),
|
||||||
# wrapped in curly braces.
|
# wrapped in curly braces.
|
||||||
#
|
#
|
||||||
# If not specified or given an invalid value, defaults to "false". If true,
|
# If not specified or given an invalid value, defaults to "false". If true,
|
||||||
# this overrides "slf4j.showShortLogName".
|
# this overrides "slf4j.showShortLogName".
|
||||||
showLogName: false
|
showLogName: false
|
||||||
|
|
||||||
# Shows the short logger name, wrapped in curly braces. The short logger name
|
# Shows the short logger name, wrapped in curly braces. The short logger name
|
||||||
# is the short Java package name format (e.g. a logger named
|
# is the short Java package name format (e.g. a logger named
|
||||||
# "info.ronjenkins.bukkit.MyPlugin" would have a short name of
|
# "info.ronjenkins.bukkit.MyPlugin" would have a short name of
|
||||||
@@ -64,13 +64,13 @@ slf4j:
|
|||||||
# If not specified or given an invalid value, defaults to "true". If
|
# If not specified or given an invalid value, defaults to "true". If
|
||||||
# "slf4j.showLogName" is true, this option is ignored.
|
# "slf4j.showLogName" is true, this option is ignored.
|
||||||
showShortLogName: true
|
showShortLogName: true
|
||||||
|
|
||||||
# Shows the name of the logging thread, wrapped in brackets. You probably
|
# Shows the name of the logging thread, wrapped in brackets. You probably
|
||||||
# don't want this information unless you're helping troubleshoot a plugin.
|
# don't want this information unless you're helping troubleshoot a plugin.
|
||||||
#
|
#
|
||||||
# If not specified or given an invalid value, defaults to "false".
|
# If not specified or given an invalid value, defaults to "false".
|
||||||
showThreadName: false
|
showThreadName: false
|
||||||
|
|
||||||
# This section controls default colors for logging levels. Each entry in this
|
# This section controls default colors for logging levels. Each entry in this
|
||||||
# section maps one of SLF4J's logging levels to one of SLF4Bukkit's
|
# section maps one of SLF4J's logging levels to one of SLF4Bukkit's
|
||||||
# ColorMarker values. The possible keys (levels) in this section are the
|
# ColorMarker values. The possible keys (levels) in this section are the
|
||||||
@@ -106,16 +106,20 @@ slf4j:
|
|||||||
# YELLOW
|
# YELLOW
|
||||||
# WHITE
|
# WHITE
|
||||||
# NONE (default console color)
|
# NONE (default console color)
|
||||||
|
#
|
||||||
|
# If you are running this plugin on a Bukkit implementation that does not
|
||||||
|
# include the JAnsi library (e.g. PaperSpigot), none of these configuration
|
||||||
|
# values will be honored and all log output will have no colors.
|
||||||
colors:
|
colors:
|
||||||
error: RED
|
error: RED
|
||||||
warn: YELLOW
|
warn: YELLOW
|
||||||
info: NONE
|
info: NONE
|
||||||
debug: NONE
|
debug: NONE
|
||||||
trace: NONE
|
trace: NONE
|
||||||
|
|
||||||
# This section controls logging levels for individual loggers.
|
# This section controls logging levels for individual loggers.
|
||||||
log:
|
log:
|
||||||
|
|
||||||
# For each element in this section, the key is the full logger name and the
|
# For each element in this section, the key is the full logger name and the
|
||||||
# value is the logging level for that logger. Possible logging levels are
|
# value is the logging level for that logger. Possible logging levels are
|
||||||
# the same as what's available for the "slf4j.defaultLogLevel" property
|
# the same as what's available for the "slf4j.defaultLogLevel" property
|
||||||
|
|||||||
Reference in New Issue
Block a user