{"id":25330982,"url":"https://github.com/thomascogez/mcpropertiesparser","last_synced_at":"2025-10-29T05:32:12.347Z","repository":{"id":55497145,"uuid":"303109451","full_name":"Thomascogez/mcPropertiesParser","owner":"Thomascogez","description":"A simple, lightweight and type safe .properties file parser that allow to read/edit .properties minecraft 🏹  server files","archived":false,"fork":false,"pushed_at":"2023-03-27T20:33:12.000Z","size":228,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-04T05:16:40.228Z","etag":null,"topics":["mc","minecraft","properties","server"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/mcpropertiesparser","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Thomascogez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-11T11:52:35.000Z","updated_at":"2023-03-27T20:24:27.000Z","dependencies_parsed_at":"2022-08-15T01:50:22.299Z","dependency_job_id":null,"html_url":"https://github.com/Thomascogez/mcPropertiesParser","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thomascogez%2FmcPropertiesParser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thomascogez%2FmcPropertiesParser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thomascogez%2FmcPropertiesParser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thomascogez%2FmcPropertiesParser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Thomascogez","download_url":"https://codeload.github.com/Thomascogez/mcPropertiesParser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238777976,"owners_count":19528818,"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":["mc","minecraft","properties","server"],"created_at":"2025-02-14T03:56:31.877Z","updated_at":"2025-10-29T05:32:11.998Z","avatar_url":"https://github.com/Thomascogez.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mcPropertiesParser\n\n\u003e mcPropertiesParser is a lightweight and typesafe set of utilies to parse and modify .properties file of mc servers\n\n\n\n## Install\n\n```shell\nnpm install mcpropertiesparser\n# or\nyarn add mcpropertiesparser\n```\n\n\n\n## Docs\n\n### parsePropertiesFileToJson\n\n| Name                      | Return                  | Description                                                  |\n| ------------------------- | ----------------------- | ------------------------------------------------------------ |\n| parsePropertiesFileToJson | Promise\u003cPropertiesFile\u003e | parsePropertiesFileToJson allow you to get the json conversion of a .properties file |\n\n#### args\n\n| Parameter      | Type   | Description                           | Required |\n| -------------- | ------ | ------------------------------------- | -------- |\n| propertiesPath | string | path of the .properties file to parse | True     |\n\n#### example\n\n```typescript\nimport {parsedPropertiesFile} from \"mcpropertiesparser\"\nconst parsedPropertiesFile = await parsePropertiesFileToJson(path)\n\n```\n\n\n\n### propertiesFileHasKey\n\n| Name                 | Return  | Description                                       |\n| -------------------- | ------- | ------------------------------------------------- |\n| propertiesFileHasKey | Boolean | Check if a properties file contain a specific key |\n\n#### args\n\n| Parameter      | Type           | Description                     | Required |\n| -------------- | -------------- | ------------------------------- | -------- |\n| propertiesFile | PropertiesFile | properties file object to check | True     |\n| key            | string         | key to check if exist           | True     |\n\n#### example\n\n```typescript\nimport {propertiesFileHasKey} from \"mcpropertiesparser\"\npropertiesFileHasKey(propertiesFile, key)\n\n```\n\n\n\n### writePropertiesFile\n\n| Name                | Return        | Description                                          |\n| ------------------- | ------------- | ---------------------------------------------------- |\n| writePropertiesFile | Promise\u003cvoid\u003e | Write a properties file object as a .properties file |\n\n#### args\n\n| Parameter    | Type           | Description                         | Required |\n| ------------ | -------------- | ----------------------------------- | -------- |\n| *properties* | PropertiesFile | properties file object to check     | True     |\n| path         | string         | path where the file will be written | True     |\n\n#### example\n\n```typescript\nimport {writePropertiesFile} from \"mcpropertiesparser\"\n// it can be the same path from the actual edited file and will replace the old with the new changes\nawait writePropertiesFile(properties, path)\n\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomascogez%2Fmcpropertiesparser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthomascogez%2Fmcpropertiesparser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthomascogez%2Fmcpropertiesparser/lists"}