Code Monkey home page Code Monkey logo

altv-js-module-v2's Introduction

alt:V JS module v2

NOTE: The v2 module is still a work in progress and not ready for production use.

Repository containing the new JS module v2 module for alt:V multiplayer.

Structure

Directory Description
/client Clientside JS module powered by V8
/server Serverside JS module powered by Node.js
/shared Shared code for the clientside & serverside module
/docs Documentation for the internal workings of the module
/deps Global dependencies
/tools Scripts for any tooling related to the module
/types Typings for the API

Contributions

All contributions are greatly appreciated. If there are any questions or you would like to discuss a feature, contact the module maintainer.

Installing Module

Installing the Module on the Client

NOTE: Client modules are only loaded when you are on the dev branch and have debug mode enabled.

  1. Download the latest js-module-v2-windows-client.zip file from the Releases page.

  2. Copy the modules folder into your alt:V client directory (the folder where altv.exe is located).

  3. Once you start alt:V, a popup will appear, asking whether you want to run unofficial modules. Click "Yes"

Installing the Module on Your Server

NOTE: Your server must be on the latest dev branch for the module to load correctly.

  1. Download the latest js-module-v2-windows-server.zip or js-module-v2-linux.zip file from the Releases page.

  2. Copy the modules/js-module-v2.* files (for Windows) or libjs-module-v2.so file (for Linux) into your server's modules folder.

  3. Copy the libnodev2.dll file (for Windows) or libnodev2.so file (for Linux) into the root folder of your server, where your altv-server.exe (for Windows) or altv-server (for Linux) executable is located.

  4. Load the module by adding 'js-module-v2' to the array of modules in your server.toml file.

  5. Create a resource with type = "jsv2" and client-type = "jsv2" in resource.toml file.

Alternatively, you can also download the server module from the official alt:V CDN server:

v1 Compatibility

Add this to resource.toml to use v1 API (alt-client, alt-server, etc.)

[js-module-v2]
compatibilityEnabled = true

altv-js-module-v2's People

Contributors

leonmrbonnie avatar xluxy avatar yiin avatar xdavidos avatar yannbcf avatar florianv85 avatar xxshady avatar deluvas1911 avatar drakeee avatar notmatical avatar carlos-menezes avatar mszekiel avatar buh13246 avatar stuyk avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.