|
1 | | -# After buying |
| 1 | +import { Callout, Steps, Tabs, Cards } from "nextra/components"; |
| 2 | +import { DownloadIcon, GearIcon, BookmarkIcon, ChatBubbleIcon } from "@radix-ui/react-icons"; |
2 | 3 |
|
3 | | -After buying a resource, we recommend you look through the documentation for that specific resource. |
| 4 | +# After Buying |
4 | 5 |
|
5 | | -Most of the time, if not done automatically, you will have to execute the SQL files (if there are any). |
| 6 | +Congratulations on your purchase! This comprehensive guide will walk you through everything you need to know to successfully install, configure, and maintain your new Zerio-Scripts resource. |
6 | 7 |
|
7 | | -You would also, just like any other resource, have to add/start it via your `server.cfg` file. |
| 8 | +## 🚀 Quick Start Checklist |
8 | 9 |
|
9 | | -## Configuring the resource |
| 10 | +<Steps> |
10 | 11 |
|
11 | | -In all our resources, there are configuration files. Depending on when the resource was made, the file structure may differ. |
| 12 | +### Download Your Files |
| 13 | +1. Check your email for the download confirmation |
| 14 | +2. Visit [FiveM's Portal](https://portal.cfx.re) to download your files |
| 15 | +3. Extract the resource to a temporary location for review |
12 | 16 |
|
13 | | -Generally, your configuration files would be one of these: |
| 17 | +### Review Documentation |
| 18 | +1. Read the specific product documentation for your resource |
| 19 | +2. Check the requirements and compatibility information |
| 20 | +3. Review configuration options before installation |
14 | 21 |
|
15 | | -- The `config.lua` file in the main project folder |
16 | | -- All files in the `shared` folder in the main project folder |
17 | | -- All files in the `config` folder in the main project folder |
| 22 | +### Install and Configure |
| 23 | +1. Upload files to your server's resources folder |
| 24 | +2. Import SQL files (if applicable) |
| 25 | +3. Add the resource to your `server.cfg` |
| 26 | +4. Configure settings to match your server setup |
18 | 27 |
|
19 | | -## Community server |
| 28 | +### Test and Launch |
| 29 | +1. Start your server and test basic functionality |
| 30 | +2. Join our [community Discord](https://discord.zerio-scripts.com) for support |
| 31 | +3. Consider contributing feedback for future improvements |
20 | 32 |
|
21 | | -As someone interested, you are always welcome to join our [community server](http://docs.zerio-scripts.com). We **especially** recommend this for our customers, as a lot of important information is sent here. |
| 33 | +</Steps> |
| 34 | + |
| 35 | +## 📁 File Management |
| 36 | + |
| 37 | +### Downloading from the cfx.re Portal |
| 38 | + |
| 39 | +<Callout type="info"> |
| 40 | +All Zerio-Scripts products are delivered through FiveM's official Portal, ensuring secure and authenticated downloads. |
| 41 | +</Callout> |
| 42 | + |
| 43 | +1. **Login to the cfx.re Portal**: Visit [portal.cfx.re](https://portal.cfx.re) using your FiveM account |
| 44 | +2. **Find Your Asset**: Locate your purchased resource in the "Granted Assets" section |
| 45 | +3. **Download Files**: Click the download button to get the latest version |
| 46 | +4. **Extract Archive**: Unzip the downloaded file to access the resource folder |
| 47 | + |
| 48 | +## ⚙️ Installation Process |
| 49 | + |
| 50 | +### Method 1: Standard Installation |
| 51 | + |
| 52 | +1. Extract the downloaded ZIP file |
| 53 | +2. Copy the resource folder to `[server-folder]/resources/` |
| 54 | +3. Open your `server.cfg` file in a text editor |
| 55 | +4. Add `ensure zerio-resourcename` (replace with actual resource name) |
| 56 | +5. Save and restart your server |
| 57 | + |
| 58 | +## 🗄️ Database Setup |
| 59 | + |
| 60 | +### SQL File Import |
| 61 | + |
| 62 | +Many resources require database tables. Import these **before** starting the resource: |
| 63 | + |
| 64 | +<Tabs items={['phpMyAdmin', 'Command Line', 'HeidiSQL']}> |
| 65 | + <Tabs.Tab> |
| 66 | + 1. Open phpMyAdmin in your web browser |
| 67 | + 2. Select your FiveM database |
| 68 | + 3. Click "Import" tab |
| 69 | + 4. Choose the SQL file from the resource's `sql/` folder |
| 70 | + 5. Click "Go" to execute the import |
| 71 | + </Tabs.Tab> |
| 72 | + <Tabs.Tab> |
| 73 | + ```bash |
| 74 | + mysql -u username -p database_name < /path/to/resource/sql/install.sql |
| 75 | + ``` |
| 76 | + Replace `username` and `database_name` with your actual values. |
| 77 | + </Tabs.Tab> |
| 78 | + <Tabs.Tab> |
| 79 | + 1. Open HeidiSQL and connect to your database |
| 80 | + 2. Select your FiveM database |
| 81 | + 3. Go to Tools → Load SQL file |
| 82 | + 4. Select the SQL file from the resource |
| 83 | + 5. Execute the script |
| 84 | + </Tabs.Tab> |
| 85 | +</Tabs> |
| 86 | + |
| 87 | +<Callout type="warning"> |
| 88 | +**Important**: Always backup your database before importing new SQL files. This ensures you can restore your data if something goes wrong. |
| 89 | +</Callout> |
| 90 | + |
| 91 | +## 🛠️ Configuration Guide |
| 92 | + |
| 93 | +### Configuration File Locations |
| 94 | + |
| 95 | +Depending on when the resource was created, configuration files may be located in different places: |
| 96 | + |
| 97 | +<Cards> |
| 98 | + <Cards.Card |
| 99 | + icon={<GearIcon />} |
| 100 | + title="Modern Structure" |
| 101 | + href="#" |
| 102 | + arrow |
| 103 | + /> |
| 104 | + |
| 105 | + <Cards.Card |
| 106 | + icon={<BookmarkIcon />} |
| 107 | + title="Legacy Structure" |
| 108 | + href="#" |
| 109 | + arrow |
| 110 | + /> |
| 111 | +</Cards> |
| 112 | + |
| 113 | +## 🔧 Testing Your Installation |
| 114 | + |
| 115 | +### Basic Functionality Test |
| 116 | + |
| 117 | +1. **Server Startup**: Check console for any error messages |
| 118 | +2. **Resource Loading**: Verify the resource starts without warnings |
| 119 | +3. **In-Game Testing**: Join your server and test basic functionality |
| 120 | +4. **Command Testing**: Try any included commands or interactions |
| 121 | +5. **Permission Testing**: Test with different user permission levels |
| 122 | + |
| 123 | +### Common Test Scenarios |
| 124 | + |
| 125 | +- **Player Interactions**: Test all player-facing features |
| 126 | +- **Admin Functions**: Verify administrative capabilities work |
| 127 | +- **Database Integration**: Confirm data is being saved/loaded correctly |
| 128 | +- **Multi-Player**: Test with multiple players if applicable |
| 129 | +- **Error Handling**: Test edge cases and error scenarios |
| 130 | + |
| 131 | +## 📞 Getting Support |
| 132 | + |
| 133 | +### Community Resources |
| 134 | + |
| 135 | +<Cards> |
| 136 | + <Cards.Card |
| 137 | + icon={<ChatBubbleIcon />} |
| 138 | + title="Join Our Discord" |
| 139 | + href="https://discord.zerio-scripts.com" |
| 140 | + arrow |
| 141 | +/> |
| 142 | + |
| 143 | + <Cards.Card |
| 144 | + icon={<BookmarkIcon />} |
| 145 | + title="Product Documentation" |
| 146 | + href="https://docs.zerio-scripts.com" |
| 147 | + arrow |
| 148 | + /> |
| 149 | +</Cards> |
| 150 | + |
| 151 | +### When Asking for Help |
| 152 | + |
| 153 | +To get the best support experience, please provide: |
| 154 | + |
| 155 | +1. **Resource Name**: Which Zerio-Scripts product you're having issues with |
| 156 | +2. **Server Framework**: QBCore, ESX, or standalone |
| 157 | +3. **Error Messages**: Full console output including any error messages |
| 158 | +4. **Configuration**: Relevant parts of your configuration files |
| 159 | +5. **Steps to Reproduce**: Detailed steps that lead to the issue |
| 160 | + |
| 161 | +### Important Announcements |
| 162 | + |
| 163 | +Our Discord community is where we share: |
| 164 | +- **Update Notifications**: When new versions are available |
| 165 | +- **Breaking Changes**: Important compatibility information |
| 166 | +- **Feature Announcements**: New features and improvements |
| 167 | +- **Community Tips**: User-generated guides and solutions |
| 168 | + |
| 169 | +<Callout type="info"> |
| 170 | +**Pro Tip**: Join our Discord community immediately after purchase. Many common questions are answered in our FAQ channels, and you'll be notified of important updates automatically. |
| 171 | +</Callout> |
| 172 | + |
| 173 | +--- |
| 174 | + |
| 175 | +*Successfully installed? Great! Don't forget to check out the specific documentation for your resource to learn about advanced features and configuration options.* |
0 commit comments