Git Product home page Git Product logo

altv-angelscript-module's Introduction

Module not actively maintained and developed anymore


TfL Logo

alt:V AngelScript Module

An alt:V module providing support for the AngelScript scripting language

How to build

Prerequisites

  • CMake 3.8 or higher
  • A working C++ compiler (E.g. MSVC or GCC)
  • Git

Instructions

  1. Run git clone --recurse-submodules https://github.com/LeonMrBonnie/altv-angelscript-module.git to clone the repository
  2. Navigate to the folder with cd altv-angelscript-module
  3. Run the build.bat (Windows) or the build.sh (Linux) to build the project using CMake
  4. The built project .dll / .so can now be found in the dist subdirectory

If any errors persist, make sure to follow steps closely.

How to use

You can find information about the module in the Wiki.

How to contribute

If you want to contribute to this in any way, then first of all Thank You!

Just clone the repository, create a new branch to store your changes and create a pull request containing your created branch and changes.

Before commiting a pull request, please make sure to format your code using the projects clang-format configuration. This can be done by either manually using clang-format to format the files, using the VSCode task or by running the tools/format.(bat / sh) file.

If you are unsure with something and want to know how something works etc. you can contact me on Discord (LeonMrBonnie#9840).

It is suggested to use Visual Studio Code when working on this project, as there are already VSCode tasks set-up to simplify the workflow.

altv-angelscript-module's People

Contributors

leonmrbonnie avatar zackaryh8 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

altv-angelscript-module's Issues

Make adjustments to make module shared

Missing things on clientside:

  • Client only events
  • Handling class
  • Audio class
  • Blip class
  • Http Client class
  • Websocket Client class
  • WebView class
  • MemoryBuffer class
  • Natives

Rework API registration

Rewrite the whole process of registering the API. There should be proper support for entities and inheritance, properties & methods should be registered in a cleaner way.

Related to #21

Docs rework

Rework the whole docs.
Instead of the currently used DocsGenerator class that has to be used, throw that away completely and use the AngelScript methods to enumerate global functions, classes, their methods etc.
From this info the "new" DocsGenerator can then output a JSON that contains all the docs data, this JSON then gets uploaded to every release, and that JSON is used by an external generator to create the .as file and maybe a proper documentation.

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.