Minecraft/slf4bukkit
Archived
0
Fork 0
Code Activity

Update docs with details on colors

Browse Source
This commit is contained in:
Ronald Jack Jenkins Jr
2017-08-08 20:11:05 -04:00
parent ebcf0b6132
commit c2ea354f71
3 changed files with 24 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/github/README.md
View File

@@ -1,5 +1,5 @@
<!--- <!---
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
@@ -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).

3
src/site/markdown/devs.md
View File

@@ -1,4 +1,4 @@
## 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
@@ -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).

6
src/site/markdown/index.md
View File

@@ -1,4 +1,4 @@
## 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
@@ -106,6 +106,10 @@ 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