Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imfelipedev/mta-sdk
Library created with the purpose of streamlining development, enabling developers to establish a direct connection with MTA:SA more efficiently.
https://github.com/imfelipedev/mta-sdk
Last synced: about 2 months ago
JSON representation
Library created with the purpose of streamlining development, enabling developers to establish a direct connection with MTA:SA more efficiently.
- Host: GitHub
- URL: https://github.com/imfelipedev/mta-sdk
- Owner: imfelipedev
- Created: 2023-07-23T04:56:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-26T16:36:27.000Z (over 1 year ago)
- Last Synced: 2024-04-08T23:16:30.511Z (8 months ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mta-sa - Node.js MTA SDK - Node.js integration with MTA server. (Other)
README
# [MTA SDK](https://github.com/zFelpszada/mta-sdk)
Library created with the purpose of streamlining development, enabling developers to establish a direct connection with MTA:SA more efficiently.
# Resources
- Execute functions
- Fetch data from servers or from a server.
- Socket
## API Documentation
#### Import SDK.
```js
import SDK from "mta-sdk";
```
#### Retrieve all servers and their information.
```js
const sdk = new SDK();
const result = await sdk.api.getAll();
```
#### Retrieve information for the ip server.
```js
const sdk = new SDK();
const result = await sdk.api.getFromIP(ip);
```
| Parameter | Type | Description |
| :-------- | :------- | :---------------------------------------------------------------------------------- |
| `IP` | `string` | **Required**. The IP of the server from which you want to retrieve the information. |
#### Retrieve information for the specified server.
```js
const sdk = new SDK();
const result = await sdk.api.getFromIPandPort(ip, port);
```
| Parameter | Type | Description |
| :-------- | :------- | :---------------------------------------------------------------------------------- |
| `IP` | `string` | **Required**. The IP of the server from which you want to retrieve the information. |
| `PORT` | `string` | **Required**. The PORT connection in server from which. |
#### Execute an HTTP function on the server.
Set up the SDK first to execute the function correctly.
```js
const sdk = new SDK(IP, PORT, USERNAME, PASSWORD, PROTOCOL);
```
| Parameter | Type | Description |
| :--------- | :------- | :---------------------------------------------------------------------------------- |
| `IP` | `string` | **Required**. The IP of the server from which you want to retrieve the information. |
| `PORT` | `string` | **Required**. The HTTP PORT connection in server from which. |
| `USERNAME` | `string` | **Required**. Admin account username. |
| `PASSWORD` | `string` | **Required**. Admin account password. |
After the proper setup, provide the parameters correctly to execute your function.
```js
const sdk = new SDK(IP, PORT, USERNAME, PASSWORD, PROTOCOL);
const result = await sdk.mta.execute(resource, functionName, object);
```
| Parameter | Type | Description |
| :------------- | :------- | :---------------------------------------------------------------------------- |
| `RESOURCE` | `string` | **Required**. Name of the resource that contains the function to be executed. |
| `functionName` | `string` | **Required**. Function name to be executed. |
| `object` | `object` | **Required**. object containing the information to be sent. |
#### Start socket.
```js
const sdk = new SDK();
sdk.socket.init(1337, "0.0.0.0", () => {
console.log("Socket open in port 1337");
});
```
| Parameter | Type | Description |
| :--------- | :--------- | :--------------------------------------------- |
| `port` | `string` | **Required**. Port to open socket. |
| `ip` | `string` | **Required**. IP to open socket.. |
| `callback` | `function` | **Required**. Function to receive opening data |
### Here's a basic example with plain socket:
```js
sdk.socket.on("connection", socket => {
console.log("new client");
socket.on("data", buffer => {
const message = buffer.toString().trim();
console.log(message);
});
socket.write("Hello from SDK-Socket");
});
```
## Authors
- [@zFelpszada](https://github.com/zFelpszada)
## License
[MIT](https://choosealicense.com/licenses/mit/)