Orc Follower
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.
Note: This mod requires version 0.71.X of Bonfire
Features
- Recruitment - Converts most Orcs (Excluding Genies and immutable NPCs) 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] Follower autonomy - The new Relax command will allow followers to wander off on their own and perform emotes, foreplay, and even have sex with each other (provided Meios is full.)
- 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 - The easy way for normal 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."
- If you have first finished Bo's portion of the Main quest, then he should now appear by the Mycellium Valley!
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 Scrolls and how to use them. At the end of his explanation, he will give you three scrolls: "OF - Recruit", "OF - Spawn Follower", and "OF - AOE Commands."
"OF - Recruit" will install Orc Follower into the inventories of any Non-OF NPC. This includes Fantasies, Spawned Orcs, Custom NPCs, and Lore NPCs (like Celik, Oriol, and Bolt). For Lore NPCs, this will also replace their default dialogue with follower commands when spoken to.
"OF - Spawn Follower" will spawn a randomly generated orc near the player's vicinity with Orc Follower automatically installed. Commands can be issued either by speaking to them, or using the ring of commands that appears when right-clicking the follower.
"OF - AOE Commands" will start a monologue allowing you to issue commands to all followers within a 12 meter radius.
Recruiting Followers
- Open your inventory and make sure you have "OF - Recruit." If you don't, speak to Xhor as mentioned in the above step.
- Right-click an NPC to make your orc turn his head to face them.
- Right-click the "OF - Recruit" scroll 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: Unless the NPC was specifically created for Orc Follower, the "Dismiss" command will always return the orc back to their original location and restore their dialogue. They must be recruited again to issue more commands to them.
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:
- Tutorial: Custom NPCs - For a detailed explanation on how to create your own NPCs
- Console Commands - For the full list of console commands
Installation
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):
C:\Users\%username%\AppData\LocalLow\Prasetto\Bonfire
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
- OF-API.lua
- OF-BedSpawner.lua
- OF-DialogueChecks.lua
- OF-FollowerPlayer.lua
- OF-LoreNPC.lua
- OF-PlayerControls.lua
- OF-Relax.lua
- OF-SceneSpawn.lua
- In Mods\rawdialogues
- Orc_Follower
- Diag-LoreNPC.ror
- Omen-AOECommands.ror
- Omen-PlayerWarning
- Orc_Follower
Alternatively you can speak to Xhor and select the dialogue option "On Recruiting..." He will place a complete installation of Orc Follower into your Bonfire directory.
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:
batch target @playername;oluainj OrcFollower;targetclear
- 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 Parameters" field.
- OrcLuaScriptFunction - Slightly more complex 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:
| Flag | Value |
|---|---|
| OF-FollowState | Tracks the follower's current state. They can be the below values (Case Sensitive)
|
| OF-RelaxState | Tracks the follower's current activity while RELAXING. The below values are possible:
|
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 or scrolls directly for debugging purposes.
| Command | Description | Usage |
|---|---|---|
| follow | The NPC will follow you around and react to any sex acts you perform. | batch target @playerinterest;oluacf OrcFollower,follow;targetclear |
| waitHere | The NPC will stop and wait at their location | batch target @playerinterest;oluacf OrcFollower,waitHere;targetclear |
| relax | The NPC will do a number of activities on their own: wander a short distance, foreplay with other followers, or perform emotes. | batch target @playerinterest;oluacf OrcFollower,relax;targetclear |
| dismiss | The NPC will warp back to the scene and coordinates from where they were recruited. | batch target @playerinterest;oluacf OrcFollower,dismiss;targetclear |
| sca1Top
|
Spawns a stone bed and starts Doggystyle animation. The bed will be omitted in certain scenes (like the Inn), and when called near Bonfire's default beds (like at Celik's circle.) | batch target @playerinterest;oluacf OrcFollower,sca1Top;targetclear
batch target @playerinterest;oluacf OrcFollower,sca1Bottom;targetclear |
| sca2Top
|
Spawns a stone bed and starts Missionary animation. The bed will be omitted in certain scenes (like the Inn), and when called near Bonfire's default beds (like at Celik's circle.) | batch target @playerinterest;oluacf OrcFollower,sca2Top;targetclear
batch target @playerinterest;oluacf OrcFollower,sca2Bottom;targetclear |
| ssa1Top
|
Starts the standing doggystyle animation. Does not require a bed and can be done anywhere. | batch target @playerinterest;oluacf OrcFollower,ssa1Top;targetclear
batch target @playerinterest;oluacf OrcFollower,ssa1Bottom;targetclear |
| spr1Top
|
Starts the power ride / cowgirl animation. Does not require a bed and can be done anywhere. | batch target @playerinterest;oluacf OrcFollower,spr1Top;targetclear
batch target @playerinterest;oluacf OrcFollower,spr1Bottom;targetclear |
| sco1Give
|
Starts the blowjob animation, either giving to or receiving one from the NPC. | batch target @playerinterest;oluacf OrcFollower,sco1Give;targetclear
batch target @playerinterest;oluacf OrcFollower,sco1Receive;targetclear |
| sc69Start | Start a 69 with the NPC | batch target @playerinterest;oluacf OrcFollower,sc69Start;targetclear |
| openInventory | Open the NPC's inventory | batch target @playerinterest;oluacf OrcFollower,openInventory;targetclear |
| dance | Makes the NPC play a random dance | batch target @playerinterest;oluacf OrcFollower,dance;targetclear |
| spawnBed
|
Spawns or removes a stone bed underneath the follower's feet for sex.
|
batch target @playerinterest;oluacf OrcFollower,spawnBed;targetclear
batch target @playerinterest;oluacf OrcFollower,removeBed;targetclear |
| remove | Uninstalls the OrcFollower script and any associated Data Flags and dismisses the NPC | batch target @playerinterest;oluacf OrcFollower,remove;targetclear |
Patch Notes
Version 2.00 (Requires Bonfire Version 0.71.X)
- Introducing the new “Relax” command! This will allow followers to wander a short distance from the player to act on their own, performing emotes, and even making out and having some fun with their fellow followers! Followers will stay within 30 feet of the player, but will automatically follow you again if you warp elsewhere or leave the scene. Spawned Followers and Lore NPCs have some new lines in response to this. (Many thanks to Hogs for helping with Bo, Durian, and Oriol’s lines)
- Added a “Move To” command to make followers stand at specific spots in the scene.
- Added new commands for the Standing Doggy and Power Ride / Cowgirl animations into the API.
- Followers will be given temporary dialogue protection while cursed, enabling the player to speak to them as normal. However this protection will be lost once followers become full genies, at which point they will ignore orders.
- Streamlined some dialogue options related to sex so it’s easier to update in the future.
- The data flags “OF-IsFollowing” and “OF-Dimissed” flags have been done away with in favor of the new “OF-FollowState” and “OF-RelaxState” flags. Check the wiki or OrcFollower.lua for details.
- Added new dialogue checking conditions to show and hide certain commands when relevant.
- The option to fuse with your followers will be hidden until after completing Bolt’s fusion research.
- Retired Command macros as they are obsolete, replacing them with click choices that will appear when right-clicking a spawned follower.
- Removed startForeplay() from the API as it had become redundant. Use enableClickchoice which just makes use of the oldforeplay command.
- Bolt will now complain using speechbubbles instead of infodialogues when the player has sex around them.
- Added references to the stone beds added since the last version (moon valley, floating island, etc), so OF will no longer try to spawn an extra bed while near them.
Version 1.00
- Initial Release
