Skip to content

Commit 3eb100b

Browse files
Update readme add requirements
1 parent f5091ef commit 3eb100b

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,32 @@ This MTA resource makes use of the clientside allocated models ([engineRequestMo
99

1010
With this resource you can make scripts or change your existing scripts to add new skin, vehicle and object IDs to your server! For example, you may add all SA-MP object models!
1111

12-
## What changed? ⚠️
12+
## Docs/Tutorial
1313

14-
**This version (v5) provides no guarantee that your code made for previous versions (v3, v4) will still work, but don't worry, the main concept hasn't changed.**
14+
🚀 **Are you new to this resource?** Start here: [Documentation file](/.github/doc/DOCUMENTATION.md)
1515

16-
It is easy to migrate from v4 (not from v3) to v5. The **models folder structure remains the same**, but the scripts have changed.
16+
## Requirements
1717

18-
This resource no longer uses and relies on the **MTA Element Data system** to sync the models to all clients! This major change was made to **improve performance** and control the sync of models more efficiently.
18+
⚠️ **Before you download and install this resource**, make sure you have the following:
1919

20-
## Docs/Tutorial
20+
- MTA 1.6 Nightly server (most recent version recommended from [nightly.multitheftauto.com](https://nightly.multitheftauto.com/))
21+
- Up to date MTA client to play on the server
22+
- Some scripting knowledge to use the new models in your scripts
23+
- Basic understanding of GTA:SA and how game mods work
2124

22-
🚀 **Are you new to this resource?**
25+
## Download
2326

24-
Access the [Documentation file](/.github/doc/DOCUMENTATION.md) to learn everything you need to know.
27+
Get the [Latest Version](https://github.com/Fernando-A-Rocha/mta-add-models/releases/latest) from the **Releases** section.
2528

26-
## Community
29+
## Older versions
2730

28-
Visit the [Thread on the MTA Forum](https://forum.mtasa.com/topic/133212-rel-add-new-models-library/) to get in touch with fellow users and developers.
31+
It is easy to migrate to v5 from newmodels v4 (not from v3; the architecture of that version is no longer used). The **models folder structure remains the same**, but the scripts have changed in the way models are applied to elements.
2932

30-
## Download
33+
This resource no longer uses and relies on the **MTA Element Data system** (`setElementData`) to sync the models to all clients! Instead, newmodels makes use of Lua tables and MTA events. This major change was made to **improve performance** and control the sync of models more efficiently.
3134

32-
Get the [Latest Version](https://github.com/Fernando-A-Rocha/mta-add-models/releases/latest) from the **Releases** section.
35+
## Community
36+
37+
Visit the [Thread on the MTA Forum](https://forum.mtasa.com/topic/133212-rel-add-new-models-library/) to get in touch with fellow users and developers.
3338

3439
## Media
3540

0 commit comments

Comments
 (0)