Skip to content

Baekalfen/PyBoy-AutoPause

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PyBoy-AutoPause Plugin

WARNING: This depends on the unmerged code in Baekalfen/PyBoy#233

If you have any questions, or just want to chat, join us on Discord.

This is a very simple example of creating a plugin for PyBoy. It contains the boilerplate code necessary to create, build and register the plugin.

Steps to create a plugin:

  1. Fork this repo, or copy the files.
  2. Rename the auto_pause.py/.pxd file to your plugin name.
  3. Rename the AutoPause class in the .py and .pxd files to your plugin class.
  4. Add your plugin code. You can see the available methods to override in the PyBoyPlugin class. Or subclass from one of the other plugin types.
  5. Build the code with Cython: python3 setup.py build_ext sdist bdist_wheel or without Cython: python3 setup.py sdist
  6. Install the package: python3 -m pip install dist/*.whl or python3 -m pip install dist/*.tar.gz
  7. Run PyBoy: pyboy ... --autopause

If you don't want to build the plugin with Cython, you can remove the .pxd file and set CYTHONIZE_FILES = [] in the setup.py file.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published