Skip to content

Commit

Permalink
Update comments for config settings and begin work on README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ArkoSammy12 committed Jul 26, 2024
1 parent 1d77c24 commit 3d990a9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
# Public-Ender-Chest
A Minecraft server-side mod that adds a shared ender chest inventory accessible via an ender chest.
<h1 align="center">
<img src="https://i.imgur.com/SxdRC9A.png">
</h1>


# Public Ender Chest
This server-side, configurable Fabric Minecraft mod adds a new public inventory accessible via Ender Chest blocks.
The mod also includes a built-in logging system for server admins to keep track of changes to this public inventory, and some other useful configuration options.

## Features

### Configuration
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ import xd.arkosammy.monkeyconfig.util.SettingLocation

enum class ConfigSettings(private val builder: ConfigSetting.Builder<*, *, *>) {
ENABLE_PLAYER_BLACKLIST(BooleanSetting.Builder(SettingLocation(SettingGroups.PLAYER_BLACKLIST.groupName, "enable_player_blacklist"), """
Toggle the use of the player blacklist feature.
(Default = false) Toggle the use of the player blacklist feature.
""".trimIndent(), false)),
PLAYER_BLACKLIST(StringListSetting.Builder(SettingLocation(SettingGroups.PLAYER_BLACKLIST.groupName, "player_blacklist"), """
Add players to this blacklist by specifying their username.
""".trimIndent(), mutableListOf())),

ENABLE_DIMENSION_BLACKLIST(BooleanSetting.Builder(SettingLocation(SettingGroups.DIMENSION_BLACKLIST.groupName, "enable_dimension_blacklist"), """
Toggle the use of the dimension blacklist feature.
(Default = false) Toggle the use of the dimension blacklist feature.
""".trimIndent(), false)),
DIMENSION_BLACKLIST(StringListSetting.Builder(SettingLocation(SettingGroups.DIMENSION_BLACKLIST.groupName, "dimension_blacklist"), """
Add dimensions to this blacklist by specifying their full identifier. For example, to add the Overworld dimension, you can add the identifier "minecraft:overworld" to this list.
""".trimIndent(), mutableListOf())),

PURGE_OLDER_THAN_X_DAYS(NumberSetting.Builder(SettingLocation(SettingGroups.DATABASE.groupName, "purge_older_than_x_days"), """
Purge database entries older than the amount of days specified. The database is purged on every server shutdown and using the `/publicenderchest database purge` command.
(Default = 30) Purge database entries older than the amount of days specified. The database is purged on every server shutdown and using the `/publicenderchest database purge` command.
""".trimIndent(), 30).withLowerBound(0));

val settingLocation: SettingLocation = builder.settingLocation
Expand Down

0 comments on commit 3d990a9

Please sign in to comment.