Getting Started with Development - Revision history

Shr0x at 11:04, 2 May 2024

2024-05-02T11:04:02Z

← Older revision		Revision as of 11:04, 2 May 2024
Line 8:		Line 8:
	== Requirements ==		== Requirements ==

	* Server Files (~~from~~ [~~https://cdn.rage.mp/public/files/RAGEMultiplayer_Setup.exe RAGE:MP Client~~])		* Server Files (read how to get them [[Getting_Started_with_Server\|here]])
	* Basic [[wikipedia:en:JavaScript\|JavaScript]]/[[wikipedia:en:Node.js\|NodeJS]] programming knowledge		* Basic [[wikipedia:en:JavaScript\|JavaScript]]/[[wikipedia:en:Node.js\|NodeJS]] or [[wikipedia:en:C_Sharp_(programming_language)\|C#]] programming knowledge
	* A scripting/text editor of your choice (e.g. [[wikipedia:en:Visual Studio Code\|Visual Studio Code]] or [[wikipedia:en:Notepad++\|Notepad++]])		* A scripting/text editor of your choice (e.g. [[wikipedia:en:Visual Studio Code\|Visual Studio Code]] or [[wikipedia:en:Notepad++\|Notepad++]])

	== Starting the server ==		== Starting the server ==
	~~When~~ downloading ~~the~~ [~~https://cdn.rage.mp/public/~~files~~/RAGEMultiplayer_Setup.exe RAGE:MP Client~~] and running it, ~~you will get the server~~ files~~. The folder name~~ will ~~be called <code>server-files</code>~~. ~~Open the~~ folder ~~and you will find~~ this:		After downloading [[Getting_Started_with_Server\|server files]] and running '''ragemp-server.exe''' for the first time, some new files will show up. Your folder should look like this:

	<gallery widths=800px heights=426px>		<gallery widths=800px heights=426px>
Line 27:		Line 27:

	Currently you will find your folders empty, so if you want to load a gamemode there is a [https://github.com/n-n1ks/rage.mp-freeroam freeroam gamemode sample] available to study/use on your server.		Currently you will find your folders empty, so if you want to load a gamemode there is a [https://github.com/n-n1ks/rage.mp-freeroam freeroam gamemode sample] available to study/use on your server.
			== Info ==
			<b>Rage Multiplayer</b> consists of 3 sides of scripting:
			* '''CEF''' allows you to create and develop <abbr title="User Interface">user interfaces</abbr> and show people your creativity.
			* '''Client-side''' allows you to manipulate game client features and show people your creativity.
			* '''Server-side''' allows you to manipulate the server itself with things like managing all players, vehicles, markers, etc ([[:Category:Assets\|see more]]).

	== Setting up ~~API auto complete~~ (TypeScript) ==		== Setting up (TypeScript) ==
	Autocompletion is one of the most important features a developer can use while developing. It is annoying to keep searching in the wiki for the right syntax or find the right function you want. Thanks to '''CocaColaBear''' for his great contribution in creating an autocompletion package for RAGE JS API.		Learn how to setup your server using typescript [[Using_Typescript\|here]].
			== Setting Up (C#) ==
	*[https://github.com/CocaColaBear/types-ragemp-s autocomplete for SERVER side script]		Learn how to setup your server using C# [[Development_with_Visual_Studio_Code\|here]].
	*[https://github.com/CocaColaBear/types-ragemp-c autocomplete for CLIENT side script]

	~~=== Installation ===~~
	*Open your terminal (like [[wikipedia:en:PowerShell\|PowerShell]]) and navigate to your server ~~folder.~~
	*Install the following Node.js packages with NPM:
	**<code>npm install --save-dev github:CocaColaBear/types-ragemp-s#master</code> or <code>npm install --save-dev https://github.com/CocaColaBear/types-ragemp-s/tarball/master</code>
	**<code>npm install --save-dev github:CocaColaBear/types-ragemp-c#master</code> or <code>npm install --save-dev https://github.com/CocaColaBear/types-ragemp-c/tarball/master</code>
	*You should now get autocomplete.
	*Follow our next title to find out how the environment works and you'll notice that autocomplete is working.

	~~Learn more~~ [[Using_Typescript\|here]].

	== ~~Creating your first resource~~ ==
	~~<b>Rage Multiplayer</b> consists of 2 sides of scripting:~~
	* '''Client-side''' allows you to ~~create and develop <abbr title="User Interface">UI</abbr>, manipulate game client features and show people~~ your ~~creativity.~~
	* '''Server-side''' allows you to manipulate the server ~~itself with things like managing all players, vehicles, markers, etc (~~[[~~:Category:Assets~~\|~~see more~~]]).

			== Creating your first resource (Javascript) ==
	We will create our first server-side resource, and will see how it works in game. To learn about creating client-side resource, see [[Getting Started with Client-side\|Getting started with Client-side]].		We will create our first server-side resource, and will see how it works in game. To learn about creating client-side resource, see [[Getting Started with Client-side\|Getting started with Client-side]].

Line 134:		Line 124:

	= See also =		= See also =
	* [~~https://wiki.gtanet.work/index.php?title=Getting_Started_with_Development Getting started with Development on C# Bridge~~ Server]		*Javascript
	* [[Server-~~side events~~]] ~~(or in~~ [~~https://wiki.gtanet.work/index.php?title=Scripting_Events C#~~] ~~bridge)~~		**[[Server-side_events\|Server Side JS Events]]
	* [[~~Server~~-~~side functions~~]] ~~(or in [https://wiki.gtanet.work/index.php?title=Server_Scripting_Functions~~ C#~~] bridge)~~		**[[Server-side_functions\|Server Side JS Functions]]
	* [[~~Client~~-~~side events~~]] ~~(or in~~ [[~~Client~~-~~side_CSharp_events~~\|C#]])		**[[Client-side_events\|Client Side JS Events]]
	* [[Client-~~side functions~~]] ~~(or in~~ [[Client-side_CSharp_functions\|C#]])		**[[Client-side_functions\|Client Side JS Functions]]

			* C#
			**[[Server-side_CSharp_events\|Server Side C# Events]]
			**[[Server-side_CSharp_function\|Server Side C# Functions]]
			**[[Client-side_CSharp_events\|Client Side C# Events]]
			**[[Client-side_CSharp_functions\|Client Side C# Functions]]

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

Shr0x: /* Starting the server */

2021-09-08T06:49:39Z

Starting the server

← Older revision		Revision as of 06:49, 8 September 2021
Line 24:		Line 24:
	*'''plugins''': Allows you to load custom <code>.dll</code> plugins into the server.		*'''plugins''': Allows you to load custom <code>.dll</code> plugins into the server.
	*'''conf.json''': Contains the server configuration in JSON format. Read more about server settings [[Server_settings\|here]].		*'''conf.json''': Contains the server configuration in JSON format. Read more about server settings [[Server_settings\|here]].
	*'''server.exe''': Server executable, which if you run, starts the game server.		*'''ragemp-server.exe''': Server executable, which if you run, starts the game server.

	Currently you will find your folders empty, so if you want to load a gamemode there is a [https://github.com/n-n1ks/rage.mp-freeroam freeroam gamemode sample] available to study/use on your server.		Currently you will find your folders empty, so if you want to load a gamemode there is a [https://github.com/n-n1ks/rage.mp-freeroam freeroam gamemode sample] available to study/use on your server.

Xabi at 11:43, 15 June 2021

2021-06-15T11:43:17Z

← Older revision		Revision as of 11:43, 15 June 2021
Line 13:		Line 13:

	== Starting the server ==		== Starting the server ==
	When downloading the [https://cdn.rage.mp/~~client~~/~~updater~~.exe ~~Rage~~ MP ~~updater~~] and running it, you will get the server files. The folder name will be called <code>server-files</code>. Open the folder and you will find this:		When downloading the [https://cdn.rage.mp/public/files/RAGEMultiplayer_Setup.exe RAGE:MP Client] and running it, you will get the server files. The folder name will be called <code>server-files</code>. Open the folder and you will find this:

	<gallery widths=800px heights=426px>		<gallery widths=800px heights=426px>
Line 35:		Line 35:

	=== Installation ===		=== Installation ===
	*Open your terminal (like [[wikipedia:en:~~cmd.exe~~\|~~Command Prompt~~]]) and navigate to your server folder.		*Open your terminal (like [[wikipedia:en:PowerShell\|PowerShell]]) and navigate to your server folder.
	*Install the following Node.js packages with NPM:		*Install the following Node.js packages with NPM:
	**<code>npm install --save-dev github:CocaColaBear/types-ragemp-s#master</code> or <code>npm install --save-dev https://github.com/CocaColaBear/types-ragemp-s/tarball/master</code>		**<code>npm install --save-dev github:CocaColaBear/types-ragemp-s#master</code> or <code>npm install --save-dev https://github.com/CocaColaBear/types-ragemp-s/tarball/master</code>

MrPancakers2: /* Requirements */

2021-06-15T10:27:08Z

Requirements

← Older revision		Revision as of 10:27, 15 June 2021
Line 8:		Line 8:
	== Requirements ==		== Requirements ==

	* Server ~~files installed~~ (from [https://cdn.rage.mp/~~client~~/~~updater~~.exe ~~Rage~~ MP ~~updater~~])		* Server Files (from [https://cdn.rage.mp/public/files/RAGEMultiplayer_Setup.exe RAGE:MP Client])
	* Basic [[wikipedia:en:JavaScript\|JavaScript]]/[[wikipedia:en:Node.js\|NodeJS]] programming knowledge		* Basic [[wikipedia:en:JavaScript\|JavaScript]]/[[wikipedia:en:Node.js\|NodeJS]] programming knowledge
	* A scripting/text editor of your choice (e.g. [[wikipedia:en:Visual Studio Code\|Visual Studio Code]] or [[wikipedia:en:Notepad++\|Notepad++]])		* A scripting/text editor of your choice (e.g. [[wikipedia:en:Visual Studio Code\|Visual Studio Code]] or [[wikipedia:en:Notepad++\|Notepad++]])

RoboN1X: /* Introduction */

2019-05-20T18:26:06Z

Introduction

← Older revision		Revision as of 18:26, 20 May 2019
Line 3:		Line 3:
	== Introduction ==		== Introduction ==
	We are going to show you how to start developing your own server with a simple tutorial. We will show you how you can create your own resource and run it in your server. In here we are going to use NodeJS programming.		We are going to show you how to start developing your own server with a simple tutorial. We will show you how you can create your own resource and run it in your server. In here we are going to use NodeJS programming.

			If you wish to learn server-side with C# programming, [[Development_with_Visual_Studio_Code\|Click here]].

	== Requirements ==		== Requirements ==

RoboN1X: /* See also */

2019-05-01T09:53:36Z

RoboN1X: /* See also */

2019-05-01T09:53:06Z

RoboN1X: /* Starting the server */

2019-04-30T09:17:35Z

Starting the server

← Older revision		Revision as of 09:17, 30 April 2019
Line 21:		Line 21:
	*'''maps''': Folder in which map files (in [[wikipedia:en:JSON\|JSON]] format) are loaded into the game world.		*'''maps''': Folder in which map files (in [[wikipedia:en:JSON\|JSON]] format) are loaded into the game world.
	*'''plugins''': Allows you to load custom <code>.dll</code> plugins into the server.		*'''plugins''': Allows you to load custom <code>.dll</code> plugins into the server.
	*'''conf.json''': Contains the server configuration in JSON format. Read more about [[Server_settings\|~~server settings~~ here]].		*'''conf.json''': Contains the server configuration in JSON format. Read more about server settings [[Server_settings\|here]].
	*'''server.exe''': Server executable, which if you run, starts the game server.		*'''server.exe''': Server executable, which if you run, starts the game server.

	Currently you~~'ll~~ find your folders empty, so if you want to load a gamemode there is a [https://github.com/n-n1ks/rage.mp-freeroam freeroam gamemode sample] available to study/use on your server.		Currently you will find your folders empty, so if you want to load a gamemode there is a [https://github.com/n-n1ks/rage.mp-freeroam freeroam gamemode sample] available to study/use on your server.

	== Setting up API auto complete (TypeScript) ==		== Setting up API auto complete (TypeScript) ==

RoboN1X: /* Starting the server */

2019-04-30T09:14:39Z

Starting the server

← Older revision		Revision as of 09:14, 30 April 2019
Line 19:		Line 19:
	*'''client_packages''': Folder in which client-side scripts are located and downloaded by the client. (Client-side allows you to draw [[wikipedia:en:Graphical user interface\|<abbr title="Graphical User Interface">GUI</abbr>]] or do <abbr title="Chromium Embedded Framework">[https://bitbucket.org/chromiumembedded/cef CEF]</abbr> work)		*'''client_packages''': Folder in which client-side scripts are located and downloaded by the client. (Client-side allows you to draw [[wikipedia:en:Graphical user interface\|<abbr title="Graphical User Interface">GUI</abbr>]] or do <abbr title="Chromium Embedded Framework">[https://bitbucket.org/chromiumembedded/cef CEF]</abbr> work)
	*'''packages''': Folder in which server-side scripts are located and loaded by the server. (Server-side allows you to manage the player and create your own world)		*'''packages''': Folder in which server-side scripts are located and loaded by the server. (Server-side allows you to manage the player and create your own world)
	*'''maps''': Folder in which map files (in [[wikipedia:en:JSON]] format) are loaded into the game world.		*'''maps''': Folder in which map files (in [[wikipedia:en:JSON\|JSON]] format) are loaded into the game world.
	*'''plugins''': Allows you to load custom <code>.dll</code> plugins into the server.		*'''plugins''': Allows you to load custom <code>.dll</code> plugins into the server.
	*'''conf.json''': Contains the server configuration in JSON format. Read more about [[Server_settings\|server settings here]].		*'''conf.json''': Contains the server configuration in JSON format. Read more about [[Server_settings\|server settings here]].

RoboN1X: /* Creating your first resource */

2019-04-30T09:11:40Z

Creating your first resource

← Older revision		Revision as of 09:11, 30 April 2019
Line 47:		Line 47:
	* '''Server-side''' allows you to manipulate the server itself with things like managing all players, vehicles, markers, etc ([[:Category:Assets\|see more]]).		* '''Server-side''' allows you to manipulate the server itself with things like managing all players, vehicles, markers, etc ([[:Category:Assets\|see more]]).

	We will create our first server-side resource, and will see how it works in game. To learn about creating client-side resource, see [[Getting ~~started~~ with Client-side\|Getting ~~Started~~ with Client-side]].		We will create our first server-side resource, and will see how it works in game. To learn about creating client-side resource, see [[Getting Started with Client-side\|Getting started with Client-side]].

	First of all, go to <code>packages</code> and create a folder (name of game mode anything you want).		First of all, go to <code>packages</code> and create a folder (name of game mode anything you want).

← Older revision		Revision as of 09:53, 1 May 2019
Line 132:		Line 132:

	= See also =		= See also =
	* [Getting_Started_with_Development Getting started with Development on C# Bridge Server]		* [https://wiki.gtanet.work/index.php?title=Getting_Started_with_Development Getting started with Development on C# Bridge Server]
	* [[Server-side events]] (or in [https://wiki.gtanet.work/index.php?title=Scripting_Events C#] bridge)		* [[Server-side events]] (or in [https://wiki.gtanet.work/index.php?title=Scripting_Events C#] bridge)
	* [[Server-side functions]] (or in [https://wiki.gtanet.work/index.php?title=Server_Scripting_Functions C#] bridge)		* [[Server-side functions]] (or in [https://wiki.gtanet.work/index.php?title=Server_Scripting_Functions C#] bridge)

← Older revision		Revision as of 09:53, 1 May 2019
Line 132:		Line 132:

	= See also =		= See also =
			* [Getting_Started_with_Development Getting started with Development on C# Bridge Server]
	* [[Server-side events]] (or in [https://wiki.gtanet.work/index.php?title=Scripting_Events C#] bridge)		* [[Server-side events]] (or in [https://wiki.gtanet.work/index.php?title=Scripting_Events C#] bridge)
	* [[Server-side functions]] (or in [https://wiki.gtanet.work/index.php?title=Server_Scripting_Functions C#] bridge)		* [[Server-side functions]] (or in [https://wiki.gtanet.work/index.php?title=Server_Scripting_Functions C#] bridge)