Skip to content

Commit

Permalink
Added getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
BurnhamR committed Apr 7, 2024
1 parent 81e0609 commit fedc8de
Show file tree
Hide file tree
Showing 7 changed files with 91 additions and 23 deletions.
6 changes: 3 additions & 3 deletions docs/cad/joining-cad.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ sidebar_position: 1

# Joining the CAD

The MTDOJRP CAD is a web-based platform that allows you to create and manage your characters, vehicles, and much more!
The KCDOJRP CAD is a web-based platform that allows you to create and manage your characters, vehicles, and much more!

:::warning This is Required!
It is a requirement to have an account on the CAD platform to be able to play on the MTDOJRP server.
It is a requirement to have an account on the CAD platform to be able to play on the KCDOJRP server.
:::

---

## 🖥️ Accessing the CAD

1. **Access CAD**: Navigate to our CAD by visiting [this link](https://cad.mtdojrp.org/).
1. **Access CAD**: Navigate to our CAD by visiting [this link](https://cad.KCDOJRP.org/).

2. **Register/Log in**: If you're new, you'll need to register an account. If you already have an account, log in using your credentials.

Expand Down
10 changes: 5 additions & 5 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
sidebar_position: 1
---

# MTDOJRP Documentation
# KCDOJRP Documentation

Welcome to the **MTDOJRP** documentation! 🎉 Dive into our comprehensive guide that provides insights into the myriad of features and functionalities available within MTDOJRP server.
Welcome to the **KCDOJRP** documentation! 🎉 Dive into our comprehensive guide that provides insights into the myriad of features and functionalities available within KCDOJRP server.

---

Expand All @@ -16,7 +16,7 @@ Welcome to the **MTDOJRP** documentation! 🎉 Dive into our comprehensive guide
- 📕 [Our Rules](/docs/introduction/rules)


### 🖥️ MTDOJRP CAD
### 🖥️ KCDOJRP CAD
- 🖥️ [Joining the CAD](/docs/cad/joining-cad)
- 🧑 [Register a citizen](/docs/cad/citizens)
- 🚗 [Register a vehicle](/docs/cad/vehicles)
Expand All @@ -29,8 +29,8 @@ Welcome to the **MTDOJRP** documentation! 🎉 Dive into our comprehensive guide
### 👕 Clothing Reel
- 🎮 [Usage and key binds](#)

### 📋 MTDOJRP Menu
- 🛠️ [How to use the MTDOJRP Menu](#)
### 📋 KC Menu
- 🛠️ [How to use the KC Menu](#)
- 🔒 [Understanding permissions](#)

### 🛡️ Trusted Civilians
Expand Down
10 changes: 3 additions & 7 deletions docs/introduction/basic-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 3

# Basic Commands

This section covers the basic commands that are available to all players on the MTDOJRP server.
This section covers the basic commands that are available to all players on the KCDOJRP server.

## 🚗 Vehicle Commands
- **/dv**: Deletes the vehicle you're currently in or nearby.
Expand All @@ -14,17 +14,13 @@ This section covers the basic commands that are available to all players on the

## 🧑 Player Commands
- **/me (action)**: Displays an action in chat for nearby players.
- **//me (action)**: Displays a global action in the chat for all players.
- **/gme (action)**: Displays a global action in the chat for all players.
- **/911 (message)**: Calls 911 with the specified message and your location.
- **/ooc (message)**: Sends an out-of-character message in the chat.

## 🚶 Action Commands
- **/handsup**: Puts your hands up.
- **/handsupknees**: Puts your hands up and kneels down on the ground.

## 🛠️ MTDOJRP Commands
- **/mtdojrpmenu**: Opens the MTDOJRP Menu, you can use this instead of the `F1` key-bind.
- **/discordsync**: Re-syncs your Discord roles with the server.
- **/huk**: Puts your hands up and kneels down on the ground.

---

Expand Down
Binary file added docs/introduction/cam-icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 78 additions & 6 deletions docs/introduction/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,101 @@
sidebar_position: 1
---

# Getting Started with MTDOJRP
# Getting Started with KCDOJRP

Welcome to the MTDOJRP community on FiveM! This section will guide you through the initial steps to get you started and immerse you in our role-playing experience.
Welcome to the Kelly County Department of Justice Roleplay community on FiveM! This section will guide you through the initial steps to get you started and immerse you in our role-playing experience.

🔍 This is a basic guide to get you started on the MTDOJRP server. For more detailed information and advanced features, please refer to the respective sections in the documentation.
🔍 This is a basic guide to get you started on the KCDOJRP server. For more detailed information and advanced features, please refer to the respective sections in the documentation.

---

## 💬 Discord Link Invite

Join our community on Discord to stay updated, get support, and interact with other members. Click [here](https://discord.gg/fRwb4wAvyC) to join our Discord server.
Before anything, make sure to join our community on Discord to stay updated, get support, and interact with other members. Click [here](https://discord.gg/fRwb4wAvyC) to join our Discord server.

:::warning This is Required!

You must join our discord server to be able to play on the server.
:::

## 🚀 Joining the Server
Skip steps 1-4 if you are already familiar with FiveM.

1. **Install FiveM**: Before you can join our server, ensure you have [FiveM](https://fivem.net/) installed. If you haven't, visit their official website and follow the installation instructions.

2. **Launch FiveM**: Once installed, launch FiveM and let it update to the latest version.

3. **Server Search**: In the FiveM client, click on the `Play` button and then on the `Servers` tab. Use the search bar to type "MTDOJRP" to find our server.
3. **Server Search**: In the FiveM client, click on the `Play` button and then on the `Servers` tab. Use the search bar to type "KCDOJRP" to find our server.

4. **Connect**: Select the MTDOJRP server from the search results and click `Connect`. You'll be loaded into our server shortly.
4. **Connect**: Select the KCDOJRP server from the search results and click `Connect`. You'll be loaded into our server shortly.

## 👤 Creating your first in-game character

Before doing anything, You must create a character to use while roleplaying!

1. Press the `F1` key, This will open the main menu which you can use to manage your in-game characters, spawn vehicles, and more!

2. Open `Civilian Dashboard` -> `Citizen Customization` -> `Create New Citizen`

3. This will open the character creation screen, From here you will be able to select the gender under `Ped`

4. Select `Inheritance` to customize parents race, face, etc

5. `Face Features` allows you to customize your characters head

6. `Appearance` allows you to customize your characters appearance.

7. Finish off with `Clothing`, `Props`, & `Tattoos`

8. **Saving**: Make sure to save your character by clicking the disk save icon 💾!

Tip: You can change you camera angles by using the following icons:

![Camera Icons](cam-icons.png)

## 🖥️ Registering in the CAD

Now that we have created your character, We must register them into our [CAD(https://cad.kcdojrp.com/)](https://cad.kcdojrp.com/) system!

1. Open the [CAD(https://cad.kcdojrp.com/)](https://cad.kcdojrp.com/)

2. Select on `Login Via Discord` & select `Authorize`, If this is your first time logging in, Please enter a password you'd like to use
* The password will be used when accessing the CAD in game.

3. From here you can manage your characters, vehicles, LEO, and more!

4. Lets create our new character! Select on `Create Citizen`

5. Enter your characters name(Most people use their IRL name if its their main character), Date of birth, Gender, Race, Hair Color, Eye Color, Weight(in pounds), Height(in ft in, Ex. 5' 8"), and postal code(Will auto fill address). You can also upload an image of your character, However this is optional!
* Postal codes can be seen on the in-game map and are the 4 digit number.

6. Select Next, You can optionally fill in a phone number, occupation, and other info here!

7. Select Next, Here you can give your player license to do various things! Most players will only need a `Drivers License`, Select Valid, and `Non-commercial vehicles (Class D)
* You can also select invalid licenses and LEO will be able to see this on their side when they run your name!

8. Select Next, Here you can optionally put in any criminal history such as Tickets, Warnings, or Arrests!

9. Select `Create`, Congrats! You have now created a new Citizen in the CAD! You will now be able to view all your information and play properly on the server!

# 🚗 Creating a vehicle

Now lets get you driving around the server!

1. Press the `F1` key, and go to `Vehicle Management Tools` -> `Vehicle Spawner`

2. Here you will see all the categories of vehicles you can spawn, As you play on the server you may unlock more such as super cars, LEO, etc

3. Spawn a vehicle here and use the `Vehicle Management Tools` -> `Vehicle Management` to customize the vehicle to your liking.
* You can change the vehicle color, wheels, plate, and much more!

4. Once you have a vehicle created, Make sure to save it so you always have it! `Vehicle Management Tools` -> `Save Current Vehicle` enter the vehicles name.

5. Registering the vehicle in the CAD, Open the [CAD(https://cad.kcdojrp.com/)](https://cad.kcdojrp.com/) or use `F4` key in-game(Use your Discord username and the password we set earlier to login)

6. Select `Register Vehicle`, Optionally attach an image, Enter your plate, Model, Owner(You Characters name), Color, Trim levels(Optional), and status!

7. Select on `Register Vehicle`


### Congrats! You now have the basics of getting started on KCDOJRP! Next check out the [Commands](/docs/introduction/basic-commands) sections!
2 changes: 1 addition & 1 deletion docs/introduction/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Your microphone must be clear and audible, If you are asked to fix your micropho

:::note Permissions
Do not abuse any of your permissions. This includes but is not limited to:
- any functions within the MTDOJRP Menu
- any functions within the KC Menu
- any functions within the CAD
- any special permissions such as;
- **Law Enforcement**: As a LEO you may not use your powers to benefit yourself or others.
Expand Down
2 changes: 1 addition & 1 deletion src/components/HomepageFeatures/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const FeatureList = [
{
title: (
<>
<a href="/introduction/getting-started">First Join : Getting Started</a>
<a href="/docs/introduction/getting-started">First Join : Getting Started</a>
</>
),
Svg: require('@site/static/img/right-to-bracket-duotone.svg').default,
Expand Down

0 comments on commit fedc8de

Please sign in to comment.