{"id":26096154,"url":"https://github.com/tfnrp/creditor","last_synced_at":"2026-05-07T00:38:03.904Z","repository":{"id":38989684,"uuid":"442474369","full_name":"TFNRP/creditor","owner":"TFNRP","description":"A creditor system for resources \u0026 files","archived":false,"fork":false,"pushed_at":"2023-03-07T00:23:04.000Z","size":5954,"stargazers_count":1,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-01T11:24:18.152Z","etag":null,"topics":["credits","fivem","javascript","lua","node","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TFNRP.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"TFNRP","patreon":"JustAPaw","ko_fi":"JustAPaw","custom":"https://paypal.me/HagenHyena"}},"created_at":"2021-12-28T13:37:05.000Z","updated_at":"2023-10-07T15:12:23.000Z","dependencies_parsed_at":"2023-01-29T03:46:03.738Z","dependency_job_id":null,"html_url":"https://github.com/TFNRP/creditor","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TFNRP%2Fcreditor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TFNRP%2Fcreditor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TFNRP%2Fcreditor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TFNRP%2Fcreditor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TFNRP","download_url":"https://codeload.github.com/TFNRP/creditor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242705705,"owners_count":20172326,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["credits","fivem","javascript","lua","node","nodejs"],"created_at":"2025-03-09T14:35:29.785Z","updated_at":"2026-05-07T00:38:03.872Z","avatar_url":"https://github.com/TFNRP.png","language":"JavaScript","funding_links":["https://github.com/sponsors/TFNRP","https://patreon.com/JustAPaw","https://ko-fi.com/JustAPaw","https://paypal.me/HagenHyena"],"categories":[],"sub_categories":[],"readme":"# PMARP Creditor\n\nAn 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.  \nYou can see a preview [here](https://tfnrp.github.io/creditor/html/index.html).\n\n## Installation\n\nWith npm\n\n```sh-session\nnpm install @pmarp/creditor --global\n```\n\n## Usage\n\nIn 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`.\n\n```sh-session\ncreditor --output ./credits.json\n```\n\n## Example\n\n### Fx Manifest\n\nSimply add appropriate [manifest entries](#manifest-entries) to your resource's [`fxmanifest.lua`](https://docs.fivem.net/docs/scripting-reference/resource-manifest/resource-manifest).  \nThese entries will be read by the creditor and added to the credits.\n\n[Example](https://github.com/TFNRP/creditor/blob/main/test/fxmanifest.lua)\n[Preview](https://tfnrp.github.io/creditor/html/index.html#test)\n```lua\n-- fxmanifest.lua\nfx_version 'cerulean'\ngame 'gta5'\n\nrepository 'https://github.com/TFNRP/holster'\nversion '0.1.0'\nauthor 'Reece Stokes \u003chagen@hyena.gay\u003e'\ndescription 'Holster resource for FiveM'\n```\n\n### Custom YAML\n\nThe creditor is not limited to just `fxmanifest.lua`s and will also read any [YAML file](https://yaml.org) with the name `manifest.yaml`.  \nThis allows you to place credit files in places that should not be registered by your fxserver.  \nA 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 \u0026 folders.\n\n[Example](https://github.com/TFNRP/creditor/blob/main/test/manifest.yaml)  \n[Preview](https://tfnrp.github.io/creditor/html/index.html#Idea%20\u0026%20Concept)\n```yaml\n# manifest.yaml\nname: Idea \u0026 Concept\nauthor: glitchdetector\ndescription: Special thanks to glitchdetector.\nrepository: https://github.com/glitchdetector/fx-credits\n```\n\n## Manifest Entries\n\n[200]: https://img.icons8.com/color/24/000000/checked-2--v1.png \"Yes\"\n[400]: https://img.icons8.com/color/24/000000/close-window.png \"No\"\n\nEntry | Description | Optional | Default | Example\n-- | -- | -- | :--: | --\n`id`          | This resource's name / id of this credit.                                                                  | ![yes][200] | Resource's name | `'mrpd'`\n`name`        | The name to display this credit as.                                                                        | ![yes][200] | id              | `'Mission Row PD'`\n`contact`     | An email address to contact the author. This field will be autofilled if an email is supplied in `author`. | ![yes][200] | `nil`           | `'hagendetector@gmail.com'`\n`author`      | The author's name. May also contain an email address encased in fat brackets.                              | ![no][400]  | `nil`           | `'Hagen Hyena \u003chagendetector@gmail.com\u003e'`\n`version`     | The version of this software, if any.                                                                      | ![yes][200] | `nil`           | `'1.0.0'`\n`description` | The description of this resource/credit.                                                                   | ![yes][200] | `nil`           | `'This resource populates dynamic vehicles in ped traffic.'`\n`gta5mods`    | The resource's [gta5-mods](https://gta5-mods.com) post.                                                    | ![yes][200] | `nil`           | `'https://www.gta5-mods.com/vehicles/brute-mr-tasty-gta-iv-style-add-on-liveries-template-sound-custom-shards'`\n`repository`  | The resource's GitHub or GitLab repository.                                                                | ![yes][200] | `nil`           | `'https://github.com/TFNRP/axonbody3'`\n`download`    | Miscellaneous download URL if no `repository` or `gta5mods` is available.                                  | ![yes][200] | `nil`           | `'https://forum.cfx.re/t/release-modern-seatbelt/4779995'`\n`private`     | Whether this resource is closed-source.                                                                    | ![yes][200] | `false`         | `'true'`\n\n## Command-Line Arguments\n\nArgument | Shorthand | Optional | Default | Description | Example\n-- | -- | -- | -- | -- | --\n`--output` | `-o` | ![no][400] | | Where the output credits json file should go. | `--output ./generated` or `--output ./credits.json`\n`--directory` | `-d` | ![yes][200] | Current directory | The directory to recursively scan for manifests. | `--directory ./resources`\n\n## Credits\n\nSpecial thanks to [glitchdetector](https://github.com/glitchdetector) for the idea, concept and his original [fx-credits](https://github.com/glitchdetector/fx-credits).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfnrp%2Fcreditor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftfnrp%2Fcreditor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftfnrp%2Fcreditor/lists"}