0 of 0
About this mod
A new script mod that allows you to teleport to your barn, fertility pasture, and house with just the press of a button.
- Requirements
- Permissions and credits
- Changelogs
Confirmed working with current beta update! (game version 1.9.0.3.0)
This is a LUA script mod originally created by kacypony! I did not make it but reworked and rewrote it as well as added new features so I'm uploading it here.
I didn't run into any serious issues using the mod, but be aware that script mods can be unstable and cause crashes or other issues with your game. If you experience any problems with the mod, please go to the Cozy Bee Games server and report the issue in the Mod Discussions thread.
As always, I or the creator of the original mod cannot take any responsibility for potential crashes or issues with your save file, and by installing mods you acknowledge that you understand and take this risk.
Now, without further ado:
Teleport Mod
a LUA script mod by kacypony
Extended Version with additional features by stahl-tier
Description
This simple mod lets you get around your ranch much more quickly by adding a quick teleport system. By pressing the respective buttons on your keyboard, you can instantly teleport to the following locations on your ranch:
your house (front porch)
fertility pasture
in front of the barn
toggle teleport function off/on. pressing this will disable the teleporter temporarily. pressing it again while the teleporter is disabled will turn it back on. use this if you want to disable the functionality temporarily for any reason
your house, but inside and right next to the bed
retirement pasture
roundpen/paddock (it's the letter 'O', not the number zero!)
next to your currently active horse (if you have any out and aren't already sitting on it)
Test output in the console of your current location
your first custom location (numpad key)
your second custom location (numpad key)
your third custom location (numpad key)
your fourth custom location (numpad key)
set custom location 1
set custom location 2
set custom location 3
set custom location 4
Output in the console of your custom teleport locations, for copying and pasting into the config file
Known Issues
a LUA script mod by kacypony
Extended Version with additional features by stahl-tier
Description
This simple mod lets you get around your ranch much more quickly by adding a quick teleport system. By pressing the respective buttons on your keyboard, you can instantly teleport to the following locations on your ranch:
your house (front porch)
fertility pasture
in front of the barn
toggle teleport function off/on. pressing this will disable the teleporter temporarily. pressing it again while the teleporter is disabled will turn it back on. use this if you want to disable the functionality temporarily for any reason
your house, but inside and right next to the bed
retirement pasture
roundpen/paddock (it's the letter 'O', not the number zero!)
next to your currently active horse (if you have any out and aren't already sitting on it)
Test output in the console of your current location
your first custom location (numpad key)
your second custom location (numpad key)
your third custom location (numpad key)
your fourth custom location (numpad key)
set custom location 1
set custom location 2
set custom location 3
set custom location 4
Output in the console of your custom teleport locations, for copying and pasting into the config file
Known Issues
If something is blocking the destination location of the teleport, for example an NPC or a horse that wandered off, the teleport will "silently" fail. There's nothing I can do about this right now, but I will probably add a notification on the screen if this happens with a future update.
If you try to teleport while you are currently on horseback, your player character will move to the destination but your horse (and the camera) will stay in the same place. This looks funky but doesn't cause any problems as far as I know - simply make sure your horse is standing still (as you remain in control of it) and dismount. The player character will return to the horse's position. Fixed!
If you are currently leading a horse, you will simply be teleported without the horse if it's a destination like the fertility pasture or if there's anything else in the way (a message will appear telling you that your horse "can't follow you there").
The teleport buttons are active when you are entering a horse's name. This is a minor problem but will be fixed in a future version. Fixed!
If you set custom teleport locations in the extended version, you can set them to be on any map and the game will remember this map. However, any map except your ranch and the map you last entered will get unloaded from the game's memory once you enter a different map. So, if you set a custom teleport location on the Crystal Lake trail but then go to the Pine Forest, trying to teleport back to your Crystal Lake location will cause you to fall through the unloaded map. Your ranch is always loaded and you can always teleport there via custom teleports. For this reason, I recommend only using the custom teleports on other maps outside your ranch while you are actually on that map. Fixed! Make sure to only register custom teleport locations on your ranch, as teleporting elsewhere is no longer possible.
Saving Custom Teleport Locations via Config File
The current version of the mod comes with the ability to set and save four custom teleport locations by using the respective numpad keys.
In order to save the custom locations you set, you have to open the file named "config.lua", any local text editor that does not add formatting is fine.
In-game, you have to have the UE4SS GUI console window enabled. If the GUI console does not appear when you start the game after installing UE4SS, make sure that the "UE4SS-settings.ini" file has the following lines set like this:
So instead of the default editable lines of the config, which look like this:
... you should then have the same four lines but with different coordinates. Make sure that nothing except the numbers of the coordinates has changed after overwriting the default lines with your lines from the console.
Now save the config.lua file, make sure that the file extension isn't changed and stays as .lua, otherwise the mod cannot read it.
When you open your game the next time, your custom teleport locations should be preserved.
If you are currently leading a horse, you will simply be teleported without the horse if it's a destination like the fertility pasture or if there's anything else in the way (a message will appear telling you that your horse "can't follow you there").
Saving Custom Teleport Locations via Config File
The current version of the mod comes with the ability to set and save four custom teleport locations by using the respective numpad keys.
In order to save the custom locations you set, you have to open the file named "config.lua", any local text editor that does not add formatting is fine.
In-game, you have to have the UE4SS GUI console window enabled. If the GUI console does not appear when you start the game after installing UE4SS, make sure that the "UE4SS-settings.ini" file has the following lines set like this:
[Debug]
; Whether to enable the external UE4SS debug console.
ConsoleEnabled = 0
GuiConsoleEnabled = 1
GuiConsoleVisible = 1
Once you have the console and the config file open and have set your custom teleport location(s), press CTRL+Y. Now, you should see an output in the console that looks similar to the content of the config file. Copy this and paste it into the config file as described in said file, make sure to overwrite the already existing lines instead of adding new lines.So instead of the default editable lines of the config, which look like this:
customloc1 = { X = -6066.537109375, Y = -2343.4953613281, Z = 393.27520751953 },
customloc2 = { X = -6066.537109375, Y = -2343.4953613281, Z = 393.27520751953 },
customloc3 = { X = -6066.537109375, Y = -2343.4953613281, Z = 393.27520751953 },
customloc4 = { X = -6066.537109375, Y = -2343.4953613281, Z = 393.27520751953 }... you should then have the same four lines but with different coordinates. Make sure that nothing except the numbers of the coordinates has changed after overwriting the default lines with your lines from the console.
Now save the config.lua file, make sure that the file extension isn't changed and stays as .lua, otherwise the mod cannot read it.
When you open your game the next time, your custom teleport locations should be preserved.
Installation Instructions
LUA mods require UE4SS to work! Before you download the mod and install it, please make sure you have the Rivershine Mirror version of UE4SS installed according to the instructions on its page.
Once you have installed UE4SS and confirmed it works properly, download the zip archive from this mod's the Files tab. Choose only one of the two available versions - the "normal" version and the Extended version will conflict with each other if you install both! Only download and install one of them!
You can use free programs like 7zip or winRAR to open the archived zip you downloaded.
1. Go To your Steam Library. Right-Click on TheRanchOfRivershine > Properties > Browse Local Files.
2. From here, go to “TheRanchOfRivershine” > “Binaries” > “Win64” > "Mods".
3. Open the archived zip file of this mod with WinRAR or 7Zip and extract it.
4. It should contain a folder called "TeleportModEXTENDED". Drag this folder into the Mods folder. It should sit right beside the other folders in there like this:
It's important that the contents of the mod's folder get moved together with it. If your "TeleportModEXTENDED" folder is empty, something went wrong. At the very least, it needs to contain a text file called "enabled" and a folder called "scripts". The "scripts" folder contains 4 lua files called "main", "mod", "teleport", and "config" here.
5. Start the game, and once the main menu has loaded in, close the game again. UE4SS has now installed and initialized the mod. (Alternatively you can use the console to restart all mods.)
6. Now you can play normally and use the mod.
LUA mods require UE4SS to work! Before you download the mod and install it, please make sure you have the Rivershine Mirror version of UE4SS installed according to the instructions on its page.
Once you have installed UE4SS and confirmed it works properly, download the zip archive from this mod's the Files tab. Choose only one of the two available versions - the "normal" version and the Extended version will conflict with each other if you install both! Only download and install one of them!
You can use free programs like 7zip or winRAR to open the archived zip you downloaded.
1. Go To your Steam Library. Right-Click on TheRanchOfRivershine > Properties > Browse Local Files.
2. From here, go to “TheRanchOfRivershine” > “Binaries” > “Win64” > "Mods".
3. Open the archived zip file of this mod with WinRAR or 7Zip and extract it.
4. It should contain a folder called "TeleportModEXTENDED". Drag this folder into the Mods folder. It should sit right beside the other folders in there like this:
It's important that the contents of the mod's folder get moved together with it. If your "TeleportModEXTENDED" folder is empty, something went wrong. At the very least, it needs to contain a text file called "enabled" and a folder called "scripts". The "scripts" folder contains 4 lua files called "main", "mod", "teleport", and "config" here.
5. Start the game, and once the main menu has loaded in, close the game again. UE4SS has now installed and initialized the mod. (Alternatively you can use the console to restart all mods.)
6. Now you can play normally and use the mod.
Upgrading to a newer version of the Mod
Just download the new version, unzip it, and copy-paste the entire folder inside it into your Mods folder. If you are asked whether you want to overwrite existing files, confirm this. It means you put it in the right location and that the old version was successfully updated. BE CAREFUL! Your custom teleport locations will be overwritten when you do this. Either make sure you are NOT overwriting the file called "config.lua" or make a backup of it beforehand, and then replace the one from the update with your old one.
Now, open the game and check if the mod works correctly. If it still behaves like before the update, or if you are suddenly getting errors, make sure the console is showing and press this button:
It's located about top middle of the window and will reload all the script mods. It should then work again and correctly, but if you are getting more error messages in the console, restart the game again. If you are STILL getting error messages after that, please let me know in the modding discord thread.
If you do not have the console enabled, simply closing and re-opening the game should have the same effect as pressing the Restart All Mods button.
Just download the new version, unzip it, and copy-paste the entire folder inside it into your Mods folder. If you are asked whether you want to overwrite existing files, confirm this. It means you put it in the right location and that the old version was successfully updated. BE CAREFUL! Your custom teleport locations will be overwritten when you do this. Either make sure you are NOT overwriting the file called "config.lua" or make a backup of it beforehand, and then replace the one from the update with your old one.
Now, open the game and check if the mod works correctly. If it still behaves like before the update, or if you are suddenly getting errors, make sure the console is showing and press this button:
It's located about top middle of the window and will reload all the script mods. It should then work again and correctly, but if you are getting more error messages in the console, restart the game again. If you are STILL getting error messages after that, please let me know in the modding discord thread.
If you do not have the console enabled, simply closing and re-opening the game should have the same effect as pressing the Restart All Mods button.