Note: This mod requires Bonfire 0.47.2 or greater.
The purpose of this mod is to create a custom "Follower System", like what you'd see in Skyrim. While its primary focus is to provide a way for mod makers to create recruitable NPCs that will follow the player around, it's also possible, and easy to use this mod to recruit the Lore NPC's such as Celik and to bring them with you all over the Outback!
This wiki will cover instructions on how to use the mod for both casual users and NPC makers.
Features
Converts most Orcs into Skyrim-like followers that accept orders like "Follow," "Wait Here," and Dismiss."
Portal travel - If you travel through a portal to a different scene, your followers will travel with you! Take Oriol to the inn, Aintzira to Outback, or get Bolt to the beach! (Note: certain scenes like the Sandbox will forbid portal travel)
Sex anywhere - Your followers will automatically spawn a bed when you attempt to have sex with them, so you're no longer confined to the stone circles.
Followers respond to player actions - Your followers will jump when you jump, fap when you fap, or start sex with each other when you get busy with another orc! Bring your entourage to the Bath House for an orgy!
New Dialogue for Lore NPCs - Recruiting lore NPCs like Celik will temporarily change their speech. This will get restored when the player selects "Dismiss," and the can resume their story quest.
Custom API - For NPC makers, this includes a custom API that will allow them to convert their Custom NPCs into recruitable characters. See the "NPC Makers" section below
New NPC - Xhor, an orc mercenary has been added to the Outback to show players how to recruit followers and give them commands. He can be found next to the Mycelium Valley.
Command Macros - Quickly issue different follower commands with the included set of macro without having to speak to the NPC first.
How to use - For regular players
Installation
In Bonfire's main menu, click "Mods," then click "NPC Manager" and you will see the list of NPCs you currently have installed.
Click the "Refresh" button to retrieve the list of orcs from the Orc Repositiory,
Look for an orc named "Xhor" and then click "Summon" to download him.
Finally, click the box by Xhor's name to make a white X mark, and then click "Done."
He should now appear by the Mycellium Valley! Speaking to him will extract the rest of the mods' files.
Obtaining Follower commands
Speak to Xhor. After going through his introduction, speak to him again to show his follower menu.
Click "Extras," then click "On Recruiting"
Xhor will explain about Command Macros and how to use them. At the end of his explanation, he will give you a macro scroll called "OrcFollowerCommands"
Right-clicking "OrcFollowerCommands" will install the the rest of the macros.
You are now ready to command your followers! (if you accidentally delete any of the macros, selecting the same option will give you another set.)
Commanding Followers
Open your inventory and make sure you have "Follower Command - Recruit." (This one is super important)
Right-click an NPC to make your orc turn his head to face them.
Right-click the "Follower Command - Recruit" macro to make your orc cast it. If everything is working correctly, the NPC should immediately start following you around.
You will now be able to use other commands on your follower!
Note: You MUST recruit a Lore NPC first in order to use commands on them. Selecting "Dismiss" on a Lore NPC will uninstall the mod from that orc and restore their vanilla dialogue, which means you will have to recruit them again.
Note II: Lore NPCs' vanilla dialogue will get replaced with Follower-related dialogue once you've recruited them, so commands can be issued by speaking to them directly.
Note III: Use the AOE Commands macro to issue commands in a 12 meter radius, rather than speaking/commanding orcs one at a time.
How to use - For NPC Makers
This section assumes you already know the basics of creating an NPC, how to use Custom Actions in dialogue, and how to use Console Commands. If you don't know how to do any of that, then visit the below pages:
First, download the OrcFollower.zip file from either the Bonfire Discord server, or Bonfire orc repository (Located under the "Mod Packs" folder), and extract its contents to the Metadata files directory directory. On Windows, the location is below (You can copy and paste this address in Window Explorer's URL bar):
The zip folder's file structure mimics the metadata file's directory, so everything should be in place already. You should see the following files and folders
In Mods\lua:
OrcFollower.lua
Orc_Follower
In Mods\rawdialogues
OrcFollowerCommands.ror
Orc_Follower
How to create a custom Follower
Start Bonfire and either load one of your profiles, or create a brand new orc.
Open the console with the F1 key, and enter this command:
You will immediately be prompted with a warning message that Orc Follower has been installed on the player. Since we want to turn this orc into a follower, click:
"I meant to do this"
Save the game
Move your orc to their desired spawning location and use the below command to get their coordinates:
batch target @playername;refpos;targetclear
Open the NPC editor by pressing the ESC key to bring up Bonfire's main menu, then click Mods -> NPC Editor.
Import your Orc by clicking the "Import Character" button, and locate the orc we just installed the Orc Follower mod onto. Next under the "LOCATION" settings, click "Paste from Console" to enter the coordinates you saved with the refpos command.
Save your NPC and click the exit button. Next open the NPC Manager and check in the box to enable your NPC to spawn in the Outback. Finally, swap to a different character.
Your NPC is now ready to receive follower commands! You're free to make any necessary changes to the character afterward, even change their spawn scene! (Just make sure that they still have the mod installed if you need to re-import them for any reason)
Commanding your custom follower
Now, to actually control your follower using the Dialogue System's "Custom Actions," you have two options:
Custom Call - This is the simplest option. Just Copy and Paste the full command(s) from the API Section and paste them into the "String Parameter's" field.
OrcLuaScriptFunction - Slightly more complete and a bit more typing. Make sure you fill in the fields as follow:
Field
Value
Script id:
OrcFollower
Script Function:
commandName (follow, waitHere, dismiss, etc.)
...or instead apply to:
@playerinterest (or the NPC's name)
Important Data Flags
This mod relies on two important Data Flags to determine the follower's state. Their values can either be 1 for "True" or 0 for "False.
Flag
Value
OF-IsFollowing
Checks if the NPC is currently following the player around, and is used for various other checks.
OF-Dismissed
Checks if the NPC is on "Standby" IE: They have been dismissed, but the orc still contains the Orc Follower mod in their inventory.
Orc Follower API (for NPC Makers)
This is the full list of Orc Follower commands that you can give your NPCs. You will mainly copy and paste these into the CustomCall Action of your NPC's dialogue, or you can paste them into the command console directly for debugging purposes.
