mirror of
https://github.com/mupen64plus/mupen64plus-ui-python.git
synced 2025-04-02 10:51:53 -04:00
Fix install error and convert README to reStructuredText
Early this week, GitHub user xX-Yoshi-Xx informed me that there was an issue installing using my last commit. This was due to the script trying to import a module from `src/m64py` before it was added to the path. So I fixed that just by moving the import down a few lines. I also rewrote the README in reStructuredText, since this is the default Python markup format. I added some new content on using the `requirements.txt`` file to install the Python dependencies as well as a few other notes. I also did a few smaller things like making the Changelog file in all caps like the other files.
This commit is contained in:
parent
26d0cc010e
commit
9b45103995
7 changed files with 87 additions and 50 deletions
|
@ -1,4 +1,4 @@
|
||||||
include setup.py m64py AUTHORS README.md ChangeLog COPYING LICENSES
|
include setup.py m64py AUTHORS README.rst CHANGELOG COPYING LICENSES
|
||||||
recursive-include src *.py *.ui *.qrc *.svg *.png *.jpg *.ts
|
recursive-include src *.py *.ui *.qrc *.svg *.png *.jpg *.ts
|
||||||
recursive-include xdg *.desktop *.png *.xml
|
recursive-include xdg *.desktop *.png *.xml
|
||||||
global-exclude *_ui.py *_rc.py
|
global-exclude *_ui.py *_rc.py
|
||||||
|
|
45
README.md
45
README.md
|
@ -1,45 +0,0 @@
|
||||||
|
|
||||||
_____ __ __
|
|
||||||
____ ___ / ___// // / ____ __ __
|
|
||||||
/ __ `__ \/ __ \/ // /_/ __ \/ / / /
|
|
||||||
/ / / / / / /_/ /__ __/ /_/ / /_/ /
|
|
||||||
/_/ /_/ /_/\____/ /_/ / .___/\__, /
|
|
||||||
/_/ /____/
|
|
||||||
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 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-get install python-pyqt5 pyqt5-dev-tools python-pyqt5.qtopengl libsdl2-dev```
|
|
||||||
|
|
||||||
### Install
|
|
||||||
|
|
||||||
Run *python setup.py install* to install
|
|
||||||
|
|
||||||
Run *python setup.py build_qt* before you can start ./m64py from source dir
|
|
||||||
|
|
||||||
### License
|
|
||||||
|
|
||||||
M64Py is free/libre software released under the terms of the GNU GPL license,
|
|
||||||
see the `COPYING' file for details.
|
|
79
README.rst
Normal file
79
README.rst
Normal file
|
@ -0,0 +1,79 @@
|
||||||
|
::
|
||||||
|
|
||||||
|
_____ __ __
|
||||||
|
____ ___ / ___// // / ____ __ __
|
||||||
|
/ __ `__ \/ __ \/ // /_/ __ \/ / / /
|
||||||
|
/ / / / / / /_/ /__ __/ /_/ / /_/ /
|
||||||
|
/_/ /_/ /_/\____/ /_/ / .___/\__, /
|
||||||
|
/_/ /____/
|
||||||
|
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-get install python-pyqt5 pyqt5-dev-tools python-pyqt5.qtopengl
|
||||||
|
libsdl2-dev``
|
||||||
|
|
||||||
|
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.
|
2
requirements.txt
Normal file
2
requirements.txt
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
pyqt5
|
||||||
|
pysdl2
|
9
setup.py
9
setup.py
|
@ -15,10 +15,11 @@ import distutils.command.build as distutils_build
|
||||||
import distutils.command.clean as distutils_clean
|
import distutils.command.clean as distutils_clean
|
||||||
import setuptools
|
import setuptools
|
||||||
|
|
||||||
from m64py.core.defs import FRONTEND_VERSION
|
# Add the src folder to the path
|
||||||
|
|
||||||
sys.path.insert(0, os.path.realpath("src"))
|
sys.path.insert(0, os.path.realpath("src"))
|
||||||
|
|
||||||
|
from m64py.core.defs import FRONTEND_VERSION
|
||||||
|
|
||||||
BASE_DIR = os.path.dirname(os.path.realpath(__file__))
|
BASE_DIR = os.path.dirname(os.path.realpath(__file__))
|
||||||
|
|
||||||
|
|
||||||
|
@ -413,9 +414,9 @@ setuptools.setup(
|
||||||
author_email="gen2brain@gmail.com",
|
author_email="gen2brain@gmail.com",
|
||||||
license="GNU GPLv3",
|
license="GNU GPLv3",
|
||||||
url="http://m64py.sourceforge.net",
|
url="http://m64py.sourceforge.net",
|
||||||
packages=["m64py", "m64py.core", "m64py.frontend", "m64py.ui"],
|
|
||||||
package_dir={'': "src"},
|
package_dir={'': "src"},
|
||||||
scripts=["m64py"],
|
packages=["m64py", "m64py.core", "m64py.frontend", "m64py.ui"],
|
||||||
|
scripts=["bin/m64py"],
|
||||||
requires=["PyQt5", "PySDL2"],
|
requires=["PyQt5", "PySDL2"],
|
||||||
platforms=["Linux", "Windows", "Darwin"],
|
platforms=["Linux", "Windows", "Darwin"],
|
||||||
cmdclass={
|
cmdclass={
|
||||||
|
|
Loading…
Add table
Reference in a new issue