Metadata-Version: 2.1
Name: yongshi-pyqtgameboard
Version: 0.2.1
Summary: A gameboard widget for pyqt gui's package
Home-page: https://github.com/Michael-Yongshi/PyQtGameBoard
Author: Michael-Yongshi
Author-email: 4registration@outlook.com
License: UNKNOWN
Description: # PyQtGameBoard
        PyQt5 widget that draws a board on the screen to include in games or map drawing application.
        
        ## Install
        ```
        pip install yongshi-pyqtgameboard
        ```
        
        ## Import
        ```
        from pyqtgameboards.HexagonBoard import QHexagonboard
        ```
        
        ## How to
        to try out, copying the following to open a widget with a gameboard
        This is a gameboard of 20 rows and 10 columns (feels like 20, as it only counts tiles at the same height)
        This example creates designated tiles that receive a green fill with a thick green line
        ```
        if __name__ == '__main__':
        
            overlays = []
            overlay1brush = QtGui.QBrush(QtGui.QColor(0,255,0,150))
            overlay1pen = QtGui.QPen(QtGui.QColor(0,255,0))
            overlay1pen.setWidth(3)
            overlay1dict = {
                "Brush": overlay1brush,
                "Pen": overlay1pen,
                "Positions": [
                    [0, 0], 
                    [2, 1],
                    [1, 2],
                    [3, 3],
                    ],
                }
            overlays.append(overlay1dict)
        
            global app
            app = QtWidgets.QApplication(sys.argv)
            global main
            main = QtWidgets.QMainWindow()
        
            main.setCentralWidget(QHexagonboard(
                horizontal = True, 
                rows = 20, 
                columns = 10,
                overlays = [],
                ))
        
            main.showMaximized()
            sys.exit(app.exec_())
        ```
        
        ## Licence
        
        Licensed under GPL-3.0-or-later, see LICENSE file for details.
        
        Copyright Â© 2020 Michael-Yongshi.
        
        This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
        
        This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
        
        You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
