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

@pmarp/creditor

v0.3.0

Published

A creditor system for resources & files

Downloads

5

Readme

PMARP Creditor

An easy to use command-line interface for building creditory information from resource manifests, with the added feature of custom manifest.yaml files that can be ignored by the fxserver.
You can see a preview here.

Installation

With npm

npm install @pmarp/creditor --global

Usage

In shell at the directory of your server's resources, search through all directories for fxmanifest.lua, __resource.lua and custom manifest.yaml files and output the result to a file credits.json.

creditor --output ./credits.json

Example

Fx Manifest

Simply add appropriate manifest entries to your resource's fxmanifest.lua.
These entries will be read by the creditor and added to the credits.

Example Preview

-- fxmanifest.lua
fx_version 'cerulean'
game 'gta5'

repository 'https://github.com/TFNRP/holster'
version '0.1.0'
author 'Reece Stokes <[email protected]>'
description 'Holster resource for FiveM'

Custom YAML

The creditor is not limited to just fxmanifest.luas and will also read any YAML file with the name manifest.yaml.
This allows you to place credit files in places that should not be registered by your fxserver.
A particular good use-case can be for resources containing multiple resources, and can be added to the resource's meta directory for crediting of individual files & folders.

Example
Preview

# manifest.yaml
name: Idea & Concept
author: glitchdetector
description: Special thanks to glitchdetector.
repository: https://github.com/glitchdetector/fx-credits

Manifest Entries

Entry | Description | Optional | Default | Example -- | -- | -- | :--: | -- id | This resource's name / id of this credit. | yes | Resource's name | 'mrpd' name | The name to display this credit as. | yes | id | 'Mission Row PD' contact | An email address to contact the author. This field will be autofilled if an email is supplied in author. | yes | nil | '[email protected]' author | The author's name. May also contain an email address encased in fat brackets. | no | nil | 'Hagen Hyena <[email protected]>' version | The version of this software, if any. | yes | nil | '1.0.0' description | The description of this resource/credit. | yes | nil | 'This resource populates dynamic vehicles in ped traffic.' gta5mods | The resource's gta5-mods post. | yes | nil | 'https://www.gta5-mods.com/vehicles/brute-mr-tasty-gta-iv-style-add-on-liveries-template-sound-custom-shards' repository | The resource's GitHub or GitLab repository. | yes | nil | 'https://github.com/TFNRP/axonbody3' download | Miscellaneous download URL if no repository or gta5mods is available. | yes | nil | 'https://forum.cfx.re/t/release-modern-seatbelt/4779995'

Command-Line Arguments

Argument | Shorthand | Optional | Default | Description | Example -- | -- | -- | -- | -- | -- --output | -o | no | | Where the output credits json file should go. | --output ./generated or --output ./credits.json --directory | -d | yes | Current directory | The directory to recursively scan for manifests. | --directory ./resources

Credits

Special thanks to glitchdetector for the idea, concept and his original fx-credits.