This repository implements the chip8 emulator
For more details on the implementation can be found in this github page
Whether you're an experienced emulator developer or just getting started with low-level systems, your help is invaluable for learning and exploring the world of Chip-8.
-
Chip-8 Game Examples: We welcome contributions of new or interesting Chip-8 game examples. If you've found a classic gem or created your own, please share it! When contributing game examples: Include the ROM file.
- Provide a brief description of the game.
- Indicate any specific Chip-8 features or quirks it might rely on.
- Mention the recommended Chip-8 variant (standard, Super-Chip, XO-Chip, etc.) or indicate if it's compatible with all of them.
-
Chip-8 Variant Extensions: Do you have an implementation of a lesser-known Chip-8 variant or an extension that adds new instructions or features? We'd love to see it integrated!
- Clearly document the new instructions or changes to existing ones.
- Explain the motivation behind the extension.
- Provide test cases or game examples that utilize your variant's unique capabilities.
-
Feature Requests: If you have an idea for a new feature, a helpful improvement, or an enhancement that could benefit the project, feel free to open a new issue and suggest it.
- Describe the feature you'd like to see added.
- Explain why you think it would be valuable.
- Provide a clear and concise title for the issue.
-
Reporting Issues: If you encounter any bugs, glitches, or unexpected behavior in the emulator or with specific games, please help us by reporting a new issue.
- Before creating an issue, search existing issues to see if your bug has already been reported.
- Provide a clear and concise title that summarizes the issue.
- Include a detailed description, including steps to reproduce the bug.
- Mention the Chip-8 variant you were using (if applicable) and any relevant system information.
-
Fork the repository: Start by forking this repository to your GitHub account.
-
Clone your fork locally: Clone your forked repository to your local machine using the command: git clone https://github.com/YOUR-USERNAME/YOUR-PROJECT-NAME.git.
-
Add the upstream remote: To keep your fork in sync with the original project, add the original project as the "upstream" remote: git remote add upstream https://github.com/original-project-username/project-name.git.
-
Create a new branch: Create a new branch for your contributions to keep things organized: git checkout -b your-branch-name.
-
Make your changes: Implement your feature, fix the bug, or add the new game example, following existing code style and conventions.
-
Commit your changes: Stage your changes with git add . and commit them with a clear and concise message: git commit -m "Description of changes".
-
Push your changes to your fork: Push your branch to your forked repository on GitHub: git push origin your-branch-name.
-
Open a pull request: On the GitHub page of your fork, click "Compare & pull request" and create a pull request (PR). Make sure to:
- Provide a clear title for your PR.
- Describe the changes you've made and the reasoning behind them.
- Link to any related issues by including the issue number (e.g., #123).
- If your PR addresses a bug or closes an issue, include a line like Fixes #.
-
Engage with feedback: Project maintainers may review your PR and provide feedback. Be receptive to suggestions and make any necessary adjustments.
-
Your contribution is merged! Once your pull request is approved, your changes will be merged into the main project.
To ensure a positive and inclusive environment, please adhere to our Code of Conduct.
- Smaller, focused pull requests are generally easier and faster to review.
- Follow the existing coding style and conventions of the project.
- Include tests for new features or bug fixes whenever possible.
- Document your changes with comments or by updating existing guides.