-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
218 lines (199 loc) · 8.56 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Getting started | RageCoop resource documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Getting started | RageCoop resource documentation ">
<meta name="generator" content="docfx 2.59.2.0">
<link rel="shortcut icon" href="favicon.ico">
<link rel="stylesheet" href="styles/docfx.vendor.css">
<link rel="stylesheet" href="styles/docfx.css">
<link rel="stylesheet" href="styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">
<img id="logo" class="svg" src="logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="getting-started">Getting started</h1>
<h2 id="resources-and-scripts">Resources and Scripts</h2>
<p>A <strong>Script</strong> stands for class that inherits from RageCoop's script class ( <a href="API/RageCoop.Server.Scripting.ServerScript.html">ServerScript</a> and <a href="API/RageCoop.Client.Scripting.ClientScript.html">ClientScript</a> ) and will be loaded at runtime, one assembly can have multiple scripts in it.</p>
<p>A <strong>Resource</strong> consists of one or more assemblies and other files. Server-side resource will be loaded at startup and is isolated from other resources, while client-side resource will be sent to each client and loaded after they connected to the server. A <strong>Resource</strong> can either be in a folder or packed inside a zip archive.</p>
<h2 id="directory-structure">Directory structure</h2>
<p>Below is the server's directory structure</p>
<pre><code>ServerRoot
│ Settings.xml
| RageCoop.Server.exe
│
└───Resources
└───Server
│ │ RageCoop.Resources.Management.zip
│ │ RageCoop.Resources.Race.zip
│ │
│
│───Client
│ │ RageCoop.Resources.Race.Client.zip
│ │
│
└───Temp
</code></pre>
<h3 id="settingsxml">Settings.xml</h3>
<p>This file will be generated first time you started the server, you can then change the server's configuration option by editing it, refer to <a href="API/RageCoop.Server.ServerSettings.html">ServerSettings</a> for detailed description.</p>
<h2 id="server-resource">Server Resource</h2>
<ol>
<li>Create a C# class library project targeting .NET 6.0.</li>
<li>Add reference to <strong>RageCoop.Server.dll</strong> and <strong>RageCoop.Core.dll</strong>.</li>
<li>Add following namespace(s):
<pre><code>using RageCoop.Server.Scripting;
// Optional
using RageCoop.Server;
using RageCoop.Core.Scripting;
using RageCoop.Core;
</code></pre>
</li>
<li>Inherit from <a href="API/RageCoop.Server.Scripting.ServerScript.html">ServerScript</a>.</li>
<li>Implement <code>OnStart()</code> and <code>OnStop()</code>, your cs file should look like this:
<pre><code>using RageCoop.Server.Scripting;
namespace NiceGuy.MyFirstResource
{
public class Main : ServerScript
{
public override void OnStart()
{
// Initiate your script here
}
public override void OnStop()
{
// Free all resources and perform cleanup
}
}
}
</code></pre>
</li>
<li>Now you can have some fun by using the <a href="API/RageCoop.Server.Scripting.API.html">API</a> instance, please refer to the <a href="https://github.com/RAGECOOP/GTAV-RESOURCES">GitHub repo</a> for more examples.</li>
<li>For convenience, you can create a symlink in <code>ServerRoot/Resources/Server/NiceGuy.MyFirstResource</code> targeting your output folder:
<pre><code>mklink /d ServerRoot/Resources/Server/NiceGuy.MyFirstResource C:/MyRepos/NiceGuy.MyFirstResource/bin/Debug
</code></pre>
</li>
<li>That's it! Start your server and you should see your resource loading.</li>
</ol>
<h2 id="client-resource">Client Resource</h2>
<ol>
<li>Create a C# class library project targeting .NET Framework 4.8.</li>
<li>Add reference to <strong>RageCoop.Client.dll</strong> and <strong>RageCoop.Core.dll</strong>.</li>
<li>Add following namespace(s):
<pre><code>using RageCoop.Client.Scripting;
// Optional
using RageCoop.Core.Scripting;
using RageCoop.Core;
</code></pre>
</li>
<li>Inherit from <a href="API/RageCoop.Client.Scripting.ClientScript.html">ClientScript</a>.</li>
<li>Implement <code>OnStart()</code> and <code>OnStop()</code>, your cs file should look like this:
<pre><code>using RageCoop.Server.Scripting;
namespace NiceGuy.MyFirstClientResource
{
public class Main : ClientScript
{
public override void OnStart()
{
// Initiate your script here
}
public override void OnStop()
{
// Free all resources and perform cleanup
}
}
}
</code></pre>
</li>
<li>Now you can use anything from SHVDN to control client behaviour by adding a reference to <strong>ScriptHookVDotNet3.dll</strong></li>
<li>For convenience, you can create a symlink in <code>ServerRoot/Resources/Client/NiceGuy.MyFirstResource</code> targeting your output folder:
<pre><code>mklink /d ServerRoot/Resources/Client/NiceGuy.MyFirstClientResource C:/MyRepos/NiceGuy.MyFirstClientResource/bin/Debug
</code></pre>
</li>
<li>That's it! When a client connects the resource will be sent and loaded at client side.</li>
</ol>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/RAGECOOP/docs/blob/main/index.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="styles/docfx.vendor.js"></script>
<script type="text/javascript" src="styles/docfx.js"></script>
<script type="text/javascript" src="styles/main.js"></script>
</body>
</html>