From 62fa4c811b9dd9cc1cc70da6b6f9e5a4c8b0496e Mon Sep 17 00:00:00 2001 From: lucas~ Date: Wed, 16 Oct 2024 00:52:18 -0500 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index e69de29..1844242 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,21 @@ +# ImperialTablet + +[![](https://dcbadge.limes.pink/api/server/https://discord.gg/FCx9eaWFn4/?style=flat&theme=clean-inverted)](https://discord.gg/FCx9eaWFn4) [![Build status](https://ci.appveyor.com/api/projects/status/r8wi567unkb451on?svg=true)](https://ci.appveyor.com/project/traditionalism/imperialtablet) + +## Overview + +**ImperialTablet** is an in-game NUI integration for Imperial CAD. + +## Installation + +- _Firstly_, start the installation process of ImperialTablet by downloading the latest [release binaries](https://github.com/traditionalism/ImperialLibrary/releases). +> [!WARNING] +> _If this is your first time using an Imperial CAD plugin, you **MUST** set your community ID in your server.cfg using the [setr command](https://docs.fivem.net/docs/scripting-reference/convars/#server-replicated-convars) below (you can safely skip this step if you've used one of our plugins before)_ +``` +setr imperial_community_id "COMMUNITY_ID_HERE" +``` +- After ensuring your Imperial CAD community ID is set, you can configure **ImperialTablet** using the provided `Config.ini` file. +- _Finally_, start **ImperialTablet** on server start by adding the following line to your `server.cfg` +``` +ensure ImperialTablet +```