Difference between revisions of "Configuration"

From The Twilight Forest Wiki
Jump to navigation Jump to search
m (Reverted edits by 99.233.164.90 (talk) to last revision by 74.192.115.92)
Tag: Rollback
m (Reverted edits by 171.4.248.187 (talk) to last revision by 201.219.233.167)
Tag: Rollback
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
The Configuration file is used to alter the behavior of the Twilight Forest mod. This can be found by navigating to the Mod Options menu, finding the Twilight Forest mod in the menu and selecting the Config button. Alternatively, one can find the config file under the name <code>twilightforest.cfg</code> in the main Minecraft directory. The following options can be found in this file.
The Configuration file is used to alter the behavior of the Twilight Forest mod. This can be found by navigating to the Mod Options menu, finding the Twilight Forest mod in the menu and selecting the Config button. Alternatively, one can find the config file using the command <code>/config showfile twilightforest</code> followed by either client or common. The following options can be found in this file.


==Admin-Only Twilight Portals==
=Common Configurations=
This config option alters the behavior of portal creation. When it is enabled, the portal can only be created by players that are Admins, or have administration permissions. It also affects where portals will be created. By default, the portal will search a 32 block radius from the player's current co-ordinates, but with this option enabled, it is reduced down to only a 4 block radius. Anyone can still use these portals, as this config option only changes who can create a portal.
Found in <code>twilightforest-common.toml</code>, these configurations can completely change the way that the Twilight Forest can be played.


By default, this option is '''disabled'''.
==General Settings==
These are some generalized configuration settings. These settings will not drastically change the gameplay of Twilight Forest, but they can greatly help with various issues.


==Antibuilder Blacklist==
===Skull Candles===
This config option alters how the [[Anti-builder]] functions. Depending on what is input, the Anti-builder will not destroy if it is placed within its range. This config option is useful for those that utilise mods that place a block in the world, like gravestone mods.
The config option <code>disableSkullCandleCreation</code> will determine if the ability to make [[Skull Candle]]s by right clicking a vanilla mob's skull with a candle is allowed. Turn this on if you're having mod conflict issues for some reason.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


By default, there are two entries already added: Bedrock, and Tomb Many Graves's Grave Blocks. More blocks can be added by using the mod id, followed by the block name, for example: <code>twilightforest:firefly_jar</code>. If the mod id is not present, it will assume it is a vanilla block.
----


==Compatibility==
===Enchantment Effects===
This config determines whether mod compatibility is used or not. If it is enabled, other mods such as [[Tinkers' Construct Integration | Tinkers' Construct]] or [[Thaumcraft Integration | Thaumcraft]] will work together with the Twilight Forest mod.
The config option <code>showEnchantmentsOnItems</code> will determine if items that come enchanted when you craft them (such as [[Ironwood Armor|Ironwood]] or [[Steeleaf Armor|Steeleaf]]) should appear as enchanted way in the creative inventory. Please note that this does not affect the crafting recipes themselves, you will need a datapack to change those.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


By default, this option is '''enabled'''.
----
===Boss Loot Chests===
The config option <code>bossesSpawnDropChests</code> will determine if the Twilight Forest's bosses will put their drops inside of a chest where they originally spawned instead of dropping the loot directly on death. Note that the Knight Phantoms are not affected by this as their drops work differently than other bosses.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


==Dimension Settings==
----
Dimension Settings is a collection of config options that will alter the behaviour of the Twilight Forest dimension.
===Precipitation Distance===
The config option <code>cloudBlockPrecipitationDistance</code> will determine how many blocks down from a cloud block should the game logic check for handling weather related code. Lower if experiencing low tick rate. Set to 0 to turn all cloud precipitation logic off. See below: [[Configuration#Cloud_Precipitation|Cloud Precipitation]]
<p style="text-indent: 25px;"> By default, this is set to <code>32</code> </p>


===Dimension ID===
==Multiplayer Settings==
This config option changes the Dimension ID used for the Twilight Forest. In an instance where another dimension is using the already defined ID in the config, it can be changed to prevent an ID conflict. One must be warned, however, that changing the config ID will effectively reset the dimension. If you want the already existing setup of the dimension, you will need to take the contents of the old dimension file into the new one once it is created. Another note of warning, if the ID is changed to an ID that was once used for another dimension, the chunks that already exist in that dimension file will still persist, unless the file is reset.
These are tweaks to better adjust the Twilight Forest for multiplayer servers.


By default, the ID is '''7'''.
===Boss Adjustments=== <!--Needs better indentation on "MORE_LOOT"-->
The config option <code>multiplayerFightAdjuster</code> will determine how bosses should adjust to multiplayer fights. There are 4 possible values that can be put here:
<br>[[File:Steeleaf.png|link=|64px]]<code>"NONE"</code>: Doesn't change anything when multiple people participate in a boss fight. Bosses will act the same as they do in singleplayer or solo fights.
<br>[[File:Steeleaf.png|link=|16px]]<code>"MORE_LOOT"</code>: Supplies additional drops to the boss loot table based on how many players participated in the fight. These are fully controlled through the entity's loot table, using the <code>twilightforest:multiplayer_multiplier</code> loot function. Note that this function will only do things to entities that are included in the <code>twilightforest:multiplayer_inclusive_entities</code> tag.
<br>[[File:Steeleaf.png|link=|16px]]<code>"MORE_HEALTH"</code>: Increases the maximum health of each boss by 35 hearts for each player nearby when the fight starts.
<br>[[File:Steeleaf.png|link=|16px]]<code>"MORE_LOOT_AND_HEALTH"</code>: Does both of the above functions for each boss.


''The game must be reset so that the changes can be set in place.''
<p style="text-indent: 25px;"> By default, this is set to <code>"NONE"</code> </p>


===New Players Spawn in Twilight Forest===
----
This config option determines whether the player spawns in the Twilight Forest when a world is created, or a new player joins the server. If enabled, a portal will be made near where the player spawned. Note that survival in this dimension alone is possible, albeit some vanilla features such as the End or Nether cannot be accessed via the Twilight Forest.


By default, this option is '''disabled'''.
===Keepsake Casket Locking===
The config option <code>casketUUIDLocking </code> will determine if Keepsake Caskets that are placed when a player dies should be inaccessible by other players than the player who died. Use this if you don't want people taking from other people's death caskets. NOTE: Server operators will still be able to open locked caskets.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


===Skylight Forest===
==Dimension Settings==
This config option determines how the Twilight Forest will generate. If enabled, the Twilight Forest will generate akin to a Sky Block world, with the structures still generating on elevated platforms of Stone, Dirt, and Gravel, with the occasional Ores. One must note however, that this config option is not saved per world, so if the option is changed (such as being enabled when it was created disabled), chunk generation will become distorted, with sudden cutoffs.
Settings for the Twilight Forest dimension itself can be found here. These purely affect player spawning.


By default, this option is '''disabled'''.
===Spawning Dimension===
The config option <code>newPlayersSpawnInTF</code> will determine if newly joining players should spawn in the Twilight Forest, opposed to spawning in the Overworld.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


''This config option is currently Work-in-Progress. It may be changed over time.''
----
===Spawn Portal===
The config option <code>portalForNewPlayer</code> will determine if a return portal should generate for newly joining players when <code>newPlayersSpawnInTF</code> is <code>true</code>.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


===Dimension Seed===
==Magic Tree Settings==
This config option can be used to set what seed is used to generate the Twilight Forest. By default, the Twilight Forest will generate based on the seed used on what the world was set to. However, with this config option, it is possible to override the seed being used with what is set here. One must note that changing the seed on an existing world may lead to unintended consequences.
Configuration settings regarding the Magic Tree Cores can be found here. All values can range between 0 and 128, where 0 completely disables the core's function.


By default, this option is blank, meaning that the seed is taken from the world save.
===Timewood Clock===
The config option <code>timeCoreRange</code> will determine the radius at which the [[Timewood Clock]] works.
<p style="text-indent: 25px;"> By default, this is set to <code>16</code>, making it a 33 by 33 range. </p>


==Disable Twilight Portals==
----
This config options restricts portal creation in general. If enabled, no portal to the Twilight Forest can be created, even if the player is a server admin or has cheats enabled. Though it sounds counter-intuitive to prevent creating a portal to a dimension, it can be used to prevent griefing or set it to only have a single portal in the world.
===Heart of Transformation===
The config option <code>transformationCoreRange</code> will determine the radius at which the [[Heart of Transformation]] works.
<p style="text-indent: 25px;"> By default, this is set to <code>16</code>, making it a 33 by 33 range. </p>


By default, this option is '''disabled'''.
----
===Minewood Core===
The config option <code>miningCoreRange</code> will determine the radius at which the [[Minewood Core]] works.
<p style="text-indent: 25px;"> By default, this is set to <code>16</code>, making it a 33 by 33 range. </p>


==Disable Uncrafting in Uncrafting Table==
----
This config option determines whether the Uncrafting Table can, well, Uncraft. Due to the nature of some crafting recipes, Uncrafting can result in exploits, such as obtaining rare materials more efficiently or bypassing restrictions set on modpacks. As a result, this option can be enabled to completely disable this feature, leaving only Repairing and Recrafting left. Of course, you can still Craft with it.
===Sortingwood Engine===
The config option <code>sortingCoreRange</code> will determine the radius at which the [[Sortingwood Engine]] works.
<p style="text-indent: 25px;"> By default, this is set to <code>16</code>, making it a 33 by 33 range. </p>


By default, this option is '''disabled'''.
==Uncrafting Table Settings==
All configuration settings for the [[Uncrafting Table]] can be found here.


==Loading Screen==
===Uncrafting XP Cost===
Loading Screen is a collection of config options that alter the behavior of the loading screen when teleporting to or from the Twilight Forest.
The config option <code>uncraftingXpCostMultiplier</code> will determine the total XP cost of uncrafting an item and rounds up. Higher values means the recipe will cost more to uncraft, lower means less. Set to 0 to disable the cost altogether. Note that this only affects reversed crafting recipes, uncrafting recipes will still use the same cost as they normally would.
<p style="text-indent: 25px;"> By default, this is set to <code>1.0</code> </p>


===Loading Screen Switching===
----
This config option determines how long in ticks it will take to change between a different loading screen appearance. If set to 0, it will not cycle through the backgrounds or item/block in the corner. The higher the number is set, the more ticks it will take to cycle through the appearances (20 ticks = 1 second).
===Repairing XP Cost===
The config option <code>repairingXpCostMultiplier</code> will the total XP cost of repairing an item and will round it up to it's nearest value. Higher values means the recipe will cost more to repair, lower means less.
<p style="text-indent: 25px;"> By default, this is set to <code>1.0</code> </p>


By default, this option is set to '''0''', meaning it will not cycle.
----
===Recipe Blacklist===
The config option <code>disableUncraftingRecipes</code> will determine the recipes that should be removed. To add a recipe, add the mod id followed by the name of the recipe, such as <code>"twilightforest:firefly_particle_spawner"</code>. If an item has multiple crafting recipes and you wish to disable them all, add the item to the <code>"twilightforest:banned_uncraftables"</code> tag. If you have a problematic ingredient, add the item to the <code>"twilightforest:banned_uncrafting_ingredients"</code> tag.
<p style="text-indent: 25px;"> By default, this is set to <code>["twilightforest:giant_log_to_oak_planks"]</code> </p>


===Enable Loading Icon Animation===
----
This config option alters the animation of the loading icon in the corner of the screen. It is currently not observed to lower performance if enabled. However, if by chance it does, it can be disabled, leaving it static in the corner of the screen.
===Recipe Whitelist===
The config option <code>flipRecipeList</code> will invert the above recipe list from a blacklist to a whitelist.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


By default, this option is ''enabled''.
----
===Mod Blacklist===
The config option <code>blacklistedUncraftingModIds</code> will determine which mods should have their items disabled from being uncrafted. Input a valid mod ID to disable all uncrafting recipes from that mod, such as "twilightforest" will disable all uncrafting recipes from this mod.
<p style="text-indent: 25px;"> By default, this is set to <code>[]</code> </p>


===Icon Animation Speed===
----
This config option determines how fast the animation is overall. It determines how fast it wobbles from side to side, and how frequent it bounces.
===Mod Whitelist===
The config option <code>flipIdList</code> will invert the above mod item list from a blacklist to a whitelist.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


By default, the value is set to '''5.0'''.
----
===Shapeless Uncrafting===
The config option <code>enableShapelessCrafting</code> will determine if the Uncrafting Table should be allowed to uncraft shapeless recipes. The Uncrafting Table was originally intended to only take shaped recipes, but this option remains for people who wish to keep the functionality.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


''If '''Enable Loading Icon Animation''' is '''disabled''', this option will not have any effect.''
----
===loadingIconStacks===
===Recipe Switching===
This config is a list of items that will display in the corner of the screen.
The config option <code>disableIngredientSwitching</code> will determine if the uncrafting table should be allowed to switch between ingredients if a recipe uses a specific tag for crafting. This will remove the functionality for '''all recipes'''! If you want to prevent certain ingredients from showing up in the first place, use the <code>twilightforest:banned_uncrafting_ingredients</code> tag.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


By default, the following are already added:
----
* Experiment 115
===Disable Uncrafting Feature===
* Magic Map
The config option <code>disableUncrafting</code> will disables the uncrafting function of the uncrafting table. Recommended as a last resort if there's too many things to change about its behavior (or you're just lazy, we don't judge). Do note that some special uncrafting recipes are not disabled as the mod relies on them for other things.
* Charm of Life II
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>
* Charm of Keeping III
* Phantom Helm
* Lamp of Cinders
* Carminite
* Block and Chain
* Yeti Horned Helm
* Hydra Chop
* Magic Beans
* Raw Ironwood Materials
* Naga Scale
* Thinking Experiment 115
* Miniature Portal
* Miniature Naga Courtyard
* Block of Knightmetal
* Ghast Trap
* Tree of Time Sapling
* Tree of Transformation Sapling
* Miner's Tree Sapling
* Sorting Tree Sapling
* Rainbow Oak Sapling
* Borer Essence
More blocks and items can be added by using the mod id, followed by the block name, for example: <code>twilightforest:firefly_jar</code>. If the mod id is not present, it will assume it is a vanilla block or item.


===Icon Scaling===
----
This config option determines the size of the icon in the corner of the screen. The icons can be made bigger or smaller, and is a useful config option for those playing on smaller screens.
===Disable Uncrafting Table===
The config option <code>disableUncraftingTable</code> will completely disable any usage of the uncrafting table, as well as prevents it from showing up in loot or crafted. Please note that table has more uses than just uncrafting, you can read about them [[Uncrafting Table|here]]! It is highly recommended to keep the table enabled as the mod has special uncrafting exclusive recipes, but the option remains for people that don't want the table to be functional at all. If you are looking to just prevent normal crafting recipes from being reversed, consider using <code>disableUncrafting</code> instead.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


By default, the value is set to '''3.0'''.
==Portal Settings==
All settings and tweaks regarding the Twilight Forest Portal can be found here:


===Icon Bounciness===
===Origin Dimension===
This config option determines how bouncy the icon is. The higher the value is, the more "springy" the icon is. It does not determine how many times it will bounce.
The config option <code>originDimension</code> will determine the dimension you can always travel to the Twilight Forest from, as well as the dimension you will return to when coming back from the Twilight Forest.
<p style="text-indent: 25px;"> By default, this is set to <code>"minecraft:overworld"</code> </p>


By default, the value is set to '''5.25'''.
----
===Additional Dimension Acesss===
The config option <code>allowPortalsInOtherDimensions</code> allow portals to the Twilight Forest to be made outside of the "origin" dimension listed above. It is important to note that this config does ''not'' change your dimension from the origin when blindly teleporting out of the Twilight Forest.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


''If '''Enable Loading Icon Animation''' is '''disabled''', this option will not have any effect.''
----
===Admin Portal Creation===
The config option <code>portalCreationPermission</code> will allow ''only'' players with the specified permission value or higher to create portals. This is based off of [https://minecraft.wiki/w/Permission_level Vanilla's Permission System].
<p style="text-indent: 25px;"> By default, this is set to <code>0</code> </p>


===Icon Tilt Offset===
----
This config option determines where on the icon the wobble will display. Lower values push the point lower, while higher values raise the point upwards. It may also affect how intense the wobble and tilt can be.
===Disable Portal Creation===
The config option <code>disablePortalCreation</code> will completely disable the creation of Twilight Forest portals entirely, making the dimension restricted to only server operators.  
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


By default, the value is set to '''22.5'''
----
===Portal Generation Safeguard===
The config option <code>checkPortalPlacement</code> determines if newly created portals should be pre-checked for safety from locations that aren't aligned with the player's progression. If this setting is false, portals will fail to form rather than redirect to a safe alternate destination. Note that disabling this also reduces the rate at which portal formation checks are performed.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


''If '''Enable Loading Icon Animation''' is '''disabled''', this option will not have any effect.''
----
===Lightning Fire===
The config option <code>destructivePortalLightning</code>, when set to false, will disable fire from generating from the lightning strike. This is purely for those who don't like fun.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


===Icon Wobbliness===
----
This config option determines how far the icon will sway from side to side. Higher values rotate the icon more on the axis.
===One Way Portal===
The config option <code>shouldReturnPortalBeUsable</code> determines if a return portal should require the activation item, or if it should be automatically activated, similar to the functionality of a Nether Portal.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


By default, the value is set to '''11.25'''.
----
===Advancement Activation===
The config option <code>portalUnlockedByAdvancement</code> uses an advancement to allow activation of the portal. For example, using the string "minecraft:story/mine_diamond" will lock the portal behind the "Diamonds!" advancement. Invalid/Empty Advancements will leave the portal unlocked.
<p style="text-indent: 25px;"> By default, this is set to <code>""</code> </p>


''If '''Enable Loading Icon Animation''' is '''disabled''', this option will not have any effect.''
----
===Maximum Portal Size===
The config option <code>maxPortalSize</code> determines the max amount of water spaces the mod will check for when creating a portal. Very high numbers may cause performance issues, while the minimum number is 4.
<p style="text-indent: 25px;"> By default, this is set to <code>64</code> </p>


==Performance Tweaks==
==Shield Parrying==
Performance Tweaks is a collection of config options that alter certain generation options that may improve overall performance of the Twilight Forest.
Shield Parrying is a set of config options that allow for parrying projectiles added in the Twilight Forest. It will deflect a projectile back at the target at the same speed and velocity it had. If the mod [https://curseforge.com/minecraft/mc-mods/parry Shield Parry] is installed, all config options listed will have no effect.  
 
===Canopy Coverage===
This config options determines how many Canopy Trees can generate. The lower the number, the less there needs to generate, but also fewer trees will generate.
 
By default, the value is set to around '''1.7'''.
 
===Glaciers made of Packed Ice instead of Ice===
This config option determines what the Glacier will be made of. By enabling it, less transparency and lighting checks are required due to using opaque blocks.
 
By default, this option is '''disabled'''.
 
===Twilight Leaves opacity===
This config option determines how much light is allowed through leaves in the Twilight Forest. It can be used to decrease the amount of lighting checks required.
 
By default, the value is set to '''1'''.
 
===Twilight Oak Chance===
This config option determines the chance of a Giant Oak Tree generating. Due to the complexity of generating a Giant Oak Tree, reducing the chances can help reduce chunk loading. Higher values decrease the chance of a Giant Oak Tree from generating.


By default, this value is set to '''48'''.
===Parry Non-Twilight Projectiles===
The config option <code>parryNonTwilightAttacks</code> determines if other projectiles from vanilla or other mods can be deflected.
<p style="text-indent: 25px;"> By default, this is set to <code>disabled</code> </p>


==Portal Creation Item==
----
This config option determines what can be used to activate the Twilight Portal. It can also accept multiple activation items, in the event that the item required to enter or exit the Twilight Forest is unavailable in the dimension.
===Parry Opportunity===
The config option <code>shieldParryTicksArrow</code> determines the amount of ticks (1/20th of a second) where it is possible to parry a projectile.
<p style="text-indent: 25px;"> By default, this is set to <code>40</code> </p>


By default, a Diamond can be used to create a portal. More blocks and items can be added by using the mod id, followed by the block name, for example: <code>twilightforest:firefly_jar</code>. If the mod id is not present, it will assume it is a vanilla block or item. Metadata can also be added to the item or block by using <code>twilightforest:tower_device:2</code>. Metadata can also be set to -1 to wildcard the item.
=Client Configurations=
 
Found in <code>twilightforest-client.toml</code>, these are configurations that act as a performance and appearance adjustments, allowing for more customization and performance for those on a lower-end computer
==Portal Creation Lightning Fire==
This config option determines whether the lightning that strikes can also set fire to nearby blocks. Lightning is known to set a struck block on fire, and with a portal made of plants, it can burn away some artistic portal creations. By enabling this option, the lightning will not cause a fire.
 
By default, this option is '''disabled'''.
 
==Portals in other dimensions==
This config option determines if the portal can be created in dimensions that are not the Twilight Forest or Overworld. For an example, it can be possible to create a portal in the End to travel to the Twilight Forest. However, this option may be seen as an exploit in some circumstances, such as simplifying a survival pack where the player is trapped in a dimension with little to no resources.
 
By default, this option is '''disabled'''.
 
==Rotate Trophy Heads on Item model==
This config option determines if the Trophy Heads in the item inventory is allowed to spin. It is currently not observed to cause any performace impacts, but in the event it does, disabling it may fix it.
 
By default, this option is '''enabled'''.
 
==Shield Parrying==
Shield Parrying is a set of config options that allow for parrying projectiles added in the Twilight Forest. It will deflect a projectile back at the target at the same speed and velocity it had. If the mod [https://minecraft.curseforge.com/projects/parry?gameCategorySlug=mc-mods&projectID=293702 Shield Parry] is installed, all config options listed will have no effect.


===Parry non-Twilight projectiles===
===Silent Cicadas===
This config option determines if other projectiles from vanilla or other mods can be deflected. It is recommended that the Shield Parry mod be installed to parry other projectiles, as this config option may lead to unintended consequences.
The config option <code>silentCicadas</code> determines if Cicadas make any noises. In the event the sound events for Cicadas are not working properly, either by corruption or missing file, or the sounds are too annoying to bear, they can be silenced.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


By default, this option is '''disabled'''.
----
===Silent Head Cicadas===
The config option <code>silentCicadasOnHead</code> determines if Cicadas make any noises when sitting on your head. If the config option <code>silentCicadas</code> is set to true, this option will not have any effect.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


===Timing Windowspan for Arrows===
----
This config option determines how long after raising a shield an Arrow is allowed to be parried. This option uses ticks to determine the time it can take to parry Arrows (20 ticks = 1 second).
===First-Person Effects===
The config option <code>firstPersonEffects</code> determines whether various effects from the mod are rendered while in first-person view. If the effects are too distracting, it is recommended to turn this off.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


By default, the value is set to '''40'''.
----
===Trophy Rotation===
The config option <code>rotateTrophyHeadsGui</code> determines trophies heads will rotate on the item model. This option has no performance impact, but can still be disabled for those who do not like fun.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


===shieldParryTicksBeam===
----
This config option is not clear on what can be parried, but it can be assumed it is Beams. This option uses ticks to determine the time it can take to parry Beams (20 ticks = 1 second).
===Charm Animations===
The config option <code>totemCharmAnimation</code> determines if the [[Charm of Keeping]] and [[Charm of Life]] display similarly to the Totem of Undying when used.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


By default, the value is set to '''10'''.
----
===Cloud Precipitation===
The config option <code>cloudBlockPrecipitationDistance</code> determines how far away precipitation should be rendered when going through clouds. Leave this value to -1 to be synced with the common config, or set it to 0 to disable the cloud percipitation entirely.
<p style="text-indent: 25px;"> By default, this is set to <code>-1</code> </p>


===Timing Windowspan for Fireballs===
----
This config option determines how long after raising a shield a Fireball is allowed to be parried. This option uses ticks to determine the time it can take to parry Fireballs (20 ticks = 1 second).
===Giant Skins===
The config option <code>giantSkinUUIDs</code> determines what skin(s) [[Giant]]s should have. If left blank, it will default to the player's skin.
<p style="text-indent: 25px;"> By default, this is set to <code>[]</code> </p>


By default, the value is set to '''40'''.
----
===Aurora Shader===
The config option <code>auroraBiomes</code> determines which biomes the Aurora Shader should be applied. Remove all text and leave <code>[]</code> if you wish to disable the shader completely.
<p style="text-indent: 25px;"> By default, this is set to <code>["twilightforest:glacier"]</code> </p>


===Timing Windowspan for Throwables===
----
This config option determines how long after raising a shield a Throwable is allowed to be parried. This option uses ticks to determine the time it can take to parry Throwables (20 ticks = 1 second).
===Ore Meter Interface===
The config option <code>prettifyOreMeterGui</code> determines if the dashes and percentages in the [[Ore Meter]] GUI should line up properly.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


By default, the value is set to '''40'''.
----
===Questing Ram Indicator===
The config option <code>questRamWoolIndicator</code> determines if a render should exist that shows a little check mark or x above your crosshair, depending on if fed the [[Questing Ram]] a specific color of wool.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


==Should Portals generate as a two-way portal==
----
This config option determines how portals function. If disabled, the portal between dimensions will be protected by a magical barrier that makes teleporting impossible. To open it up again, an activation item is required.
===Fortification Indication===
The config option <code>fortificationShieldIndicator</code> determines if a render should exist that shows how many fortification shields are currently active on your player, above the armor bar. Disable this option if you find it intrusive, or other mods render over or under it.
<p style="text-indent: 25px;"> By default, this is set to <code>true</code> </p>


By default, this option is '''enabled'''.
----
===Biome Toasts===
The config option <code>disableLockedBiomeToasts</code> determines if toasts should appear when travelling into a locked biome. Not recommended if one is not familiar with the [[progression]].
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


==Silent Cicadas==
----
This config option determines if Cicadas make any noises. In the event the sound events for Cicadas are not working properly, either by corruption or missing file, or the sounds are too annoying to bear, they can be silenced.
===Optifine===
The config option <code>disableOptifineNagScreen</code> determines if the Optifine warning screen should be disabled, if it is installed. It is highly recommended to use a replacement for Optifine.
<p style="text-indent: 25px;"> By default, this is set to <code>false</code> </p>


By default, this option is '''disabled'''.
=History=
<!--Add this eventually please-->


{{ModInfo}}
{{ModInfo}}

Latest revision as of 06:30, 19 November 2024

The Configuration file is used to alter the behavior of the Twilight Forest mod. This can be found by navigating to the Mod Options menu, finding the Twilight Forest mod in the menu and selecting the Config button. Alternatively, one can find the config file using the command /config showfile twilightforest followed by either client or common. The following options can be found in this file.

Common Configurations[edit]

Found in twilightforest-common.toml, these configurations can completely change the way that the Twilight Forest can be played.

General Settings[edit]

These are some generalized configuration settings. These settings will not drastically change the gameplay of Twilight Forest, but they can greatly help with various issues.

Skull Candles[edit]

The config option disableSkullCandleCreation will determine if the ability to make Skull Candles by right clicking a vanilla mob's skull with a candle is allowed. Turn this on if you're having mod conflict issues for some reason.

By default, this is set to false

Enchantment Effects[edit]

The config option showEnchantmentsOnItems will determine if items that come enchanted when you craft them (such as Ironwood or Steeleaf) should appear as enchanted way in the creative inventory. Please note that this does not affect the crafting recipes themselves, you will need a datapack to change those.

By default, this is set to true

Boss Loot Chests[edit]

The config option bossesSpawnDropChests will determine if the Twilight Forest's bosses will put their drops inside of a chest where they originally spawned instead of dropping the loot directly on death. Note that the Knight Phantoms are not affected by this as their drops work differently than other bosses.

By default, this is set to true

Precipitation Distance[edit]

The config option cloudBlockPrecipitationDistance will determine how many blocks down from a cloud block should the game logic check for handling weather related code. Lower if experiencing low tick rate. Set to 0 to turn all cloud precipitation logic off. See below: Cloud Precipitation

By default, this is set to 32

Multiplayer Settings[edit]

These are tweaks to better adjust the Twilight Forest for multiplayer servers.

Boss Adjustments[edit]

The config option multiplayerFightAdjuster will determine how bosses should adjust to multiplayer fights. There are 4 possible values that can be put here:
Steeleaf.png"NONE": Doesn't change anything when multiple people participate in a boss fight. Bosses will act the same as they do in singleplayer or solo fights.
Steeleaf.png"MORE_LOOT": Supplies additional drops to the boss loot table based on how many players participated in the fight. These are fully controlled through the entity's loot table, using the twilightforest:multiplayer_multiplier loot function. Note that this function will only do things to entities that are included in the twilightforest:multiplayer_inclusive_entities tag.
Steeleaf.png"MORE_HEALTH": Increases the maximum health of each boss by 35 hearts for each player nearby when the fight starts.
Steeleaf.png"MORE_LOOT_AND_HEALTH": Does both of the above functions for each boss.

By default, this is set to "NONE"

Keepsake Casket Locking[edit]

The config option casketUUIDLocking will determine if Keepsake Caskets that are placed when a player dies should be inaccessible by other players than the player who died. Use this if you don't want people taking from other people's death caskets. NOTE: Server operators will still be able to open locked caskets.

By default, this is set to false

Dimension Settings[edit]

Settings for the Twilight Forest dimension itself can be found here. These purely affect player spawning.

Spawning Dimension[edit]

The config option newPlayersSpawnInTF will determine if newly joining players should spawn in the Twilight Forest, opposed to spawning in the Overworld.

By default, this is set to false

Spawn Portal[edit]

The config option portalForNewPlayer will determine if a return portal should generate for newly joining players when newPlayersSpawnInTF is true.

By default, this is set to false

Magic Tree Settings[edit]

Configuration settings regarding the Magic Tree Cores can be found here. All values can range between 0 and 128, where 0 completely disables the core's function.

Timewood Clock[edit]

The config option timeCoreRange will determine the radius at which the Timewood Clock works.

By default, this is set to 16, making it a 33 by 33 range.

Heart of Transformation[edit]

The config option transformationCoreRange will determine the radius at which the Heart of Transformation works.

By default, this is set to 16, making it a 33 by 33 range.

Minewood Core[edit]

The config option miningCoreRange will determine the radius at which the Minewood Core works.

By default, this is set to 16, making it a 33 by 33 range.

Sortingwood Engine[edit]

The config option sortingCoreRange will determine the radius at which the Sortingwood Engine works.

By default, this is set to 16, making it a 33 by 33 range.

Uncrafting Table Settings[edit]

All configuration settings for the Uncrafting Table can be found here.

Uncrafting XP Cost[edit]

The config option uncraftingXpCostMultiplier will determine the total XP cost of uncrafting an item and rounds up. Higher values means the recipe will cost more to uncraft, lower means less. Set to 0 to disable the cost altogether. Note that this only affects reversed crafting recipes, uncrafting recipes will still use the same cost as they normally would.

By default, this is set to 1.0

Repairing XP Cost[edit]

The config option repairingXpCostMultiplier will the total XP cost of repairing an item and will round it up to it's nearest value. Higher values means the recipe will cost more to repair, lower means less.

By default, this is set to 1.0

Recipe Blacklist[edit]

The config option disableUncraftingRecipes will determine the recipes that should be removed. To add a recipe, add the mod id followed by the name of the recipe, such as "twilightforest:firefly_particle_spawner". If an item has multiple crafting recipes and you wish to disable them all, add the item to the "twilightforest:banned_uncraftables" tag. If you have a problematic ingredient, add the item to the "twilightforest:banned_uncrafting_ingredients" tag.

By default, this is set to ["twilightforest:giant_log_to_oak_planks"]

Recipe Whitelist[edit]

The config option flipRecipeList will invert the above recipe list from a blacklist to a whitelist.

By default, this is set to false

Mod Blacklist[edit]

The config option blacklistedUncraftingModIds will determine which mods should have their items disabled from being uncrafted. Input a valid mod ID to disable all uncrafting recipes from that mod, such as "twilightforest" will disable all uncrafting recipes from this mod.

By default, this is set to []

Mod Whitelist[edit]

The config option flipIdList will invert the above mod item list from a blacklist to a whitelist.

By default, this is set to false

Shapeless Uncrafting[edit]

The config option enableShapelessCrafting will determine if the Uncrafting Table should be allowed to uncraft shapeless recipes. The Uncrafting Table was originally intended to only take shaped recipes, but this option remains for people who wish to keep the functionality.

By default, this is set to false

Recipe Switching[edit]

The config option disableIngredientSwitching will determine if the uncrafting table should be allowed to switch between ingredients if a recipe uses a specific tag for crafting. This will remove the functionality for all recipes! If you want to prevent certain ingredients from showing up in the first place, use the twilightforest:banned_uncrafting_ingredients tag.

By default, this is set to false

Disable Uncrafting Feature[edit]

The config option disableUncrafting will disables the uncrafting function of the uncrafting table. Recommended as a last resort if there's too many things to change about its behavior (or you're just lazy, we don't judge). Do note that some special uncrafting recipes are not disabled as the mod relies on them for other things.

By default, this is set to false

Disable Uncrafting Table[edit]

The config option disableUncraftingTable will completely disable any usage of the uncrafting table, as well as prevents it from showing up in loot or crafted. Please note that table has more uses than just uncrafting, you can read about them here! It is highly recommended to keep the table enabled as the mod has special uncrafting exclusive recipes, but the option remains for people that don't want the table to be functional at all. If you are looking to just prevent normal crafting recipes from being reversed, consider using disableUncrafting instead.

By default, this is set to false

Portal Settings[edit]

All settings and tweaks regarding the Twilight Forest Portal can be found here:

Origin Dimension[edit]

The config option originDimension will determine the dimension you can always travel to the Twilight Forest from, as well as the dimension you will return to when coming back from the Twilight Forest.

By default, this is set to "minecraft:overworld"

Additional Dimension Acesss[edit]

The config option allowPortalsInOtherDimensions allow portals to the Twilight Forest to be made outside of the "origin" dimension listed above. It is important to note that this config does not change your dimension from the origin when blindly teleporting out of the Twilight Forest.

By default, this is set to false

Admin Portal Creation[edit]

The config option portalCreationPermission will allow only players with the specified permission value or higher to create portals. This is based off of Vanilla's Permission System.

By default, this is set to 0

Disable Portal Creation[edit]

The config option disablePortalCreation will completely disable the creation of Twilight Forest portals entirely, making the dimension restricted to only server operators.

By default, this is set to false

Portal Generation Safeguard[edit]

The config option checkPortalPlacement determines if newly created portals should be pre-checked for safety from locations that aren't aligned with the player's progression. If this setting is false, portals will fail to form rather than redirect to a safe alternate destination. Note that disabling this also reduces the rate at which portal formation checks are performed.

By default, this is set to true

Lightning Fire[edit]

The config option destructivePortalLightning, when set to false, will disable fire from generating from the lightning strike. This is purely for those who don't like fun.

By default, this is set to true

One Way Portal[edit]

The config option shouldReturnPortalBeUsable determines if a return portal should require the activation item, or if it should be automatically activated, similar to the functionality of a Nether Portal.

By default, this is set to true

Advancement Activation[edit]

The config option portalUnlockedByAdvancement uses an advancement to allow activation of the portal. For example, using the string "minecraft:story/mine_diamond" will lock the portal behind the "Diamonds!" advancement. Invalid/Empty Advancements will leave the portal unlocked.

By default, this is set to ""

Maximum Portal Size[edit]

The config option maxPortalSize determines the max amount of water spaces the mod will check for when creating a portal. Very high numbers may cause performance issues, while the minimum number is 4.

By default, this is set to 64

Shield Parrying[edit]

Shield Parrying is a set of config options that allow for parrying projectiles added in the Twilight Forest. It will deflect a projectile back at the target at the same speed and velocity it had. If the mod Shield Parry is installed, all config options listed will have no effect.

Parry Non-Twilight Projectiles[edit]

The config option parryNonTwilightAttacks determines if other projectiles from vanilla or other mods can be deflected.

By default, this is set to disabled

Parry Opportunity[edit]

The config option shieldParryTicksArrow determines the amount of ticks (1/20th of a second) where it is possible to parry a projectile.

By default, this is set to 40

Client Configurations[edit]

Found in twilightforest-client.toml, these are configurations that act as a performance and appearance adjustments, allowing for more customization and performance for those on a lower-end computer

Silent Cicadas[edit]

The config option silentCicadas determines if Cicadas make any noises. In the event the sound events for Cicadas are not working properly, either by corruption or missing file, or the sounds are too annoying to bear, they can be silenced.

By default, this is set to false

Silent Head Cicadas[edit]

The config option silentCicadasOnHead determines if Cicadas make any noises when sitting on your head. If the config option silentCicadas is set to true, this option will not have any effect.

By default, this is set to false

First-Person Effects[edit]

The config option firstPersonEffects determines whether various effects from the mod are rendered while in first-person view. If the effects are too distracting, it is recommended to turn this off.

By default, this is set to true

Trophy Rotation[edit]

The config option rotateTrophyHeadsGui determines trophies heads will rotate on the item model. This option has no performance impact, but can still be disabled for those who do not like fun.

By default, this is set to true

Charm Animations[edit]

The config option totemCharmAnimation determines if the Charm of Keeping and Charm of Life display similarly to the Totem of Undying when used.

By default, this is set to false

Cloud Precipitation[edit]

The config option cloudBlockPrecipitationDistance determines how far away precipitation should be rendered when going through clouds. Leave this value to -1 to be synced with the common config, or set it to 0 to disable the cloud percipitation entirely.

By default, this is set to -1

Giant Skins[edit]

The config option giantSkinUUIDs determines what skin(s) Giants should have. If left blank, it will default to the player's skin.

By default, this is set to []

Aurora Shader[edit]

The config option auroraBiomes determines which biomes the Aurora Shader should be applied. Remove all text and leave [] if you wish to disable the shader completely.

By default, this is set to ["twilightforest:glacier"]

Ore Meter Interface[edit]

The config option prettifyOreMeterGui determines if the dashes and percentages in the Ore Meter GUI should line up properly.

By default, this is set to true

Questing Ram Indicator[edit]

The config option questRamWoolIndicator determines if a render should exist that shows a little check mark or x above your crosshair, depending on if fed the Questing Ram a specific color of wool.

By default, this is set to true

Fortification Indication[edit]

The config option fortificationShieldIndicator determines if a render should exist that shows how many fortification shields are currently active on your player, above the armor bar. Disable this option if you find it intrusive, or other mods render over or under it.

By default, this is set to true

Biome Toasts[edit]

The config option disableLockedBiomeToasts determines if toasts should appear when travelling into a locked biome. Not recommended if one is not familiar with the progression.

By default, this is set to false

Optifine[edit]

The config option disableOptifineNagScreen determines if the Optifine warning screen should be disabled, if it is installed. It is highly recommended to use a replacement for Optifine.

By default, this is set to false

History[edit]

The Twilight Forest Mod
Change Logs Change Log • Versions 3.x.x • Versions 2.x.x • Versions 1.x.x • April Fools 2022
Mod Info Advancements • Blocks • Configuration • Commands • Data • Enchantments • FAQ • Guide • Installation Instructions • Items • Locations • Mobs • Progression • Statistics
Addon Content Immersive Engineering Integration • Thaumcraft Integration • Tinkers' Construct Integration
Retrieved from "http://benimatic.com/tfwiki/index.php?title=Configuration&oldid=73208"