A frontend for Mupen64Plus
Go to file
Milan Nikolic 90093ce3b3
Merge pull request #228 from GuillaumeMZ/setuptools-69-fix
Fix import error when using setuptools 69 or newer
2023-12-27 00:01:25 +01:00
bin Add excepthook 2021-12-22 14:07:01 +01:00
dist change ocurrences of ChangeLog to CHANGELOG 2023-09-15 09:18:29 -03:00
src/m64py Size game properly even if user doesn't manually resize window 2023-03-12 14:16:26 +00:00
test Initial commit 2012-06-23 16:28:26 +02:00
xdg Don't installing conflicting mime type for *.*64 2014-09-06 09:58:07 +02:00
.gitignore Update gitignore 2023-03-12 14:17:22 +00:00
AUTHORS Fix short url to my contributions 2014-10-18 21:42:40 +02:00
CHANGELOG Update ChangeLog 2020-04-10 14:54:46 +02:00
COPYING Initial commit 2012-06-23 16:28:26 +02:00
LICENSES Update LICENSES 2017-05-08 15:57:23 +02:00
MANIFEST.in Update MANIFEST.in 2020-04-10 15:36:22 +02:00
README.rst Update README.rst 2022-07-30 18:14:31 -04:00
requirements.txt Remove version from requirements 2021-12-22 15:44:05 +01:00
setup.py Fix import error when using setuptools 69 or newer 2023-12-26 20:53:03 +01:00

README.rst

::

                  _____ __ __
       ____ ___  / ___// // / ____  __  __
      / __ `__ \/ __ \/ // /_/ __ \/ / / /
     / / / / / / /_/ /__  __/ /_/ / /_/ /
    /_/ /_/ /_/\____/  /_/ / .___/\__, /
                          /_/    /____/
        http://m64py.sourceforge.net
        A frontend for Mupen64Plus


About
=====

M64Py is a Qt5 front-end (GUI) for Mupen64Plus, a cross-platform
plugin-based Nintendo 64 emulator. Front-end is written in Python and it
provides a user-friendly interface over the Mupen64Plus shared library.

Features
========

* Changeable emulation plugins for audio, core, input, rsp, video
* Selection of emulation core
* Configuration dialogs for core, plugin and input settings
* ROMs list with preview images
* Input bindings configuration
* Cheats support
* Support gzip, bzip2, zip, rar and 7z archives
* Video extension (embedded OpenGL window)

Dependencies
============

* `PyQt5 <https://www.riverbankcomputing.com/software/pyqt/download5>`_ (QtCore, QtGui, QtWidgets, QtOpenGL)
* `PySDL2 <https://pysdl2.readthedocs.io>`_

Ubuntu
++++++


``sudo apt install libsdl2-dev qttools5-dev-tools pyqt5-dev-tools python3-pyqt5 python3-pyqt5.qtopengl``

PyPi
++++

To install just the Python dependencies:

``pip install -r requirements.txt --user``

.. note::

  This will not install the other system dependencies which are listed above.

  You can also drop the ``--user`` flag and run as root user if you want to
  install system-wide, but this is not recommended, as this will likely
  screw up your distro's package management.

Install
=======

First, run ``python setup.py build`` followed by  ``python setup.py install``
to install

.. code::

  python setup.py build
  python setup.py install --user

.. note::

  If you use the ``--user`` flag, make sure ``~/.local/bin`` is in your
  user's path environment variable.

License
=======

M64Py is free/libre software released under the terms of the GNU GPL license.
Please see the ``COPYING`` file for details.