|
| 1 | +--- |
| 2 | +title: Configuration |
| 3 | +description: Configure Portals behavior, teleportation, and performance settings |
| 4 | +--- |
| 5 | + |
| 6 | +# Configuration |
| 7 | + |
| 8 | +Portals provides configuration options to customize plugin behavior, teleportation mechanics, and performance settings. |
| 9 | + |
| 10 | +## Configuration File Location |
| 11 | + |
| 12 | +The main configuration file is located at: `plugins/Portals/config.json` |
| 13 | +Translation files for customizing messages are located in: `plugins/Portals/translations/` |
| 14 | + |
| 15 | +<Callout type="info"> |
| 16 | + Configuration files are auto-generated with default values on first run. |
| 17 | + New options are automatically added when updating to newer versions. |
| 18 | +</Callout> |
| 19 | + |
| 20 | +## Configuration Options |
| 21 | + |
| 22 | +| Setting | Description | Default | |
| 23 | +|-------------------------|------------------------------------------------------------|---------| |
| 24 | +| `allowCaveSpawns` | Allow random teleports to consider caves as safe locations | `false` | |
| 25 | +| `entryCosts` | Enable or disable portal entry costs globally | `true` | |
| 26 | +| `ignoreEntityMovement` | Prevent non-player entities from interacting with portals | `false` | |
| 27 | +| `pushbackSpeed` | Speed of the pushback effect | `0.3` | |
| 28 | + |
| 29 | +<Callout type="warn"> |
| 30 | + Setting `entryCosts` to `false` will disable **ALL** portal costs, regardless of individual portal settings. |
| 31 | +</Callout> |
| 32 | + |
| 33 | +### Entity Interaction Settings |
| 34 | + |
| 35 | +When enabled, only players can trigger portals. |
| 36 | +Mobs, minecarts, and other entities will not be able to interact with or teleport through portals. |
| 37 | + |
| 38 | +<Callout type="tip"> |
| 39 | + **Performance Optimization**: Enable this option on servers with many entities to improve performance. |
| 40 | + The performance gain depends on the number of entities on your server. |
| 41 | +</Callout> |
| 42 | + |
| 43 | +### Pushback Speed |
| 44 | + |
| 45 | +When an entity is denied portal entry (due to lack of permission, insufficient funds, or active cooldown), this setting controls the pushback behavior. |
| 46 | + |
| 47 | +**Speed Values:** |
| 48 | +- **`0.3`** - Slow pushback (default, recommended) |
| 49 | +- **`0.5`** - Slight pushback |
| 50 | +- **`1.0`** - Relatively fast pushback |
| 51 | +- **Higher values** - Faster pushback |
| 52 | +- **`0` or below** - Disables pushback entirely |
| 53 | + |
| 54 | +<Callout type="warn"> |
| 55 | + Disabling pushback may cause entities to get stuck at portal boundaries. |
| 56 | + It's recommended to use a low value like `0.3` or `0.5` for a better user experience. |
| 57 | +</Callout> |
0 commit comments