varrix/config.conf

## config.conf
### Cortex Configuration ###
# Author - Logan Speck (Wingz/varrix)
# Contact - Twitter: @itswingz | Sponge: wingz
# Libraries - PaginatedLists by mmonkey (https://forums.spongepowered.org/t/paginated-lists-a-library-for-plugin-developers/6964)
# Description - Cortex is a standalone modification viewer, spoofer, tracker, and logger.


### Variable Legend ###
# ${<COLOR/STYLE>} - this allows you to specify any color or style, example: "${RED}Red text!" You can also
#                    use number-codes if you would like using the same format as declaration (-> ${6}Gold text!)
# ${containerId} - displays the id the mod has specified
# ${containerName} - displays the name the mod has specified
# ${containerVersion} - displays the version the mod has specified.
# ${dynamicVersionFormat}
# ${blankChatBox} - displays a completely empty chat box.


### Logger Properties ###
logger {
  ## Level (Source: http://www.slf4j.org/api/org/apache/log4j/Level.html) ##
  # ALL - The ALL has the lowest possible rank and is intended to turn on all logging.
  # DEBUG - The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
  # ERROR - The ERROR level designates error events that might still allow the application to continue running.
  # FATAL - The FATAL level designates very severe error events that will presumably lead the application to abort.
  # INFO - The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
  # OFF - The OFF has the highest possible rank and is intended to turn off logging.
  # TRACE - The TRACE Level designates finer-grained informational events than the DEBUG
  # WARN - The WARN level designates potentially harmful situations.
  level = "ALL"
}


### Plugin Properties ###
properties {

  commands {
    state {
      # /cortex <help,version,about,author>
      cortex = false
      # /cortex -m <check,set,add,remove,help>
      cortexManagement = false
      plugins = true
      mods = true
      components = true
    }

    # false - /mods, /plugins, and /components will display the same thing
    # true - all commands will display specifically what they're named for (components is mixed)
    separate = true
  }
}


### Schemes ###
scheme {

  # Whether or not Cortex should load multiple schemes.
  # If `false` it is only required to use the `scheme.super` node (can remove all others if you want)
  multiScheme = false

  # Whether or not to require the command format of "/mods page <int>" instead of simply "/mods <int>"
  requirePageArgument = false

  ## Super Scheme ##
  # Used when Forge mods and Sponge plugins are displayed together.
  super {
    # The way metadata should be displayed.
    # Supported Types: hover, beside, click (and "holo" planned for the future)
    metadataDisplayType = "hover"

    # Whether or not to display line numbers.
    displayLineNumbers = true

    # How many Minecraft server mods should we display per-page?
    itemsPerPage = 10

    # Color used for line number display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    lineNumberColor = GRAY

    # The char used to format the line numbers.
    lineNumberFormat = '.'

    # Char used as the pagination "type"
    paginationType = '-'

    # Color used for clickable link display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    clickableLinkColor = AQUA

    # Color used for non-clickable link display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    nonClickableLinkColor = RED

    # Color used for page number display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    pageNumberColor = GOLD

    # Color used for pagination display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    paginationColor = DARK_RED

    # Header of EACH page displayed
    header = [
      "${DARK_RED}------------"
      "${WHITE} Sponge Plugins - Page ${currentPage} of ${totalPages} "
      "${DARK_RED}------------"
    ]

    # Footer of EACH page displayed.
    footer = []

    # Pre-page text. Recommended usage: ${blankChatBox}
    prePageText = "${blankChatBox}"

    # This format is defined so the plugin knows how to handle unknown versioning styles (which is anything starting with a letter)
    otherVersionFormat = "${containerVersion}"

    # This format is defined for when we have a version starting with a number.
    numberVersionFormat = "v "

    # This format is defined for when we have no idea what version the mod is.
    unknownVersionFormat = "UNKNOWN"

    # autoVersionFormat is recommended as the variable of choice with displaying versions
    # by default it will handle the version types and adapt to compensate.
    lineFormat = "${GRAY}${containerName}${ITALIC}${BLUE} (${WHITE}$[autoVersionFormat})"
  }


  ## Forge Mods Scheme ##
  # Used when having Forge mods only displayed to you.
  forgeMods {
    # The way metadata should be displayed.
    # Supported Types: hover, beside, click (and "holo" planned for the future)
    metadataDisplayType = "hover"

    # Whether or not to display line numbers.
    displayLineNumbers = true

    # How many mods should we display per-page?
    itemsPerPage = 10

    # Color used for line number display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    lineNumberColor = GRAY

    # The type of line display we should use
    lineNumberType = '.'

    # Char used as the pagination "type"
    paginationType = '-'

    # Color used for clickable link display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    clickableLinkColor = AQUA

    # Color used for non-clickable link display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    nonClickableLinkColor = RED

    # Color used for page number display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    pageNumberColor = GOLD

    # Color used for pagination display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    paginationColor = DARK_RED

    # Header of EACH page displayed
    header = [
      "${DARK_RED}------------"
      "${WHITE} Forge Mods - Page ${currentPage} of ${totalPages} "
      "${DARK_RED}------------"
    ]

    # Footer of EACH page displayed.
    footer = []

    # Pre-page text. Recommended usage: ${blankChatBox}
    prePageText = "${blankChatBox}"

    # This format is defined so the plugin knows how to handle unknown versioning styles (which is anything starting with a letter)
    otherVersionFormat = "${containerVersion}"

    # This format is defined for when we have a version starting with a number.
    numberVersionFormat = "v "

    # This format is defined for when we have no idea what version the mod is.
    unknownVersionFormat = "UNKNOWN"

    # autoVersionFormat is recommended as the variable of choice with displaying versions
    # by default it will handle the version types and adapt to compensate.
    lineFormat = "${GRAY}${containerName}${ITALIC}${BLUE} (${WHITE}$[autoVersionFormat})"
  }


  ## Sponge Plugins Scheme ##
  # Used when having Sponge plugins only displayed to you.
  spongePlugins {
    # The way metadata should be displayed.
    # Supported Types: hover, beside, click (and "holo" planned for the future)
    metadataDisplayType = "hover"

    # Whether or not to display line numbers.
    displayLineNumbers = true

    # How many plugins should we display per-page?
    itemsPerPage = 10

    # Color used for line number display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    lineNumberColor = GRAY

    # The type of line display we should use
    lineNumberType = '.'

    # Char used as the pagination "type"
    paginationType = '-'

    # Color used for clickable link display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    clickableLinkColor = AQUA

    # Color used for non-clickable link display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    nonClickableLinkColor = RED

    # Color used for page number display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    pageNumberColor = GOLD

    # Color used for pagination display.
    # Options: All of the color-codes/color-names, or NONE to not change the text color.
    paginationColor = DARK_RED

    # Header of EACH page displayed
    header = [
      "${DARK_RED}------------"
      "${WHITE} Sponge Plugins - Page ${currentPage} of ${totalPages} "
      "${DARK_RED}------------"
    ]

    # Footer of EACH page displayed.
    footer = []

    # Pre-page text. Recommended usage: ${blankChatBox}
    prePageText = "${blankChatBox}"

    # This format is defined so the plugin knows how to handle unknown versioning styles (which is anything starting with a letter)
    otherVersionFormat = "${containerVersion}"

    # This format is defined for when we have a version starting with a number.
    numberVersionFormat = "v "

    # This format is defined for when we have no idea what version the mod is.
    unknownVersionFormat = "UNKNOWN"

    # autoVersionFormat is recommended as the variable of choice with displaying versions
    # by default it will handle the version types and adapt to compensate.
    lineFormat = "${GRAY}${containerName}${ITALIC}${BLUE} (${WHITE}$[autoVersionFormat})"
  }
}


### Storage Settings ###
storage {
  # Keeps all data in-memory and will not write any changes.
  temporary = false
  # The type of storage to use.
  # Supported Types: MySQL, HOCON
  type = "hocon"

  ## HOCON ##
  hocon {
    # Storage strategy to use with user data.
    # Supported Strategies: simple, separate, scalable
    userDataStorageStrategy = "super"
  }
}


### Database ###
database {
  ## MySQL Database ##
  # More settings to come...
  mySQL {
    url = ""
    user = "user"
    pass = "pass"
  }
}


### Viewing Rules ###
# secret - the mod will be represented with question marks.
# disclosed - the mod will be fully disclosed.
# restricted - the mod will not be shown.


### Permissions Note ###
# Alternatively you could simply use permissions.
# Permissions: all = "cortex.*"
#              specific = "cortex.<mod-id>.<viewing-rule>" (example: "cortex.cortex.restricted")

data {
  ### Universal Data ###
  universal {
    # This mod is restricted from viewing for all players (unless that player has a specified view below that overrides this)
    cortex = "restricted"
  }


  ### IP Data ###
  # This whole node is removable when not using HOCON and not using userDataStorageStrategy "super".
  ips {
    # Randomly generated IP (may be in use)
    217.30.124.171 {
      cortex {
        rule = "secret"

        # Watchdog rules:
        # ALL/* - Any and all changes/queries will be reported.
        # MUTATION - Any changes will be reported.
        # QUERY - Any queries will be reported.

        # An array of Strings that can either be IPs or UUIDs.
        # These elements will each be a pair of "who" (ip/uuid) and "what" (watchdog rules) separated by colones which
        # is then concatenated into a single String separating the "who" and "what" by comma.
        # EXAMPLE: "c0fbf1c17b614fb28d679fa079f0c48e,MUTATION:QUERY"
        watchdog = []
      }
    }
  }


  ### User Data ###
  # This whole node is removable when not using HOCON and not using userDataStorageStrategy "super".
  users {
    c0fbf1c17b614fb28d679fa079f0c48e {
      # Can see cortex as `???` because this overrides the `universal` settings.
      cortex = "secret"
    }

    c3fed4d91c024fb89bf1cb0166aa9104 {
      # Can see cortex properly as this overrides the `universal` settings.
      cortex = "disclosed"
    }
  }
}
	### Cortex Configuration ###
	# Author - Logan Speck (Wingz/varrix)
	# Contact - Twitter: @itswingz \| Sponge: wingz
	# Libraries - PaginatedLists by mmonkey (https://forums.spongepowered.org/t/paginated-lists-a-library-for-plugin-developers/6964)
	# Description - Cortex is a standalone modification viewer, spoofer, tracker, and logger.


	### Variable Legend ###
	# ${<COLOR/STYLE>} - this allows you to specify any color or style, example: "${RED}Red text!" You can also
	# use number-codes if you would like using the same format as declaration (-> ${6}Gold text!)
	# ${containerId} - displays the id the mod has specified
	# ${containerName} - displays the name the mod has specified
	# ${containerVersion} - displays the version the mod has specified.
	# ${dynamicVersionFormat}
	# ${blankChatBox} - displays a completely empty chat box.


	### Logger Properties ###
	logger {
	## Level (Source: http://www.slf4j.org/api/org/apache/log4j/Level.html) ##
	# ALL - The ALL has the lowest possible rank and is intended to turn on all logging.
	# DEBUG - The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
	# ERROR - The ERROR level designates error events that might still allow the application to continue running.
	# FATAL - The FATAL level designates very severe error events that will presumably lead the application to abort.
	# INFO - The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
	# OFF - The OFF has the highest possible rank and is intended to turn off logging.
	# TRACE - The TRACE Level designates finer-grained informational events than the DEBUG
	# WARN - The WARN level designates potentially harmful situations.
	level = "ALL"
	}


	### Plugin Properties ###
	properties {

	commands {
	state {
	# /cortex <help,version,about,author>
	cortex = false
	# /cortex -m <check,set,add,remove,help>
	cortexManagement = false
	plugins = true
	mods = true
	components = true
	}

	# false - /mods, /plugins, and /components will display the same thing
	# true - all commands will display specifically what they're named for (components is mixed)
	separate = true
	}
	}


	### Schemes ###
	scheme {

	# Whether or not Cortex should load multiple schemes.
	# If `false` it is only required to use the `scheme.super` node (can remove all others if you want)
	multiScheme = false

	# Whether or not to require the command format of "/mods page <int>" instead of simply "/mods <int>"
	requirePageArgument = false

	## Super Scheme ##
	# Used when Forge mods and Sponge plugins are displayed together.
	super {
	# The way metadata should be displayed.
	# Supported Types: hover, beside, click (and "holo" planned for the future)
	metadataDisplayType = "hover"

	# Whether or not to display line numbers.
	displayLineNumbers = true

	# How many Minecraft server mods should we display per-page?
	itemsPerPage = 10

	# Color used for line number display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	lineNumberColor = GRAY

	# The char used to format the line numbers.
	lineNumberFormat = '.'

	# Char used as the pagination "type"
	paginationType = '-'

	# Color used for clickable link display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	clickableLinkColor = AQUA

	# Color used for non-clickable link display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	nonClickableLinkColor = RED

	# Color used for page number display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	pageNumberColor = GOLD

	# Color used for pagination display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	paginationColor = DARK_RED

	# Header of EACH page displayed
	header = [
	"${DARK_RED}------------"
	"${WHITE} Sponge Plugins - Page ${currentPage} of ${totalPages} "
	"${DARK_RED}------------"
	]

	# Footer of EACH page displayed.
	footer = []

	# Pre-page text. Recommended usage: ${blankChatBox}
	prePageText = "${blankChatBox}"

	# This format is defined so the plugin knows how to handle unknown versioning styles (which is anything starting with a letter)
	otherVersionFormat = "${containerVersion}"

	# This format is defined for when we have a version starting with a number.
	numberVersionFormat = "v "

	# This format is defined for when we have no idea what version the mod is.
	unknownVersionFormat = "UNKNOWN"

	# autoVersionFormat is recommended as the variable of choice with displaying versions
	# by default it will handle the version types and adapt to compensate.
	lineFormat = "${GRAY}${containerName}${ITALIC}${BLUE} (${WHITE}$[autoVersionFormat})"
	}


	## Forge Mods Scheme ##
	# Used when having Forge mods only displayed to you.
	forgeMods {
	# The way metadata should be displayed.
	# Supported Types: hover, beside, click (and "holo" planned for the future)
	metadataDisplayType = "hover"

	# Whether or not to display line numbers.
	displayLineNumbers = true

	# How many mods should we display per-page?
	itemsPerPage = 10

	# Color used for line number display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	lineNumberColor = GRAY

	# The type of line display we should use
	lineNumberType = '.'

	# Char used as the pagination "type"
	paginationType = '-'

	# Color used for clickable link display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	clickableLinkColor = AQUA

	# Color used for non-clickable link display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	nonClickableLinkColor = RED

	# Color used for page number display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	pageNumberColor = GOLD

	# Color used for pagination display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	paginationColor = DARK_RED

	# Header of EACH page displayed
	header = [
	"${DARK_RED}------------"
	"${WHITE} Forge Mods - Page ${currentPage} of ${totalPages} "
	"${DARK_RED}------------"
	]

	# Footer of EACH page displayed.
	footer = []

	# Pre-page text. Recommended usage: ${blankChatBox}
	prePageText = "${blankChatBox}"

	# This format is defined so the plugin knows how to handle unknown versioning styles (which is anything starting with a letter)
	otherVersionFormat = "${containerVersion}"

	# This format is defined for when we have a version starting with a number.
	numberVersionFormat = "v "

	# This format is defined for when we have no idea what version the mod is.
	unknownVersionFormat = "UNKNOWN"

	# autoVersionFormat is recommended as the variable of choice with displaying versions
	# by default it will handle the version types and adapt to compensate.
	lineFormat = "${GRAY}${containerName}${ITALIC}${BLUE} (${WHITE}$[autoVersionFormat})"
	}


	## Sponge Plugins Scheme ##
	# Used when having Sponge plugins only displayed to you.
	spongePlugins {
	# The way metadata should be displayed.
	# Supported Types: hover, beside, click (and "holo" planned for the future)
	metadataDisplayType = "hover"

	# Whether or not to display line numbers.
	displayLineNumbers = true

	# How many plugins should we display per-page?
	itemsPerPage = 10

	# Color used for line number display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	lineNumberColor = GRAY

	# The type of line display we should use
	lineNumberType = '.'

	# Char used as the pagination "type"
	paginationType = '-'

	# Color used for clickable link display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	clickableLinkColor = AQUA

	# Color used for non-clickable link display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	nonClickableLinkColor = RED

	# Color used for page number display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	pageNumberColor = GOLD

	# Color used for pagination display.
	# Options: All of the color-codes/color-names, or NONE to not change the text color.
	paginationColor = DARK_RED

	# Header of EACH page displayed
	header = [
	"${DARK_RED}------------"
	"${WHITE} Sponge Plugins - Page ${currentPage} of ${totalPages} "
	"${DARK_RED}------------"
	]

	# Footer of EACH page displayed.
	footer = []

	# Pre-page text. Recommended usage: ${blankChatBox}
	prePageText = "${blankChatBox}"

	# This format is defined so the plugin knows how to handle unknown versioning styles (which is anything starting with a letter)
	otherVersionFormat = "${containerVersion}"

	# This format is defined for when we have a version starting with a number.
	numberVersionFormat = "v "

	# This format is defined for when we have no idea what version the mod is.
	unknownVersionFormat = "UNKNOWN"

	# autoVersionFormat is recommended as the variable of choice with displaying versions
	# by default it will handle the version types and adapt to compensate.
	lineFormat = "${GRAY}${containerName}${ITALIC}${BLUE} (${WHITE}$[autoVersionFormat})"
	}
	}


	### Storage Settings ###
	storage {
	# Keeps all data in-memory and will not write any changes.
	temporary = false
	# The type of storage to use.
	# Supported Types: MySQL, HOCON
	type = "hocon"

	## HOCON ##
	hocon {
	# Storage strategy to use with user data.
	# Supported Strategies: simple, separate, scalable
	userDataStorageStrategy = "super"
	}
	}


	### Database ###
	database {
	## MySQL Database ##
	# More settings to come...
	mySQL {
	url = ""
	user = "user"
	pass = "pass"
	}
	}


	### Viewing Rules ###
	# secret - the mod will be represented with question marks.
	# disclosed - the mod will be fully disclosed.
	# restricted - the mod will not be shown.


	### Permissions Note ###
	# Alternatively you could simply use permissions.
	# Permissions: all = "cortex.*"
	# specific = "cortex.<mod-id>.<viewing-rule>" (example: "cortex.cortex.restricted")

	data {
	### Universal Data ###
	universal {
	# This mod is restricted from viewing for all players (unless that player has a specified view below that overrides this)
	cortex = "restricted"
	}


	### IP Data ###
	# This whole node is removable when not using HOCON and not using userDataStorageStrategy "super".
	ips {
	# Randomly generated IP (may be in use)
	217.30.124.171 {
	cortex {
	rule = "secret"

	# Watchdog rules:
	# ALL/* - Any and all changes/queries will be reported.
	# MUTATION - Any changes will be reported.
	# QUERY - Any queries will be reported.

	# An array of Strings that can either be IPs or UUIDs.
	# These elements will each be a pair of "who" (ip/uuid) and "what" (watchdog rules) separated by colones which
	# is then concatenated into a single String separating the "who" and "what" by comma.
	# EXAMPLE: "c0fbf1c17b614fb28d679fa079f0c48e,MUTATION:QUERY"
	watchdog = []
	}
	}
	}


	### User Data ###
	# This whole node is removable when not using HOCON and not using userDataStorageStrategy "super".
	users {
	c0fbf1c17b614fb28d679fa079f0c48e {
	# Can see cortex as `???` because this overrides the `universal` settings.
	cortex = "secret"
	}

	c3fed4d91c024fb89bf1cb0166aa9104 {
	# Can see cortex properly as this overrides the `universal` settings.
	cortex = "disclosed"
	}
	}
	}