npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fivem-server-utility

v1.0.0

Published

Utility package for interacting with FiveM servers

Downloads

7

Readme

Fivem Server Info

Description

This npm package allows you to interact with a FiveM server by retrieving server information, player details, sending commands via RCON, and more.

Installation

To install the package, run the following command:

npm install fivem-server-utility

Usage

const FivemServer = require('fivem-server-utility');

// Initialize the FivemServer object with IP, port, and RCON password
const server = new FivemServer('server_ip', 'server_port', 'rcon_password');

// Example usage
server.getPlayers()
    .then(players => console.log('Players:', players))
    .catch(error => console.error('Error:', error));

server.getPlayerCount()
    .then(count => console.log('Player Count:', count))
    .catch(error => console.error('Error:', error));

server.getserverdata('resources').then(resources) {
  console.log(resources)
}

// and so on...

Functions

  • getPlayers(): Retrieves information about all players on the server.
  • getPlayerCount(): Retrieves the total number of players currently connected to the server.
  • getserverdata(key: string): Retrieves specific server data based on the provided key (e.g., 'resources').
  • getservervariable(key: string): Retrieves specific server variables based on the provided key.
  • getServerResources(): Retrieves information about server resources.
  • sendCommand(command: string): Sends a command to the server via RCON.
  • getplayerbyid(id: int): Retrieves player information by player ID.
  • getplayerbyidentifier(identifier: string): Retrieves player information by player identifier.

Contributing

Contributions are welcome! Please fork the repository, make your changes, and submit a pull request.

Issues

If you encounter any issues or have suggestions for improvement, please open an issue.

License

This project is licensed under the MIT License - see the LICENSE file for details.