Skip to content

Documentation

Installation Instructions

v1.0.6

How to install and configure cs-stories (FiveM Stories) and hook it into your phone.

Requiresyarn in your resources folder.
FirewallTCP port 35540 inbound, by default.

Download the resource

  • Make sure you have yarn in your resources folder.
  • Download cs-stories and place it in your resources folder.

Ensure the resource

Add ensure cs-stories to your server’s configuration file before ensuring your phone.

Hook your phone’s resource

Edit your phone’s fxmanifest.lua file and add the following at the end of of the file:

fxmanifest.lua
client_script '@cs-stories/client/hooks/core.lua'
server_script '@cs-stories/server/hooks/core.lua'

Hook your phone’s NUI

Edit your phone’s NUI file (usually index.html) and add the following right before the </body> tag:

<script type="text/javascript" src="nui://cs-stories/client/hooks/core.js"></script>

Configure

Check the config.lua file inside cs-stories for further configuration. Read through all options and their comments and adjust them to your setup and preferences.

Setup your server’s firewall

Open the required port (by default 35540; incoming / inbound) in your firewall, on TCP protocol.

Start the resource

Run the following commands on the server console:

FiveM Server Console
refresh
ensure cs-stories

Fix your phone’s animation loop

If your phone uses an animation loop you may need to edit it (usually found in an animation.lua file) and add a not CS_STORIES.ACTIVE check before playing an animation to ensure an animation glitch does not occur when the stories camera is opened.

Restart your phone

Ensure your phone’s resource via your server’s console.