2.0.0 • Published 2 years ago

rage-mp v2.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

RAGE MP

API for getting RAGE MP server info & status. Examples

📥 Installation

npm i rage-mp

npm version

🧷 import

Javascript

const RageMp = require("rage-mp").default;

TypeScript

import { RageMp } from "rage-mp";

⚙️Usage

const rageMp = new RageMp({timeout:1000})

const server = await rageMp.getSingleServer("ip:port")
//result:
        // name: "server Name
        //     gamemode: "gangwar",
        //     url: "rage.mp",
        //     lang: "en",
        //     players: 10,
        //     peak: 1,
        //     maxplayers: 100,
        //     ip: "ip:port"

ALL METHODS

  • getServers - get all servers
  • getSingleServer - get single server with ip:port
  • getServersByGamemode - get all servers by gamemode
  • getServersByLang - get all servers by lang

🪂EXAMPLES

const RageMp = require("rage-mp").default;
(async () => {
    const rageMp = new RageMp({})
    const servers = await rageMp.getServers()
    console.log(servers) // servers array
})();

📝 TODO

  • add more methods
  • better docs