odjit-KindredInnkeeper icon

KindredInnkeeper

Assign a territory/clan that is joinable by all and serves as a shared living space.

Last updated 2 weeks ago
Total downloads 61
Total rating 4 
Categories Server Mods 1.0 Update
Dependency string odjit-KindredInnkeeper-1.0.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_V_Rising-1.691.3 icon
BepInEx-BepInExPack_V_Rising

BepInEx pack for V Rising. Preconfigured and includes Unity Base DLLs.

Preferred version: 1.691.3
deca-VampireCommandFramework-0.9.0 icon
deca-VampireCommandFramework

Command framework for developers to easily create universal commands for their plugins.

Preferred version: 0.9.0

README

KindredInnkeeper for V Rising

KindredInnkeeper creates an inn for V Rising, allowing new players to join and get started quickly even with no plots being available. It introduces a structured way to claim temporary housing within a clan-designated inn.

Feel free to reach out to me on Discord (odjit) if you have any questions or need help with the mod.

Details

Setting Up the Inn

To begin, set a clan as the inn by using the .inn create command to assign your current clan. Any clan leader can build normally within the inn. If you have Kindred Logistics installed, it is recommended to designate a spare account as the plot owner to keep all settings off for that plot.

Building the Inn

  1. Foundation: Place a heart and build the inn to your specifications. It is advisable to include rooms with a coffin and at least one chest for storage.

  2. Neutral Research Tables: This is so that players do not share research unlocks without interacting with the particular table. Remember to move the research table via the build menu after spawning it to ensure it connects to the room properly.

  3. Kindred Schematics: Enhance your inn by using KindredSchematics to add decorations and furniture. Also allows for unlocking the territory if needed. Use immortal to stop flowers from being harvested or entities destroyed (barrels, haystacks, etc).

Territory Management

To protect the inn properly:

  • Use dismantleoff and moveoff to protect the territory once completed. (So players cannot move or dismantle the inn building tiles.)
  • Block the relocation of the castle heart.

Room Management

Once your layout is complete, use the .inn addroom command to add rooms to the inn. After a room is added, players can claim it using the .inn claimroom command. Players may leave their room at any time using the .inn leaveroom command.

Gameplay Rules

  • While on the territory, players are immune to sunlight.
  • Players cannot build or change decorations on the plot while in the clan.
  • Players cannot loot chests in another's claimed room.
  • Players can only claim one room at a time.
  • Players cannot join the inn via the join command if they are in a clan or already have a plot.
  • Players cannot open the door to another's claimed room from the hall.
  • Players can leave a room even if it is not theirs.
  • If a player attempts to place a castle heart, they will receive a warning that this action will remove them from the inn. Upon placing the heart, they will be removed, and any items stored in chests will be transferred to their new plot in travel bags.

Known Quirks

  • As base game allows any clan member to invite, someone who owns a plot could be invited to the clan by a member. This does not break the inn, but would cause issues for the invited on their plot. They can leave the clan to fix.
  • If you leave a room as the Plot Owner, you will spawn travel bags with any remaining items at the castle heart.
  • Do not have an inn room touching (minesweeper rules) where the castle heart is. The heart is a little bigger than its square, and it messes with the rooms.

Command List

Staff Commands

  • .inn create
    • Makes your current clan the Inn if one doesn't exist.
  • .inn remove
    • Removes the currently set Inn clan.
  • .inn addroom
    • Adds a room to the inn.
  • .inn removeroom
    • Removes a room from the inn.
  • .inn guests
    • Lists the current guests in the inn.
  • .inn setroomowner (player)
    • Sets the owner of the room to the specified player.
  • .inn roomowner
    • Names the owner of the room you are in.
  • .inn inforeload
    • Reloads the inn info from the config file.
  • .inn dismantleoff
    • stops the dismantling of all tiles on the plot you're on. (will cause lag for a moment)
  • .inn moveoff
    • stops the moving of all tiles on the plot you're on. (will cause lag for a moment)
  • .inn blockrelocate
    • Blocks the relocation of the castle heart of the plot you're on.
  • .inn spawntable (table research tier: 1/2/3)
    • Spawns a neutral research table at the mouse location.

Player Accessible Commands:

  • .inn join
    • Adds the user to the inn clan.
  • .inn info
    • Lists the rules of the inn.
  • .inn quests
    • Completes quests relating to a castle heart.
  • .inn vacancy
    • Lists the current vacancies in the inn.
  • .inn claimroom
    • Claims a room in the inn.
  • .inn leaveroom
    • Removes the user from the room

V Rising Modding Discord | V Rising Modding Wiki

Installation

Steps
  1. Install BepInEx, which is required for modding VRising. Follow the instructions provided at BepInEx Installation Guide to set it up correctly in your VRising game directory.

  2. Download the KindredInnkeeper mod along with its dependencies (VCF). Ensure you select the correct versions that are compatible with your game.

  3. After downloading, locate the .dll files for KindredInnkeeper and its dependencies. Move or copy these .dll files into the BepInEx\Plugins directory within your VRising installation folder.

    • Single Player Note:
      • If you are playing in single player mode, you will need to install ServerLaunchFix. This is a server-side mod that is essential for making the commands work properly on the client side. Make sure to download and place it in the same BepInEx\Plugins directory.
  4. Launch the Game: Start VRising. If everything has been set up correctly, KindredInnkeeper should now be active in the game.

Additional Notes
  • Using Commands: The commands for KindredInnkeeper go into the chat box, not the console. However, players will first need to authenticate themselves in the console chat. You can find instructions on how to do this here.
  • For thorough mod installation instructions and troubleshooting, visit VRising Mod Installation Guide.
  • If you encounter any issues, refer to the V Rising Modding Community discord for tech support.

Credits

License

This project is licensed under the AGPL-3.0 license.