V2.0.0

.github/workflows/pr-test.yml

@@ -30,6 +30,11 @@ jobs:
         pip install --upgrade pip
         pip install --upgrade wheel setuptools
         pip install --prefer-binary -r requirements.txt
+        pip install --prefer-binary -r requirements_tests.txt
+    - name: Doctest
+      if: ${{ !contains(matrix.os, 'windows') }}
+      run: |
+        python -m pytest pyboy/ -n auto
     - name: Build PyBoy
       run: |
         python setup.py build_ext -j $(getconf _NPROCESSORS_ONLN) --inplace
@@ -44,9 +49,7 @@ jobs:
         TEST_CI: 1
         TEST_NO_UI: 1
       run: |
-        pip install --upgrade pip
-        pip install --prefer-binary -r requirements_tests.txt
-        python -m pytest tests/ -n2 -v
+        python -m pytest tests/ -n auto -v
     - name: Build and upload wheel
       if: ${{ github.event_name == 'release' && github.event.action == 'published' && !github.event.release.prerelease && !contains(matrix.os, 'ubuntu') }}
       run: |
@@ -98,15 +101,19 @@ jobs:
         pypy3 -m ensurepip
         pypy3 -m pip install --upgrade pip
         pypy3 -m pip install wheel
+        pypy3 -m pip install --prefer-binary -r requirements.txt
+        pypy3 -m pip install --prefer-binary -r requirements_tests.txt
+    - name: Doctest
+      if: ${{ !contains(matrix.os, 'windows') }}
+      run: |
+        pypy3 -m pytest pyboy/ -n auto
     - name: Run PyTest
       env:
         PYTEST_SECRETS_KEY: ${{ secrets.PYTEST_SECRETS_KEY }}
         TEST_CI: 1
         TEST_NO_UI: 1
       run: |
-        pip install --upgrade pip
-        pypy3 -m pip install --prefer-binary -r requirements_tests.txt
-        pypy3 -m pytest tests/ -n2 -v
+        pypy3 -m pytest tests/ -n auto -v
 
   test_manylinux:
     name: ManyLinux - Build, Test and Deploy

.gitignore

@@ -1,3 +1,6 @@
+# macOS
+.DS_Store
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -38,11 +41,6 @@ docs/_build/
 # PyBuilder
 target/
 
-.DS_Store
-Report/*.pdf
-Report/*.aux
-Report/*.log
-
 # Don't want to see any ROMs being uploaded
 # This project is not for pirating games!
 *.gb
@@ -64,6 +62,7 @@ test_data.encrypted
 tetris/
 PyBoy-RL/
 
+# Cython
 /pyboy/**/*.c
 /pyboy/**/*.h
 /pyboy/**/*.html
@@ -80,29 +79,22 @@ PyBoy-RL/
 /site-packages
 /share
 
-# LaTeX files
-Projects/Projects.aux
-Projects/Projects.bbl
-Projects/Projects.blg
-Projects/Projects.out
-Projects/Projects.log
-
-bootrom/bootrom*.map
-bootrom/bootrom*.obj
-bootrom/bootrom*.sym
-bootrom/bootrom*.gb
-bootrom/logo.asm
-bootrom/pyboy.png
-bootrom/PYBOY_ROM.bin
+# Bootrom
+extras/bootrom/bootrom*.map
+extras/bootrom/bootrom*.obj
+extras/bootrom/bootrom*.gb
+extras/bootrom/logo.asm
 
-default_rom/default_rom.map
-default_rom/default_rom.obj
-default_rom/default_rom.sym
-!default_rom.gb
+extras/default_rom/default_rom*.map
+extras/default_rom/default_rom*.obj
+!default_rom*.gb
+extras/default_rom/default_rom.gb
+extras/default_rom/default_rom_cgb.gb
 
 test.replay
 
 /mooneye/
 /blargg/
 /GB Tests/
-/SameSuite/
+/SameSuite/
+.vscode/

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-exclude: opcodes.py
+exclude: (opcodes.py|manager.py|manager.pxd)
 repos:
 - repo: https://github.com/myint/unify
   rev: v0.5

CONTRIBUTING.md

@@ -3,7 +3,7 @@ Any contribution is appreciated. The currently known errors are registered in th
 For the more major features, there are the following that you can give a try. They are also described in more detail in the [project list](https://github.com/Baekalfen/PyBoy/raw/master/extras/Projects/Projects.pdf):
 * Color
 * Link Cable
-* _(Experimental)_ AI - use the `botsupport` or game wrappers to train a neural network
+* _(Experimental)_ AI - use the API or game wrappers to train a neural network
 * _(Experimental)_ Game Wrappers - make wrappers for popular games
 
 If you want to implement something which is not on the list, feel free to do so anyway. If you want to merge it into our repo, then just send a pull request and we will have a look at it.

Makefile

@@ -28,10 +28,14 @@ codecov: clean
 
 build:
 	@echo "Building..."
+	cd ${ROOT_DIR}/extras/default_rom && $(MAKE)
+	cd ${ROOT_DIR}/extras/bootrom && $(MAKE)
 	CFLAGS=$(CFLAGS) ${PY} setup.py build_ext -j $(shell getconf _NPROCESSORS_ONLN) --inplace
 
 clean:
 	@echo "Cleaning..."
+	cd ${ROOT_DIR}/extras/default_rom && $(MAKE) clean
+	cd ${ROOT_DIR}/extras/bootrom && $(MAKE) clean
 	rm -rf PyBoy.egg-info
 	rm -rf build
 	rm -rf dist
@@ -60,13 +64,16 @@ uninstall:
 	${PY} -m pip uninstall pyboy
 
 test: export DEBUG=1
-test: clean build test_cython test_pypy
+test: clean test_pypy test_cpython_doctest build test_cython
+
+test_cpython_doctest:
+	${PY} -m pytest pyboy/ -n auto -v
 
 test_cython:
-	${PY} -m pytest tests/ -n4 -v
+	${PY} -m pytest tests/ -n auto -v
 
 test_pypy:
-	${PYPY} -m pytest tests/ -n4 -v
+	${PYPY} -m pytest tests/ pyboy/ -n auto -v
 
 test_all: test