Full Code of tobiasvl/awesome-chip-8 for AI

Repository: tobiasvl/awesome-chip-8
Branch: main
Commit: 62cec4b6bee2
Files: 3
Total size: 16.4 KB

Directory structure:
gitextract_5dmbv1of/

├── CONTRIBUTING.md
├── LICENSE
└── README.md

================================================
FILE CONTENTS
================================================

================================================
FILE: CONTRIBUTING.md
================================================
# Contribution guidelines

## Rules for new entries

* One entry per pull request.
* Add an entry to the bottom of the list, in the relevant category.
* Each entry should consist of a link and a description.
* Please state in the pull request description why you think the resource is awesome. Even better, in the description itself.

## What is "awesome"?

This is a curated list, not a complete list of everything related to CHIP-8. If you think it's awesome, then by all means, open a pull request and add it! If I disagree, we can talk about it.

Here are some criteria that I personally think determines "awesomeness" for something related to CHIP-8. Consider them as guidelines, not hard rules. The guidelines are also up for discussion.

### Documentation

**Documentation and guides should preferably acknowledge the different "quirks" or behavioral differences between CHIP-8 implementations.**

This means that the well-known [Cowgod's Technical Reference](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM), while detailed, is not "awesome" because it describes behavior that is incompatible with original CHIP-8 games for the COSMAC VIP. In fact, this list was started in part because I started looking for guides and references that were more accurate than Cowgod's.

### Emulators

**An "awesome" emulator/interpreter does something unique.**

This could include, but is not limited to:

* running on a unique system (a CHIP-8 emulator running on a SNES is definitely awesome)
* providing stand-out debugging capabilities
* being compatible with a wide range of CHIP-8 programs (ie. providing "quirk" settings or similar)
* being written in a unique language
* supporting the XO-CHIP extension or other "rare" interpreter specifications

This is, again, not an exhaustive list. However, there are a _lot_ of CHIP-8 emulators/interpreters out there, and we can't possibly include them all.

### Games

**Any CHIP-8 game is awesome!**

Games that are compatible with all emulators (ie. by circumventing "quirky" behavior) or state what quirks they require are especially awesome.


================================================
FILE: LICENSE
================================================
CC0 1.0 Universal

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

  i. the right to reproduce, adapt, distribute, perform, display,
     communicate, and translate a Work;
 ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
     likeness depicted in a Work;
 iv. rights protecting against unfair competition in regards to a Work,
     subject to the limitations in paragraph 4(a), below;
  v. rights protecting the extraction, dissemination, use and reuse of data
     in a Work;
 vi. database rights (such as those arising under Directive 96/9/EC of the
     European Parliament and of the Council of 11 March 1996 on the legal
     protection of databases, and under any national implementation
     thereof, including any amended or successor version of such
     directive); and
vii. other similar, equivalent or corresponding rights throughout the
     world based on applicable law or treaty, and any national
     implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

 a. No trademark or patent rights held by Affirmer are waived, abandoned,
    surrendered, licensed or otherwise affected by this document.
 b. Affirmer offers the Work as-is and makes no representations or
    warranties of any kind concerning the Work, express, implied,
    statutory or otherwise, including without limitation warranties of
    title, merchantability, fitness for a particular purpose, non
    infringement, or the absence of latent or other defects, accuracy, or
    the present or absence of errors, whether or not discoverable, all to
    the greatest extent permissible under applicable law.
 c. Affirmer disclaims responsibility for clearing rights of other persons
    that may apply to the Work or any use thereof, including without
    limitation any person's Copyright and Related Rights in the Work.
    Further, Affirmer disclaims responsibility for obtaining any necessary
    consents, permissions or other rights required for any use of the
    Work.
 d. Affirmer understands and acknowledges that Creative Commons is not a
    party to this document and has no duty or obligation with respect to
    this CC0 or use of the Work.


================================================
FILE: README.md
================================================
# Awesome CHIP-8 [![Awesome](https://awesome.re/badge-flat.svg)](https://awesome.re)

[<img src="c8.png" align="right" width="100">](https://chip-8.github.io)

> Virtual computer game machine from the 70s 

A curated list of awesome CHIP-8 resources, tools, documentation, related projects and open source ROMs.

Created in 1977, [CHIP-8](https://en.wikipedia.org/wiki/CHIP-8) is the original fantasy console. Initially designed to ease game development for the COSMAC VIP kit computer, it has enjoyed several revivals over the decades for new and exciting platforms. Today, creating a CHIP-8 implementation is a rite of passage for anyone interested in learning about emulation.

To add something to this list, please see the [contribution guidelines](CONTRIBUTING.md).

## Contents

* [Community](#community)
* [Documentation](#documentation)
* [Emulator/interpreter development](#emulatorinterpreter-development)
  * [Testing](#testing)
* [Emulators/interpreters](#emulatorsinterpreters)
* [Software development](#software-development)
  * [Tools](#tools)
  * [Guides and snippets](#guides-and-snippets)
  * [Postmortems](#postmortems)
* [Games](#games)

## Community

* [COSMAC Elf Group](https://groups.io/g/cosmacelf) - Group for discussion of the COSMAC Elf, as well as anything else RCA 1802-related, including COSMAC VIP and CHIP-8.
* [#chip8 channel on the Emulation Development Discord server](https://discordapp.com/invite/Gf7cP3w) - Chat for discussing development of CHIP-8 emulators/interpreters.
* [OctoJam](http://octojam.com/) - An Octo-centric game jam held every October.

## Documentation

* [Mastering CHIP-8](https://github.com/mattmikolay/chip-8/wiki/Mastering-CHIP%E2%80%908) - In-depth overview of the CHIP-8 instruction set.
* [CHIP-8 Instruction Set](http://johnearnest.github.io/Octo/docs/chip8ref.pdf) - Quick cheat sheet for CHIP-8 instructions.
* [CHIP-8 Instruction Set](https://github.com/mattmikolay/chip-8/wiki/CHIP%E2%80%908-Instruction-Set) - A comprehensive instruction/opcode table.
* [CHIP-8 Technical Reference](https://github.com/mattmikolay/chip-8/wiki/CHIP%E2%80%908-Technical-Reference) - Overview of how the CHIP-8 interpreter works.
* [CHIP-8 Extensions Reference](https://github.com/mattmikolay/chip-8/wiki/CHIP%E2%80%908-Extensions-Reference) - A list of CHIP-8 variants and extensions.
* [Chip-8 on the COSMAC VIP](https://laurencescotford.com/chip-8-on-the-cosmac-vip-index/) - An in-depth disassembly and analysis of the original CHIP-8 interpreter on the COSMAC VIP.
* [HP48-Superchip](https://github.com/Chromatophore/HP48-Superchip) - An in-depth look at CHIP48 and Super-CHIP for the HP48 calculators, and modifications to make them CHIP-8 compatible.
* [Octo Extensions](http://johnearnest.github.io/Octo/docs/XO-ChipSpecification.html) - Specification for Octo's XO-CHIP extension.

## Emulator/interpreter development

* [How to write an emulator (CHIP-8 interpreter)](http://www.multigesture.net/articles/how-to-write-an-emulator-chip-8-interpreter/) - A guide to developing a CHIP-8 interpreter in C/C++.
* [Emulator 101: CHIP-8](http://www.emulator101.com/introduction-to-chip-8.html) - A guide to developing a CHIP-8 disassembler and interpreter in C.
* [Chip 8 Instruction Scheduling and Frequency](https://jackson-s.me/2019/07/13/Chip-8-Instruction-Scheduling-and-Frequency.html) - Timing of CHIP-8 instructions on the COSMAC VIP.
* [High-level guide to making a CHIP-8 emulator](https://tobiasvl.github.io/blog/write-a-chip-8-emulator/) - A guide for developing a CHIP-8 interpreter, without code.

### Testing

* [chip8-test-rom](https://github.com/corax89/chip8-test-rom) - corax89's CHIP-8 test program, which tests most instructions for correct (Super-CHIP compliant) behavior.
* [CHIP-8 test suite](https://github.com/Timendus/chip8-test-suite) - Timendus' collection of tests, including an improved version of corax89's test rom, a test for the behaviour of the flags and a CHIP-8 / Super-CHIP / XO-CHIP quirks test.
* [Delay timer test](https://github.com/mattmikolay/chip-8/tree/master/delaytimer) - Test program that checks the delay timer's behavior.
* [Random number test](https://github.com/mattmikolay/chip-8/tree/master/randomnumber) - Test program that checks the spread and mask for random number generation.

## Emulators/interpreters

* [Octo](http://johnearnest.github.io/Octo/) - An IDE for development of CHIP-8, Super-CHIP and XO-Chip games.
* [Emma02](https://www.emma02.hobby-site.com/) - An emulator for many old microcomputers, including COSMAC VIP, Telmac 1800 and ETI 660, which ran early CHIP-8 interpreters (which are included in the emulator).
* [Super-Chip8x](https://github.com/Ersanio/Super-Chip8x) - CHIP-8 emulator for the SNES.
* [CHIP-8 console on FPGA](https://github.com/pwmarcz/fpga-chip8) - A CHIP-8 emulator for the TinyFPGA BX chip.
* [Vinegar](http://benryves.com/bin/vinegar/) - CHIP-8/Super-CHIP interpreter for TI-83 (Plus) calculators.
* [LowResNX](https://lowresnx.inutilis.com/topic.php?id=1648) - CHIP-8 interpreter and debugger programmed in BASIC inside another retro fantasy console.

## Software development

### Tools

* [Octo](http://github.com/johnearnest/Octo/) - A high-level assembler for CHIP-8, Super-CHIP and XO-CHIP, complete with an environment for testing programs, and tools for sharing your creations.
* [wernsey chip8](https://github.com/wernsey/chip8) - A CHIP-8 assembler/disassembler.
* [EZ-Bake Animator](http://beyondloom.com/tools/ezbake.html) - A graphics preparation tool that creates XOR-ed animations.
* [EZ-Writer](http://beyondloom.com/tools/ezwriter.html) - A tool for converting text into CHIP-8 sprites.
* [EZ-Pack](http://beyondloom.com/tools/ezpack.html) - An image slicing/repaletting tool.
* [Chipify](http://johnearnest.github.io/Octo/tools/Chipify/) - A script that filters and encodes mono-channel WAV audio to XO-CHIP audio.
* [octofont](https://github.com/jdeeny/octofont/) - Convert TrueType (ttf) fonts to Octo code for CHIP-8.

### Guides and snippets

* [Octo manual](https://johnearnest.github.io/Octo/docs/Manual.html) - The manual for Octo.
* [A Beginner's Guide to Programming with Chip8](http://johnearnest.github.io/Octo/docs/BeginnersGuide.html) - An introductory guide to CHIP-8 programming in Octo.
* [An Intermediate Guide to Game Development with Chip8](http://johnearnest.github.io/Octo/docs/IntermediateGuide.html) - Remaking the Atari 2600 game "Outlaw" for CHIP-8 in Octo.
* [Chip8 Programming Techniques](http://johnearnest.github.io/Octo/docs/Chip8%20Programming.html) - Many different programming tips for CHIP-8.
* [Octo Metaprogramming Cookbook](http://johnearnest.github.io/Octo/docs/MetaProgramming.html) - How to use Octo's assembly directives for meta-programming.
* [Mastering SuperChip](http://johnearnest.github.io/Octo/docs/SuperChip.html) - How to make games compatible with CHIP-8 and Super-CHIP, as well as some Super-CHIP specific techniques.
* [Adventures in Sorting](https://johnearnest.github.io/Octo/docs/Sorting.html) - Implementing efficient sorting algorithms in Octo for CHIP-8.
* [chip8-multiply](https://github.com/jdeeny/chip8-multiply) - Multiplication routines for CHIP-8, written in Octo.

### Postmortems

Postmortems detailing the development of specific games, written by the developers.

* [Inside Eaty the Alien](http://johnearnest.github.io/Octo/docs/EatyTheAlien.html)
* [Octopeg Post Mortem](http://www.awfuljams.com/octojam-ii/games/octopeg)
* [CosmacCalc: The COSMAC VIP's place in Spreadsheet History](https://abitoutofplace.wordpress.com/2015/05/02/cosmaccalc-the-cosmac-vip-s-place-in-spreadsheet-history/)
* [Inside Cave Explorer](http://johnearnest.github.io/Octo/docs/CaveExplorer.html)
* [Inside Black Rainbow](http://johnearnest.github.io/Octo/docs/BlackRainbow.html)
* [Postmortem: Mini Lights Out](https://tobiasvl.itch.io/mini-lights-out/devlog/102679/postmortem-mini-lights-out)

## Games

* [CHIP-8 Archive](https://johnearnest.github.io/chip8Archive/) - A collection of public domain (CC0) games, all playable online.
* [A collection of CHIP-8 programs and documentation](https://github.com/mattmikolay/chip-8) - Matt Mikolay's games, programs and documentation.