imported>Shr0x в 17:35, 29 мая 2024

2024-05-29T17:35:40Z

Новая страница

[[Category:Tutorials]]
[[Category:Typescript]]

= Information =

Typescript is a really great resource for C# users looking for a similar language for writing client and server side resources.
Luckily for us there are a few users out there who have created Typescript definitions for the RAGEMP.

If you'd like a quick startup without going through the installation said below you can install an already made boilerplate such as:

[https://github.com/leonardssh/ragemp-typescript RAGEMP Typescript Boilerplate]

= Getting Started =

= Prerequisites =
* [https://nodejs.org/ NodeJS] Installed
* [https://wiki.rage.mp/index.php?title=Getting_Started_with_Server General Server Setup] Done
* [https://code.visualstudio.com/ Visual Studio Code] Installed
* [https://github.com/ragempcommunity/ragemp-types RAGEMP Type Definitions] Installed

= Setup =

Open Visual Studio Code

Pressing <code>ctrl + `</code> (or by going to File > Terminal > New terminal) will open a terminal.

Initialize a new Nodejs project by running the commands below in your terminal:
<pre>npm init</pre> Or for a quick setup: <pre>npm init -y</pre>

After you're done initializing the new nodejs project, execute the command below to install typescript:
<pre>npm install -g typescript</pre>

To verify that you have installed typescript correctly type:

<pre>
tsc --version //should output typescript version
</pre>

= Adding Typescript Definitions =

Client-Side

<pre>
# With npm
> npm i --save-dev @ragempcommunity/types-client

# With yarn
> yarn add -D @ragempcommunity/types-client

# With pnpm
> pnpm add -D @ragempcommunity/types-client

</pre>

Server-Side

<pre>
# With npm
> npm i --save-dev @ragempcommunity/types-server

# With yarn
> yarn add -D @ragempcommunity/types-server

# With pnpm
> pnpm add -D @ragempcommunity/types-server
</pre>

If neither of these happen to be working properly you can try removing <code>-g</code>. That's just a global install function.

You can verify if it's working properly by creating a new Typescript file. <code>.ts</code>

Then begin programming by typing:

<pre>mp.game</pre>

If working properly you will have auto-fill available.

= Workspace Help =

When you're working with Typescript you want your workspace to be setup in <code>clientside_resources</code>.

You can do this by going to: <code>File -> Open Folder -> clientside_resources</code>

After you should initialize your typescript directory by doing <code>Ctrl + `</code> and typing <code>tsc --init</code>.

If done correctly you will have a <code>tsconfig.json</code>

= Compiling your Typescript Files =

You mainly want to do this through your command prompt. You can open up a prompt in Visual Studio Code by press <code>Ctrl + `</code>.

This will allow you to easily type <code>tsc</code>

If done properly you will see newly compiled JavaScript files available in the same directory as the files you have created.

Using Typescript - История изменений

imported>Shr0x в 17:35, 29 мая 2024