TILER2

SUPPORT DISCLAIMER

Use of a mod manager is STRONGLY RECOMMENDED.

Seriously, use a mod manager.

If the versions of TILER2 (or possibly any other mods) are different between your game and other players' in multiplayer, things WILL break. If TILER2 is causing kicks for "unspecified reason", it's likely due to a mod version mismatch. Ensure that all players in a server, including the host and/or dedicated server, are using the same mod versions before reporting a bug.

While reporting a bug, make sure to post a console log (path/to/RoR2/BepInEx/LogOutput.log) from a run of the game where the bug happened; this often provides important information about why the bug is happening. If the bug is multiplayer-only, please try to include logs from both server and client.

Description

TILER2 is a library mod. It won't do much on its own, but it may be required for some other mods.

User-Facing Features

TILER2 mostly contains features that are useful for mod developers, but it also adds some things that normal users can take advantage of.

DebugUtil

The DebugUtil module adds the console command evo_setitem.

• evo_setitem itemIndexOrName count: Sets the count of the target item in the Artifact of Evolution item pool. Marked as a cheat command.

NetConfig

The NetConfig module automatically syncs important config settings from the server to any connecting clients, and kicks clients with critical config mismatches which can't be resolved (i.e. settings that can't be changed while the game is running, or client has different mods than server).

NetConfig also adds the console commands aic_get, aic_set, aic_settemp, and aic; and the convar bool aic_allowclientset.

• aic_get "path1" "optional path2" "optional path3": Attempts to find a config entry. Path matches, in order: mod name, config section, config key. If you weren't specific enough, it will print all matching paths to console; otherwise, it will print detailed information about one specific config entry.
• aic_set "path1" "optional path2" "optional path3" value: Attempts to permanently set a config entry (writes to config file AND changes the ingame value), following the same search rules as aic_get. Not usable by non-host players; will route to aic_settemp instead.
• aic_settemp "path1" "optional path2" "optional path3" value: Attempts to temporarily set a config entry until the end of the current run, following the same search rules as aic_get. Can be blocked from use by non-host players via aic_allowclientset.
• aic "cmd" ...: Routes to aic_get, aic_set, or aic_settemp (for when you forget the underscore).
• bool aic_allowclientset: If TRUE, any player on a server can use aic_settemp. If FALSE, only the host can use aic_settemp.

Issues/TODO

• Items which players have but were disabled mid-run need a UI indicator for such.
• Items past the 256th in the entire catalog cannot be disabled, and the disabled status will loop around within the second batch of 128 instead. This is a bug in RoR2 itself, which may be fixed soon (ETA v1.0.1.x).
• If a client gets kicked by R2API mod mismatch, NetConfig will attempt kick them again (to no effect) due to timeout.
• See the GitHub repo for more!

Changelog

The 5 latest updates are listed below. For a full changelog, see: https://github.com/ThinkInvis/RoR2-TILER2/blob/master/changelog.md

2.1.0

• FakeInventory should now work properly in multiplayer.
• BREAKING (minor): FakeInventory no longer inherits from Inventory and has had some structural changes. It's no longer a requirement to add items to the sibling inventory in parallel.
• Bumped R2API dependency version to 2.5.11.

2.0.0

• BREAKING: Moved the CloneSkillDef and GlobalUpdateSkillDef methods from MiscUtil to SkillUtil.
• BREAKING: Removed temporary transition patch for a newish R2API feature (ItemBoilerplate --> ItemDropAPI removal).
• Added the FakeInventory and ItemWard components, migrated from Admiral and TinkersSatchel.
• AutoItemConfig now adds a warning to config descriptions if both the DeferForever and PreventNetMismatch flags are set.
• Added the SkillUtil module, incl. several methods for working with SkillFamily variants.
• The NodeOccupationInfo component now works with the OccupyNearbyNodes component.
  • Behavior of OccupyNearbyNodes is changed slightly in the process (multiple objects may now occupy the same node using an OccupyNearbyNodes).
• Switched to publicized RoR2 assembly in favor of a lot of reflection (should increase performance, especially with MiscUtil.RemoveOccupiedNodes).
• Added full documentation for MiscUtil, SkillUtil, StatHooks, NetConfig.
• Bumped R2API dependency version to 2.5.7.

1.5.0

• Updated to accomodate breaking changes in RoR2 1.0 and the new R2API version.

1.4.0

• General refactor/cleanup of main plugin code into module files.
• StatHooks: fixed incorrect order of application of damage modifiers.
• Reworked MiscUtil's NodeGraph tools.
  • The method RemoveOccupiedNodes has been changed internally, but should remain backwards-compatible.
  • The methods RemoveAllOccupiedNodes and UpdateOccupiedNodesReference have been added.
  • The component NodeOccupationInfo has been added. This is automatically added to objects in most ingame cases where nodes are marked as occupied (notable exception: OccupyNearbyNodes component).
• Now uses plugin-specific console logger.

1.3.0

• Added StatHooks module.
• Added Artifact : ItemBoilerplate.
• Migrated some extension methods from ClassicItems (CharacterBody.SetBuffCount).
• GitHub repo is now licensed (GNU GPL3).