Skip to content

Latest commit

 

History

History
120 lines (100 loc) · 4.63 KB

index.md

File metadata and controls

120 lines (100 loc) · 4.63 KB

Getting started

Resources and Scripts

A Script stands for class that inherits from RageCoop's script class ( ServerScript and ClientScript ) and will be loaded at runtime, one assembly can have multiple scripts in it.

A Resource 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 Resource can either be in a folder or packed inside a zip archive (*.res).

Directory structure

Below is the server's directory structure

ServerRoot
│   Settings.xml   
|   RageCoop.Server.exe
│
└───Resources
    └───Server
    │   │   RageCoop.Resources.Management
    │   │   RageCoop.Resources.Race
    │   │   
    │
    │───Client
    │   │   RageCoop.Resources.Race.Client
    │   │
    │
    └───Temp

Settings.xml

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 ServerSettings for detailed description.

Server Resource

  1. Create a C# class library project targeting .NET 6.0.
  2. Add reference to RageCoop.Server.dll and RageCoop.Core.dll.
  3. Add following namespace(s): 
    using RageCoop.Server.Scripting;

// Optional
using RageCoop.Server;
using RageCoop.Core.Scripting;
using RageCoop.Core;
  4. Inherit from ServerScript.
  5. Implement OnStart() and OnStop(), your cs file should look like this: 
    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
         }
    }
}
  6. Now you can have some fun by using the API instance, please refer to the GitHub repo for more examples.
  7. You can create a symlink in ServerRoot/Resources/Server/NiceGuy.MyFirstResource targeting your output folder: 
    mklink /d ServerRoot/Resources/Server/NiceGuy.MyFirstResource C:/MyRepos/NiceGuy.MyFirstResource/bin/Debug
  8. That's it! Start your server and you should see your resource loading.

Client Resource

  1. Create a C# class library project targeting .NET Framework 4.8.
  2. Add reference to RageCoop.Client.dll and RageCoop.Core.dll.
  3. Add following namespace(s): 
    using RageCoop.Client.Scripting;

// Optional
using RageCoop.Core.Scripting;
using RageCoop.Core;
  4. Inherit from ClientScript.
  5. Implement OnStart() and OnStop(), your cs file should look like this: 
    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
         }
    }
}
  6. Now you can use anything from SHVDN to control client behaviour by adding a reference to ScriptHookVDotNet3.dll
  7. Oou can create a symlink in ServerRoot/Resources/Client/NiceGuy.MyFirstResource targeting your output folder: 
    mklink /d ServerRoot/Resources/Client/NiceGuy.MyFirstClientResource C:/MyRepos/NiceGuy.MyFirstClientResource/bin/Debug
  8. That's it! When a client connects the resource will be sent and loaded at client side.

Building and publishing

When you're done testing your resource, you can fork our repo and add your own resource to a Resources/YourName/YourSolutionFolder, then add a ResourceManifest.json file to the directory. There's some example manifest that you can take a look, make sure it's properly set-up otherwise the build will fail. When you're done, make a PR, your resource will be built and packed into a single file on our GitHub repo.