{"id":20690568,"url":"https://github.com/notmyself/rocksmith-plus-tools","last_synced_at":"2025-09-27T06:30:34.288Z","repository":{"id":208516371,"uuid":"558967184","full_name":"NotMyself/rocksmith-plus-tools","owner":"NotMyself","description":"A set of tools for Rocksmith+","archived":false,"fork":false,"pushed_at":"2023-11-21T21:44:34.000Z","size":64,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-16T23:13:33.237Z","etag":null,"topics":["beginner","codespaces","codespaces-friendly","hacktoberfest","javascript","learn","nodejs","rocksmith"],"latest_commit_sha":null,"homepage":"https://iamnotmyself.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NotMyself.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-10-28T17:51:31.000Z","updated_at":"2024-07-07T02:00:16.000Z","dependencies_parsed_at":"2023-11-21T22:42:01.371Z","dependency_job_id":null,"html_url":"https://github.com/NotMyself/rocksmith-plus-tools","commit_stats":null,"previous_names":["notmyself/rocksmith-plus-tools"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotMyself%2Frocksmith-plus-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotMyself%2Frocksmith-plus-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotMyself%2Frocksmith-plus-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotMyself%2Frocksmith-plus-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotMyself","download_url":"https://codeload.github.com/NotMyself/rocksmith-plus-tools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234399312,"owners_count":18826069,"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":["beginner","codespaces","codespaces-friendly","hacktoberfest","javascript","learn","nodejs","rocksmith"],"created_at":"2024-11-16T23:13:36.620Z","updated_at":"2025-09-27T06:30:33.827Z","avatar_url":"https://github.com/NotMyself.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rocksmith+ Tools\n\n[![All Contributors](https://img.shields.io/github/all-contributors/NotMyself/rocksmith-plus-tools?color=ee8449\u0026style=flat-square)](#contributors)\n\nA set of tools for Rocksmith+\n\n## Getting Started\n\nThis project contains [Development Containers](https://containers.dev/) definitions and is intended to be worked on using development containers. This ensures you have all the tools needed to build and run these tools available in the development environment. \n\nDeveloment Containers can be run both [locally](#running-locally) or via [GitHub Codespaces](#running-in-codespaces).\n\n### Environment Variables\n\nThis project uses dotenv to externalize strings that might change or are secret and should not be commited to source control. The file **sample.env** contains the required variables along with default values. If the value is a secret it is left blank and must be populated before the code runs.\n\nTo use the default values, write them to a .env file located at the root of the workspace using this command:\n\n```bash\ncat sample.env \u003e ./.env\n```\n\n### NPM Scripts\n\nCurrently, the tools are run via npm scripts. The following table lists the available commands.\n\n| \u003cdiv style=\"width:130px\"\u003eCommand\u003c/div\u003e | \u003cdiv style=\"width:100px\"\u003eDebug Menu\u003c/div\u003e | Purpose |\n|---|---|---|\n|npm run data:clean| N/A | Removes the `./data` and `./logs` directories.|\n| npm run data:refresh | Refresh Data | Fetches a list of genres and all associated songs. Then writes them to the `./data` directory. |\n\n**Note:** Direct CLI commands can be run in the container using the VSCode by hitting **CMD+`** to bring up the terminal.\n\n**Note:** The code can be run in a debugger, but selecting the debug menu name from the Run and Debug menu in VSCode.\n\n## Running in CodeSpaces\n\n1. [Fork the repository](https://github.com/NotMyself/rocksmith-plus-tools/fork) to your GitHub account.\n1. Click the green **Code** dropdown button.\n1. Select the **Codespaces** tab.\n1. Click the green **Create codespace on main** button.\n\n## Running Locally\n\n1. Ensure your system meets the [requirements](#requirements).\n1. Ensure Docker for Desktop is running.\n1. Clone the repository: `git clone git@github.com:NotMyself/rocksmith-plus-tools.git`.\n1. Change directory into the cloned repository `cd rocksmith-plus-tools`.\n1. Open the project in VSCode `code-insiders .` or `code .` depending on what version you chose to install.\n1. When prompted, select the **Reopen in Container** option.\n\n\u003cp align=\"center\"\u003e\n\u003cimg width=\"300px\" src=\"https://github.com/NotMyself/rocksmith-plus-tools/blob/main/docs/reopen-in-container.dialog.png?raw=true\" /\u003e\n\u003c/p\u003e\n\n### Requirements\n1. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)\n1. Install [VSCode](https://code.visualstudio.com/), the [Insiders Edition](https://code.visualstudio.com/insiders) is highly recommended.\n1. Install [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for VSCode\n\n## Contributing\n\nWant to contribute? Check out our [Code of Conduct](./docs/CODE_OF_CONDUCT.md) and [Contributing](./docs/CONTRIBUTING.md) docs. This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\nThere are many topics yet to be covered by this set of koans. I have added a handful of needed topics as [issues](https://github.com/NotMyself/rocksmith-plus-tools/issues) and tagged them as [Up for Grabs](https://github.com/NotMyself/rocksmith-plus-tools/issues?q=is%3Aopen+is%3Aissue+label%3A%22Up+for+Grabs%22). There are even some specifically tagged as [Beginner Friendly](https://github.com/NotMyself/rocksmith-plus-tools/issues?q=is%3Aopen+is%3Aissue+label%3A%22Beginner+Friendly%22).\n\nIf you have never contributed to an open source project, let those be your first. I promise to work with you to get your contribution into the repository and be friendly and encouraging about it. It is what Jim would have done.\n\nIf you think a topic is missing, propose it's inclusion by [submitting an issue](https://github.com/NotMyself/rocksmith-plus-tools/issues/new) yourself. Or better yet submit the issue and an accompanying pull request with how you think the topic should be introduced. Think about beginners in your effort; be clear and informative, be concise and most of all be playful with your examples.\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://iamnotmyself.com\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/73120?v=4?s=100\" width=\"100px;\" alt=\"Bobby Johnson\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eBobby Johnson\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#code-NotMyself\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#doc-NotMyself\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#bug-NotMyself\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotmyself%2Frocksmith-plus-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotmyself%2Frocksmith-plus-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotmyself%2Frocksmith-plus-tools/lists"}