Skip to content
This repository has been archived by the owner on Jun 20, 2021. It is now read-only.

ButterscotchV/PatreonPlugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PatreonPlugin

This is a plugin for managing Patreon perks in the game with large customizability

Config Additions

General

Config Option Value Type Default Value Description
patreon_items Dictionary Empty The default items to give to Patreon supporters (Format: Class ID:Item ID,Class ID:Item ID...)
patreon_tag String Empty The default tag to use for Patreon supporters
patreon_tag_colour String default The default tag colour to use for Patreon supporters
patreon_tag_auto_refresh Boolean False If true, the tags will be updated whenever a Patreon supporter's class is set
patreon_auto_reserve Boolean False If true, Patreon supporters will automatically get Reserved Slot entries created
patreon_<Rank Name>_items Dictionary Empty The default items to give to Patreon supporters with the specified rank (Format: Class ID:Item ID,Class ID:Item ID...)
patreon_<Rank Name>_tag String Empty The default tag to use for Patreon supporters with the specified rank
patreon_<Rank Name>_tag_colour String default The default tag colour to use for Patreon supporters with the specified rank
patreon_<Rank Name>_tag_auto_refresh Boolean False If true, the tags will be updated whenever a Patreon supporter with the specified rank's class is set
patreon_<Rank Name>_auto_reserve Boolean False If true, Patreon supporters with the specified rank will automatically get Reserved Slot entries created

Patreon List Config

This config is stored as PatronList.txt in the server's config directory (ex. AppData). The custom configuration file for this is very open in formatting.

The first value of each line is the SteamID, lines without a SteamID as the first value will be parsed, but won't match to any players (therefore are ignored).

For custom values per Patron, the format for tags should be --tag value_without_spaces or --tag "value with spaces"

The available tags for setting custom values of the Patron's tag and items:

  • For items: -i, --items, --customitems
  • For tags: -t, --tag, --customtag, --custom
  • For tag colours: -c, --colour, --color
  • For auto refreshing tags: -a, --auto, --autorefresh
  • For automated Reserved Slots tags: -s, --slot, --reserved, --reservedslot
  • For setting a player's rank: -r, --rank

About

A Smod plugin for rewarding Patreon supporters

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages