Skip to content

mta-slipe/Slipe-CLI

Repository files navigation

Slipe-CLI

Slipe-CLI is the command line interface for the Slipe-MTA Framework

Getting Started

prerequisites

Installation

  • Install .NET Core 3.0 preview
  • download the .zip file with installer from the latest release.
  • unzip the file
  • On Windows:
    • run the install.bat file (double click)
  • On Linux:
    • run chmod +x ./install.sh
    • run sudo ./install.sh

you can now use the slipe command anywhere on your system

Usage

Slipe contains two types of commands, global commands and project dependent commands. Project dependent commands can only be executed in an existing Slipe project directory. Global commands can be executed anywhere on your system.

Global commands

# Create a new Slipe project
slipe new {project-name}

Project dependent commands

# Compile the slipe project to lua (this also generates the meta)
slipe compile 

# Indicate a visual studio project should be compiled to lua when running `slipe compile`
slipe add-project {project-name} [-server] [-client]

# Remove a visual studio project from compiling to lua
slipe remove-project {project-name} [-server] [-client]

# Adds a dll to be included durinAg C# compilation
slipe add-dll {dll-name}

# Removes a dll to no longer be included during C# compilation
slipe remove-dll {dll-name}

# Generates the meta.xml file for the project
slipe meta-generate

Authors

See also the list of contributors who participated in this project.

License

Apache 2.0 license.

Communication

Slipe Discord