Rocksmith+ Tools

A set of tools for Rocksmith+

Getting Started

This project contains Development Containers 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.

Develoment Containers can be run both locally or via GitHub Codespaces.

Environment Variables

This 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.

To use the default values, write them to a .env file located at the root of the workspace using this command:

cat sample.env > ./.env

NPM Scripts

Currently, the tools are run via npm scripts. The following table lists the available commands.

Command	Debug Menu	Purpose
npm run data:clean	N/A	Removes the ./data and ./logs directories.
npm run data:refresh	Refresh Data	Fetches a list of genres and all associated songs. Then writes them to the ./data directory.

Note: Direct CLI commands can be run in the container using the VSCode by hitting CMD+` to bring up the terminal.

Note: The code can be run in a debugger, but selecting the debug menu name from the Run and Debug menu in VSCode.

Running in CodeSpaces

1. Fork the repository to your GitHub account.
2. Click the green Code dropdown button.
3. Select the Codespaces tab.
4. Click the green Create codespace on main button.

Running Locally

1. Ensure your system meets the requirements.
2. Ensure Docker for Desktop is running.
3. Clone the repository: git clone [email protected]:NotMyself/rocksmith-plus-tools.git.
4. Change directory into the cloned repository cd rocksmith-plus-tools.
5. Open the project in VSCode code-insiders . or code . depending on what version you chose to install.
6. When prompted, select the Reopen in Container option.

Requirements

1. Install Docker Desktop
2. Install VSCode, the Insiders Edition is highly recommended.
3. Install Dev Containers extension for VSCode

Contributing

Want to contribute? Check out our Code of Conduct and Contributing docs. This project follows the all-contributors specification. Contributions of any kind welcome!

There are many topics yet to be covered by this set of koans. I have added a handful of needed topics as issues and tagged them as Up for Grabs. There are even some specifically tagged as Beginner Friendly.

If 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.

If you think a topic is missing, propose it's inclusion by submitting an issue 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.

Contributors

Thanks goes to these wonderful people (emoji key):

Bobby Johnson 💻 📖 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!