Welcome to BorisLib!

This is a Library for most of my heavier Server-Sided Fabric Mods

This library has a few key features:

• Polymer-based Graphical Items for server-sided GUIs
• A robust framework for generating paged and configurable server-sided GUIs
• A built-in powerful mod config / properties file manager
• A system for storing mod data on Players, Worlds or Globally, with easy offline access
• A 'Conditions' system that acts like potion effects with the granularity and stackability of entity attributes
• A game-event system for keeping track of specific player actions
• A timer and login callback system for events that take place after a certain amount of time, or when a player returns to the server.
• A server-based velocity tracker for estimating the player's movement vectors without specialized packets
• A library of modular, pre-made, geometric and animated particle effects
• A whole bunch of useful utility methods for various mathematical operations, data structures, algorithms, text and sounds.

Texture Pack

The server has the ability to automatically generate and serve the mod's texture pack to your players when they connect. To do this, you must enable auto-host. This is super easy to do in a few steps:

1. Launch the server with the mod installed at least once to generate the configs
2. Go into the 'config' folder of the server, there should be a folder called 'polymer', and inside that there should be a file called 'auto-host.json'
3. In 'auto-host.json', in the first few lines there will be a line that says "enabled": false, change this to true.
4. (Optional) You can also set the value to make the resource pack required by players, or set the "message" line to inform players why the resource pack is important to download when they are prompted to have it be auto downloaded.

If everything is done correctly, then players will automatically load into the server with the resource pack installed.

Try My Other Mods!

All server-side Fabric mods — no client installation required.

| | Mod | Description | Links |
|:--------------------------------------------------------------------------------------------------------------:|--------------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| | Arcana Novum | Minecraft's biggest server-only full-feature Magic Mod! Adds powerful items, multiblocks and bosses! | |
| | Ancestral Archetypes | A highly configurable, Origins-style mod that lets players pick a mob to gain unique abilities! | |
| | Ender Nexus | Highly configurable /home, /spawn, /warp, /tpa and /rtp commands all in one, and individually disablable. | |
| | Fabric Mail | An in-game virtual mailbox system for sending packages and messages between online and offline players. | |
| | Fabric Trade | Adds /trade, a secure player-to-player trading interface. | |
| | Limited AFK | AFK detection and management with configurable kick thresholds for servers. | |
| | Links in Chat | Makes URLs posted in chat clickable. | |

Permission Nodes

BorisLib uses the Fabric Permissions API for command permissions. Each node has a fallback vanilla permission level for servers without a permissions mod.

General

| Node | Default | Description |
|------|---------|-------------|
| borislib.borislib | ALL | Access the /borislib base command (shows version) |
| borislib.reload | GAMEMASTERS | Reload the BorisLib config file |

Config

Config commands are generated dynamically per config value. The <modid> and <name> below depend on the mod using the library.

| Node | Default | Description |
|------|---------|-------------|
| <modid>.config | GAMEMASTERS | List all config values |
| <modid>.config.<name>.get | GAMEMASTERS | Read a specific config value |
| <modid>.config.<name>.set | GAMEMASTERS | Change a specific config value |

Player Data

| Node | Default | Description |
|------|---------|-------------|
| borislib.player | GAMEMASTERS | View stored player data via /borislib player <player> |

Conditions

| Node | Default | Description |
|------|---------|-------------|
| borislib.condition | GAMEMASTERS | Access the /borislib condition subcommand tree |
| borislib.condition.add | GAMEMASTERS | Add a condition instance to an entity |
| borislib.condition.remove | GAMEMASTERS | Remove a specific condition instance from an entity |
| borislib.condition.clear | GAMEMASTERS | Clear all instances of a condition type from an entity |
| borislib.condition.get | GAMEMASTERS | Get the prevailing value of a condition on an entity |
| borislib.condition.getinstance | GAMEMASTERS | Get details of a specific condition instance by ID |
| borislib.condition.getbase | GAMEMASTERS | Get the base (default) value of a condition type |
| borislib.condition.getinstances | GAMEMASTERS | List all instances of a condition type on an entity |

Testmod (requires testmodFeaturesEnabled config option)

| Node | Default | Description |
|------|---------|-------------|
| borislib.testmod | GAMEMASTERS | Access the /borislib testmod subcommand tree |
| borislib.testmod.worldcallback | GAMEMASTERS | Schedule a repeating world-tick timer callback |
| borislib.testmod.servercallback | GAMEMASTERS | Schedule a repeating server-tick timer callback |
| borislib.testmod.pagedgui | GAMEMASTERS | Open a test paged GUI |
| borislib.testmod.particlestress | GAMEMASTERS | Run a particle stress test (~10k particles/tick) |
| borislib.testmod.returnitem | GAMEMASTERS | Test the item return timer/login callback system |
| borislib.testmod.energybar | GAMEMASTERS | Display a test energy bar in the action bar |
| borislib.testmod.marker | GAMEMASTERS | Access world marker subcommands |
| borislib.testmod.marker.place | GAMEMASTERS | Place a named world marker at your position |
| borislib.testmod.marker.remove | GAMEMASTERS | Remove a named world marker |
| borislib.testmod.marker.list | GAMEMASTERS | List all world markers across dimensions |
| borislib.testmod.timestamp | GAMEMASTERS | Access global timestamp subcommands |
| borislib.testmod.timestamp.mark | GAMEMASTERS | Set the global timestamp to the current time |
| borislib.testmod.timestamp.read | GAMEMASTERS | Read the stored global timestamp |

Translation Credits:

• Russian - Reset1712